This is a fully featured package.json scaffolding tool. It goes above and beyond the basic npm init
by supporting (almost) all of the keys you can set in a package.json. It can be used as a simple cli
tool, or inside your other package scaffolding tools.
NOTE: This is a work in progress, more to come on docs and there are some missing options at the moment.
See here for missing fields.
Usage
$ npm init package-json$ npx create-package-json
CLI Usage
$ create-package-json --helpGenerate a package.jsonCommands: create-package-json Generate a package.json [default]Options: --help Show help [boolean] --version Show version number [boolean] -d, --cwd Directory to run in [default: process.cwd()] --silent [boolean] --verbose [boolean] --ignore-existing Ignore existing files (& overwrite them) --name [string] --scope Set a scope to be used when suggesting a package name [string] -V, --package-version [string] --description [string] --author [string] --repository [string] --keywords [string] --license [string] --type [string] --main [string]
Dependencies should be a comma separated list like --dependencies="express,react", and it can also
include versions, --dependencies="express@5".
Scripts should be defined as a json string, --scripts='{"test":"exit 0"}'.
Programmatic Usage
const createPackageJson = require('create-package-json');(async () => { const pkg = await createPackageJson({ name: '@myscope/my-package', description: 'A useless new package', dependencies: ['express'], devDependencies: ['mocha'], author: 'Me <me@me.com>', version: '1.0.0' }) console.log(pkg) // The json after writing and installing})()