Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pkgjs/create-package-json
Create full featured package.json files
https://github.com/pkgjs/create-package-json
Last synced: about 2 months ago
JSON representation
Create full featured package.json files
- Host: GitHub
- URL: https://github.com/pkgjs/create-package-json
- Owner: pkgjs
- License: mit
- Created: 2018-05-16T18:19:28.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-01-15T13:49:29.000Z (about 1 year ago)
- Last Synced: 2024-11-14T10:11:08.236Z (3 months ago)
- Language: JavaScript
- Size: 130 KB
- Stars: 30
- Watchers: 6
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Create a `package.json` like a champion
[](https://npmjs.org/package/create-package-json)
[](https://npmjs.org/package/create-package-json)
[](https://github.com/standard/standard)
[](https://github.com/sponsors/wesleytodd)
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](https://github.com/wesleytodd/create-package-json/blob/master/index.js#L14-L27) for missing fields.
## Usage
```
$ npm init package-json
$ npx create-package-json
```
### CLI Usage
```
$ create-package-json --help
Generate a package.json
Commands:
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]
--private [boolean]
--dependencies [string]
--dev-dependencies [string]
--peer-dependencies [string]
--spacer [string] [default: 2 spaces]
--save-exact [boolean]
```
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
```javascript
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 ',
version: '1.0.0'
})
console.log(pkg) // The json after writing and installing
})()
```
## Implementation TODO
> See [`package.json` docs](https://docs.npmjs.com/files/package.json)
- [ ] `exports`
- [ ] `bin`
- [ ] `funding`
- [ ] `files`
- [ ] `browser`
- [ ] `directories`
- [ ] `config`
- [ ] `dependencies`
- [ ] `devDependencies`
- [ ] `bundledDependencies`
- [ ] `optionalDependencies`
- [ ] `engines`
- [ ] `os`
- [ ] `cpu`
- [ ] `publishConfig`
- [ ] `homepage`
- [ ] `bugs`
- [ ] `contributors`