npm.io
2.0.1 • Published 10 years ago

neuron-json

Licence
MIT
Version
2.0.1
Deps
7
Vulns
0
Weekly
0

Build Status

neuron-json

The utility to read neuron.json

Install

$ npm install neuron-json --save

Usage

var nj = require('neuron-json');
var cwd = '/path/to/package';
nj.read(cwd, function (err, json){
  // ...
});
  • cwd path the current working directory
  • err Error
  • json Object see below
json

Contains the fields below at least:

  • name String the package name of the package
  • main path= the filename(relative to cwd) of the main entry, if there is no main entry, there will be no main key in json
  • entries Array.<path> if there's no entries, it will be an empty array.
process.env.NEURON_NO_TEST_ENTRY

If process.env.NEURON_NO_TEST_ENTRY is specified, then neuron-json will not include test entries automatically.

License

MIT

Keywords