https://github.com/npm/init-package-json

A node module to get your node module started
https://github.com/npm/init-package-json

npm-cli

Last synced: about 1 month ago
JSON representation

A node module to get your node module started

• Host: GitHub
• URL: https://github.com/npm/init-package-json
• Owner: npm
• License: other
• Created: 2012-06-17T04:44:06.000Z (over 12 years ago)
• Default Branch: main
• Last Pushed: 2024-10-04T02:31:23.000Z (about 1 month ago)
• Last Synced: 2024-10-04T06:32:03.000Z (about 1 month ago)
• Topics: npm-cli
• Language: JavaScript
• Homepage:
• Size: 700 KB
• Stars: 312
• Watchers: 40
• Forks: 149
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# init-package-json

A node module to get your node module started.

## Usage

```javascript

const init = require('init-package-json')

const path = require('path')

// a path to a promzard module.  In the event that this file is

// not found, one will be provided for you.

const initFile = path.resolve(process.env.HOME, '.npm-init')

// the dir where we're doin stuff.

const dir = process.cwd()

// extra stuff that gets put into the PromZard module's context.

// In npm, this is the resolved config object.  Exposed as 'config'

// Optional.

const configData = { some: 'extra stuff' }

// Any existing stuff from the package.json file is also exposed in the

// PromZard module as the `package` object.  There will also be three

// vars for:

// * `filename` path to the package.json file

// * `basename` the tip of the package dir

// * `dirname` the parent of the package dir

const data = await init(dir, initFile, configData)

// the data's already been written to {dir}/package.json

// now you can do stuff with it

```

See [PromZard](https://github.com/npm/promzard) for details about

what can go in the config file.