Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cowboy/grunt-node-example

This is example output generated by the "grunt init:node" task.
https://github.com/cowboy/grunt-node-example

Last synced: 2 months ago
JSON representation

This is example output generated by the "grunt init:node" task.

Awesome Lists containing this project

README

        

# Grunt "init:node" example

This is example output generated by the "grunt init:node" task.

_Note: this repository was generated dynamically using grunt v0.3.8. Instead of
reporting issues here, please report any issues with this repository as
[grunt issues][issues]. Instead of watching or forking this repository,
watch [grunt][grunt] and use the grunt [init task][init]._

## Project Creation Transcript
The following is a transcript of the session in which this project and
repository were created. This is not actually a part of the [grunt][grunt]
"init:node" template, this session transcript was added afterwards. The
text after the `$` are the commands that were executed, and everything else is
program output. If you want to see the repository exactly as it was created by
grunt, view [the previous commit][prev].

Want to learn more? Check [grunt][grunt] out.

[grunt]: https://github.com/cowboy/grunt
[issues]: https://github.com/cowboy/grunt/issues
[init]: https://github.com/cowboy/grunt/blob/master/docs/task_init.md
[expect]: https://github.com/cowboy/grunt/blob/master/dev/init.exp
[prev]: https://github.com/cowboy/grunt-node-example/tree/HEAD~1

Note that this entire build process is automated by a rather complex [expect
script][expect], which is used to automate grunt in order to facilitate the
creation of this and other [init task][init] example repositories.

```
$ mkdir grunt-node-example && cd grunt-node-example

$ git init
git remote add origin [email protected]:cowboy/grunt-node-example.git
Initialized empty Git repository in /private/tmp/grunt-node-example/.git/

$ git remote add origin [email protected]:cowboy/grunt-node-example.git

$ grunt init:node
Running "init:node" (init) task
This task will create one or more files in the current directory, based on the
environment and the answers to a few questions. Note that answering "?" to any
question will show question-specific help and answering "none" to most questions
will leave its value blank.

"node" template notes:
Project name shouldn't contain "node" or "js" and should be a unique ID not
already in use at search.npmjs.org.

Please answer the following:
[?] Project name (grunt-node-example)
[?] Description (The best project ever.) This is example output generated by the "grunt init:node" task.
[?] Version (0.1.0)
[?] Project git repository (git://github.com/cowboy/grunt-node-example.git)
[?] Project homepage (https://github.com/cowboy/grunt-node-example)
[?] Project issues tracker (https://github.com/cowboy/grunt-node-example/issues)
[?] Licenses (MIT)
[?] Author name ("Cowboy" Ben Alman)
[?] Author email (none)
[?] Author url (http://benalman.com/)
[?] What versions of node does it run on? (~0.6.14)
[?] Main module/entry point (lib/grunt-node-example)
[?] Npm test command (grunt test)
[?] Do you need to make any changes to the above before continuing? (y/N)

Writing .gitignore...OK
Writing grunt.js...OK
Writing lib/grunt-node-example.js...OK
Writing README.md...OK
Writing test/grunt-node-example_test.js...OK
Writing LICENSE-MIT...OK

Initialized from template "node".

Done, without errors.

$ tree
.
├── LICENSE-MIT
├── README.md
├── grunt.js
├── lib
│   └── grunt-node-example.js
├── package.json
└── test
└── grunt-node-example_test.js

2 directories, 6 files

$ grunt
Running "lint:files" (lint) task
Lint free.

Running "test:files" (test) task
Testing grunt-node-example_test.js.OK
>> 1 assertions passed (1ms)

Done, without errors.

$ tree
.
├── LICENSE-MIT
├── README.md
├── grunt.js
├── lib
│   └── grunt-node-example.js
├── package.json
└── test
└── grunt-node-example_test.js

2 directories, 6 files

$ git add .

$ git commit -m 'Committing example "grunt init:node" task output.'
[master (root-commit) 723087a] Committing example "grunt init:node" task output.
7 files changed, 169 insertions(+), 0 deletions(-)
create mode 100644 .gitignore
create mode 100644 LICENSE-MIT
create mode 100644 README.md
create mode 100644 grunt.js
create mode 100644 lib/grunt-node-example.js
create mode 100644 package.json
create mode 100644 test/grunt-node-example_test.js

```

## License
Copyright (c) 2012 "Cowboy" Ben Alman
Licensed under the MIT license.