node/deps/npm/node_modules/init-package-json
Kat Marchán bf63266460 deps: upgrade to npm 2.13.3
PR-URL: https://github.com/nodejs/io.js/pull/2284
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-08-01 09:45:44 -07:00
..
example deps: upgrade npm to 2.9.0 2015-05-01 16:05:03 -07:00
node_modules/promzard deps: upgrade to npm 2.12.1 2015-07-06 10:28:20 -07:00
test deps: upgrade to npm 2.12.1 2015-07-06 10:28:20 -07:00
.npmignore npm: Upgrade to v2.1.6 2014-11-05 10:35:43 -08:00
.travis.yml deps: upgrade to npm 2.12.1 2015-07-06 10:28:20 -07:00
LICENSE npm: upgrade to 1.4.6 2014-03-25 17:42:22 -07:00
README.md deps: upgrade npm to 2.9.0 2015-05-01 16:05:03 -07:00
default-input.js deps: upgrade to npm 2.12.1 2015-07-06 10:28:20 -07:00
init-package-json.js deps: upgrade npm to 2.7.6 2015-04-10 14:22:47 -07:00
package.json deps: upgrade to npm 2.13.3 2015-08-01 09:45:44 -07:00

README.md

init-package-json

A node module to get your node module started.

Build Status

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.