Generate a package.json from a pre-defined or user-defined template. This generator can be used from the command line when globally installed, or as a plugin or sub-generator in your own generator.
generate-package Table of Contents - [Quickstart](#quickstart) - [Getting started](#getting-started) * [Install](#install) * [CLI](#cli) * [Help](#help) - [Next steps](#next-steps) * [Running unit tests](#running-unit-tests) * [Publishing your generator](#publishing-your-generator) - [About](#about) * [What is "Generate"?](#what-is-generate) * [Related projects](#related-projects) * [Community](#community) * [Contributors](#contributors) * [Contributing](#contributing) * [Running tests](#running-tests) * [Author](#author) * [License](#license)(TOC generated by verb using markdown-toc)
QuickstartInstall generate and generate-package
:
$ npm install --global generate generate-package
Generate a package.json in the current working directory:
Getting started InstallInstalling the CLI
To run the readme
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-package
Install this module with the following command:
CLI$ npm install --global generate-package
Run this generator's default
task with the following command:
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.
HelpTo see a general help menu and available commands for Generate's CLI, run:
Next steps Running unit testsIt'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:
Publishing your generator$ npm install && test
If you're tests are passing and you're ready to publish your generator to npm, you can do that now with the following command:
Are you sure you're ready?!
Let's go!
About What is "Generate"?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:
package.json
, .git⦠[more](https://github.com/generate/generate-readme) | [homepage](https://github.com/generate/generate-readme "Generate a README.md using answers to prompts and data from the environment, like
package.json,
.git` config, etc. This generator can be run by command line if Generate is installed globally, or you can use this as a plugin or sub-generator in your own")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-package
generatejs
tag in questions)generategenerator
to package.json.Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running testsInstall dev dependencies:
Author$ npm install && npm test
Jon Schlinkert
LicenseCopyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.4.2, on January 27, 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