mirror of
https://github.com/nodejs/node.git
synced 2025-05-14 14:58:20 +00:00
76cb81b354
PR-URL: https://github.com/nodejs/node/pull/4958 Reviewed-By: Myles Borins <mborins@us.ibm.com> Reviewed-By: Kat Marchán <kzm@sykosomatic.org> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
# init-package-json
|
|
|
|
A node module to get your node module started.
|
|
|
|
[](http://travis-ci.org/npm/init-package-json)
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var init = require('init-package-json')
|
|
var path = require('path')
|
|
|
|
// a path to a promzard module. In the event that this file is
|
|
// not found, one will be provided for you.
|
|
var initFile = path.resolve(process.env.HOME, '.npm-init')
|
|
|
|
// the dir where we're doin stuff.
|
|
var 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.
|
|
var 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 free
|
|
// vars for:
|
|
// * `filename` path to the package.json file
|
|
// * `basename` the tip of the package dir
|
|
// * `dirname` the parent of the package dir
|
|
|
|
init(dir, initFile, configData, function (er, data) {
|
|
// the data's already been written to {dir}/package.json
|
|
// now you can do stuff with it
|
|
})
|
|
```
|
|
|
|
Or from the command line:
|
|
|
|
```
|
|
$ npm-init
|
|
```
|
|
|
|
See [PromZard](https://github.com/npm/promzard) for details about
|
|
what can go in the config file.
|