Generate an Update updater project.
(TOC generated by verb using markdown-toc)
Generate is a command line tool and developer framework for scaffolding out new GitHub projects using generators and tasks.
Answers to prompts and the user's environment can be used to determine the templates, directories, files and contents to build. Support for gulp, base and assemble plugins, and much more.
For more information:
Installing the CLI
To run the updater 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-updater
Install this module with the following command:
$ npm install --global generate-updater
Run this generator's default task with the following command:
$ gen updater
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:
$ gen help
All available tasks.
Scaffold out an update updater project. Alias for the updater task, to allow running the updater with the following command:
Example
$ gen updater
Scaffold out a minimal Update updater project.
Example
$ gen updater:min
# or
$ gen updater:minimal
Scaffold out a project for a Update micro-updater.
Example
$ gen updater:micro
Write a updater.js file to the current working directory.
Example
$ gen updater:file
Generate the LICENSE, package.json and README.md files for an updater project.
Example
$ gen updater:rootfiles
Adds files tree docs to the docs directory.
Example
$ gen updater:docs
Adds files tree docs to the docs directory.
Example
$ gen updater:docs
Add a verbfile.js to the current working directory.
Example
$ gen updater:verbfile
Add a .verb.md readme template to the current working directory.
Example
$ gen updater:verbmd
Create a test.js file in the test directory, with unit tests for all of the tasks in the generated updater.
Example
$ gen updater:test
Generate files in the updater's templates directory.
Example
$ gen updater:templates
Visit Generate's documentation for tasks.
The following files trees are automatically generated by a task in verbfile.js.
(See Generate's customization docs to learn how to override individual templates.)
Files generated by each task (e.g. dest files). See the Generate customization docs to learn how to override individual templates.
Note that diffs are base on comparisons against the files generated by the default task. Additionally, some tasks generate the same files, but with different contents (for example, the contents of index.js differs based on the task).
Files generated by the default task:
.
├─┬ test
│ ├─┬ fixtures
│ │ └── temp.txt
│ ├── plugin.js
│ └── test.js
├── .editorconfig
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .travis.yml
├── updatefile.js
├── index.js
├── LICENSE
├── package.json
├── README.md
└── .verb.md
Files generated by the minimal task:
.
-├─┬ test
-│ ├─┬ fixtures
-│ │ └── temp.txt
-│ ├── plugin.js
-│ └── test.js
-├── .editorconfig
-├── .eslintrc.json
-├── .gitattributes
├── .gitignore
-├── .travis.yml
├── updatefile.js
├── index.js
├── LICENSE
├── package.json
└── README.md
-└── .verb.md
Files generated by the updater task:
.
├─┬ test
│ ├─┬ fixtures
│ │ └── temp.txt
│ ├── plugin.js
│ └── test.js
├── .editorconfig
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── .travis.yml
├── updatefile.js
├── index.js
├── LICENSE
├── package.json
├── README.md
└── .verb.md
Files generated by the rootfiles task:
.
-├─┬ test
-│ ├─┬ fixtures
-│ │ └── temp.txt
-│ ├── plugin.js
-│ └── test.js
-├── .editorconfig
-├── .eslintrc.json
-├── .gitattributes
-├── .gitignore
-├── .travis.yml
-├── updatefile.js
-├── index.js
├── LICENSE
├── package.json
└── README.md
-└── .verb.md
Files generated by the dotfiles task:
.
-├─┬ test
-│ ├─┬ fixtures
-│ │ └── temp.txt
-│ ├── plugin.js
-│ └── test.js
├── .editorconfig
├── .eslintrc.json
├── .gitattributes
├── .gitignore
└── .travis.yml
-├── updatefile.js
-├── index.js
-├── LICENSE
-├── package.json
-├── README.md
-└── .verb.md
The following trees represent the source files or templates that are used by each task. You'll see that most of the tasks use at least one "micro-generator" to generate a specific file.
Source files and/or libraries used by the default task:
.
├─┬ templates
│ ├─┬ tests
│ │ ├─┬ fixtures
│ │ │ └── temp.md
│ │ ├── plugin.js
│ │ └── test.js
│ ├── updatefile.js
│ ├── index.js
│ └── _verb.md
└─┬ node_modules
├─┬ generate-editorconfig
│ └─┬ templates
│ └── _editorconfig
├─┬ generate-eslint
│ └─┬ templates
│ └── _eslintrc.json
├─┬ generate-gitattributes
│ └─┬ templates
│ └── _gitattributes
├─┬ generate-project
│ └─┬ node_modules
│ └─┬ generate-gitignore
│ └─┬ templates
│ └── Minimal.gitignore
├─┬ generate-travis
│ └─┬ templates
│ └── _travis.yml
├─┬ generate-license
│ └─┬ templates
│ └── mit.tmpl
├─┬ generate-package
│ └─┬ templates
│ └── $package.json
└─┬ generate-readme
└─┬ templates
└── node.md
Source files and/or libraries used by the minimal task:
.
├─┬ node_modules
│ ├─┬ generate-project
│ │ └─┬ node_modules
│ │ └─┬ generate-gitignore
│ │ └─┬ templates
│ │ └── Node.gitignore
│ ├─┬ generate-license
│ │ └─┬ templates
│ │ └── mit.tmpl
│ ├─┬ generate-package
│ │ └─┬ templates
│ │ └── $package.json
│ └─┬ generate-readme
│ └─┬ templates
│ └── node.md
└─┬ templates
├── updatefile.js
└── index.js
Source files and/or libraries used by the updater task:
.
├─┬ templates
│ ├─┬ tests
│ │ ├─┬ fixtures
│ │ │ └── temp.md
│ │ ├── plugin.js
│ │ └── test.js
│ ├── updatefile.js
│ ├── index.js
│ └── _verb.md
└─┬ node_modules
├─┬ generate-editorconfig
│ └─┬ templates
│ └── _editorconfig
├─┬ generate-eslint
│ └─┬ templates
│ └── _eslintrc.json
├─┬ generate-gitattributes
│ └─┬ templates
│ └── _gitattributes
├─┬ generate-project
│ └─┬ node_modules
│ └─┬ generate-gitignore
│ └─┬ templates
│ └── Minimal.gitignore
├─┬ generate-travis
│ └─┬ templates
│ └── _travis.yml
├─┬ generate-license
│ └─┬ templates
│ └── mit.tmpl
├─┬ generate-package
│ └─┬ templates
│ └── $package.json
└─┬ generate-readme
└─┬ templates
└── node.md
Source files and/or libraries used by the rootfiles task:
.
└─┬ node_modules
├─┬ generate-license
│ └─┬ templates
│ └── mit.tmpl
├─┬ generate-package
│ └─┬ templates
│ └── $package.json
└─┬ generate-readme
└─┬ templates
└── node.md
Source files and/or libraries used by the dotfiles task:
.
└─┬ node_modules
├─┬ generate-editorconfig
│ └─┬ templates
│ └── _editorconfig
├─┬ generate-eslint
│ └─┬ templates
│ └── _eslintrc.json
├─┬ generate-gitattributes
│ └─┬ templates
│ └── _gitattributes
├─┬ generate-project
│ └─┬ node_modules
│ └─┬ generate-gitignore
│ └─┬ templates
│ └── Minimal.gitignore
└─┬ generate-travis
└─┬ templates
└── _travis.yml
It's never too early to begin running unit tests. When you're ready to get started, the following command will ensure the project's dependencies are installed then run all of the unit tests:
$ npm install && test
If you're tests are passing and you're ready to publish your project to npm, you can do that now with the following command:
Are you sure you're ready?!
$ npm publish
generate: Command line tool and developer framework for scaffolding out new GitHub projects. Generate offers the… more | homepage
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-updatergeneratejs tag in questions)generategenerator to package.json.Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb-generate-readme, v0.1.30, on September 01, 2016.