Scaffold out complete code projects from the command line, or use this generator as a plugin in other generators to provide baseline functionality.
Table of Contents(TOC generated by verb using markdown-toc)
Installing the CLI
To run the default
generator from the command line, you'll need to install Generate globally first. You can do that now with the following command:
$ npm install --global generate
This adds the gen
command to your system path, allowing it to be run from any directory.
Install generate-project
Install this module with the following command:
$ npm install --global generate-project
Run this generator's default
task with the following command:
$ gen project # or $ gen project:default
What will happen?
Running $ gen project
will run this generator's default task, which will:
Conflict detection
In the case that a file already exists on the file system, you will be prompted for feedback before overwrite any files.
You can set the destination to a new directory if you want to avoid the prompts, or avoid accidentally overwriting files with unintentional answers.
What you should see in the terminal
If completed successfully, you should see both starting
and finished
events in the terminal, like the following:
[00:44:21] starting ... ... [00:44:22] finished ✔
If you do not see one or both of those events, please let us know about it.
To see a general help menu and available commands for Generate's CLI, run:
Are you using Generate in your project? Have you published a generator and want to share your project with the world?
Here are some suggestions!
@generatejs
or use the #generatejs
hashtaggenerate-project
generatejs
tag in questions)generategenerator
to package.json.Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on July 29, 2017.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4