node/deps/npm/node_modules/init-package-json
Forrest L Norvell fe14802fb7 deps: upgrade npm to 2.7.0
PR-URL: https://github.com/iojs/io.js/pull/1080
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2015-03-06 11:20:05 -05:00
..
example npm: Upgrade to v1.3.15 2013-11-20 11:08:52 -08:00
node_modules/promzard deps: upgrade npm to 2.4.1 2015-01-31 18:57:30 +01:00
test deps: upgrade npm to 2.7.0 2015-03-06 11:20:05 -05:00
.npmignore npm: Upgrade to v2.1.6 2014-11-05 10:35:43 -08:00
LICENSE npm: upgrade to 1.4.6 2014-03-25 17:42:22 -07:00
README.md npm: Upgrade to 1.1.27 2012-06-17 12:04:35 -07:00
default-input.js deps: upgrade npm to 2.7.0 2015-03-06 11:20:05 -05:00
init-package-json.js npm: Upgrade to v2.1.6 2014-11-05 10:35:43 -08:00
package.json deps: upgrade npm to 2.7.0 2015-03-06 11:20:05 -05:00

README.md

init-package-json

A node module to get your node module started.

Usage

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 for details about what can go in the config file.