Skip to content

Latest commit

 

History

History
61 lines (50 loc) · 2.37 KB

README.md

File metadata and controls

61 lines (50 loc) · 2.37 KB

json-persist

A JSON file reader/writer for Node v4+

npm Version Travis CI AppVeyor Coverage Status Dependency Status Downloads License (MIT) XO Code Style

Contents

Usage

In Progress... Basic usage:

const jsonPersist = require('json-persist')(module);

Testing

json-persist uses xo (with slightly customized configuration) for linting, ava for unit testing, and nyc for coverage.

Test Scripts

  • npm run lint: Uses xo to lint the main source file, index.js.
  • npm run test-lint: Uses xo to lint the test source files, located in test/.
  • npm run unit: Executes test-lint and runs the ava unit tests using nyc for coverage.
  • npm report: Generates an HTML coverage report from nyc.
  • npm run test: Executes lint, unit and report in that order.

API

In Progress...