# neuron-json

> The utility to read and clean neuron.json.

Latest version **2.0.1** (published 2016-05-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install neuron-json
pnpm add neuron-json
yarn add neuron-json
bun add neuron-json
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2016-05-27 |
| First published | 2015-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 7 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | neuron-js |
| Maintainers | kael |
| Keywords | neuron-json, read, package.json, neuron.json, write |

## Links

- npm: https://www.npmjs.com/package/neuron-json
- Repository: https://github.com/neuron-js/neuron-json
- Homepage: https://github.com/neuron-js/neuron-json#readme
- Issues: https://github.com/neuron-js/neuron-json/issues
- npm.io page: https://npm.io/package/neuron-json

## Dependencies (7)

- [typo](https://npm.io/package/typo.md) ^0.2.11
- [async](https://npm.io/package/async.md) ^1.4.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.24.0
- [fs-expand](https://npm.io/package/fs-expand.md) ^1.0.0
- [make-array](https://npm.io/package/make-array.md) ^1.0.1
- [array-unique](https://npm.io/package/array-unique.md) ^0.2.1
- [comment-json](https://npm.io/package/comment-json.md) ^1.1.3

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2016-05-27
- 2.0.0 — 2016-05-10
- 1.5.0 — 2016-02-22
- 1.4.0 — 2016-02-22
- 1.3.0 — 2015-12-29
- 1.2.0 — 2015-12-28
- 1.1.1 — 2015-12-23
- 1.1.0 — 2015-12-23
- 1.0.3 — 2015-11-03
- 1.0.2 — 2015-10-16
- 1.0.1 — 2015-10-15
- 1.0.0 — 2015-10-15

## README

[![Build Status](https://travis-ci.org/neuron-js/neuron-json.svg?branch=master)](https://travis-ci.org/neuron-js/neuron-json)
<!-- [![NPM version](https://badge.fury.io/js/neuron-json.svg)](http://badge.fury.io/js/neuron-json)
[![npm module downloads per month](http://img.shields.io/npm/dm/neuron-json.svg)](https://www.npmjs.org/package/neuron-json)
[![Dependency Status](https://david-dm.org/neuron-js/neuron-json.svg)](https://david-dm.org/neuron-js/neuron-json) -->

# neuron-json

The utility to read neuron.json

## Install

```sh
$ npm install neuron-json --save
```

## Usage

```js
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

---
_Source: https://npm.io/package/neuron-json · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._