1.0.2 • Published 9 years ago
base-package-json v1.0.2
base-package-json
Basic package.json readable stream. Sets the minimum amount of properties to
satisfy npm
. Easy to extend, useful for code generators.
Installation
$ npm install base-package-json
Usage
const package = require('base-package-json')
const through = require('through2')
package({ name: 'my-package' })
.pipe(through({ objectMode: true }, (obj, enc, cb) => {
obj.dependencies.rimraf = '2.4.3'
obj.description = 'My great description'
cb(null, obj)
}))
API
package(opts)
Create a blank package.json
. By default it sets name
, version
, scripts
,
dependencies
and devDependencies
.
The following options are accepted:
- name: the module name. Defaults to
<name>
. - version: the module version. Defaults to
1.0.0
. - private: if the module is publishable. It should be set to
false
for applications. Defaults toundefined
(e.g. will not set).