UNPKG

1.8 kBMarkdownView Raw
1<img src="https://raw.githubusercontent.com/js-data/js-data/master/js-data.png" alt="js-data logo" title="js-data" align="right" width="96" height="96" />
2
3# js-data-repo-tools
4
5[![Slack Status][sl_b]][sl_l]
6[![npm version][npm_b]][npm_l]
7[![npm downloads][dn_b]][dn_l]
8
9Common utility scripts used by js-data repositories.
10
11Refer to the `package.json` files of the various js-data adapter repositories to
12see this tool in action.
13
14## Table of contents
15
16* [Quick start](#quick-start)
17* [Community](#community)
18* [Support](#support)
19* [Contributing](#contributing)
20* [License](#license)
21
22## Quick Start
23Install into a repository: `npm i --save-dev js-data-repo-tools`
24
25And update your scripts in `package.json`:
26
27```js
28"scripts": {
29 "lint": "repo-tools lint src/index.js test/**/*.js"
30}
31```
32
33Or install globally: `npm i -g js-data-repo-tools`
34
35And use on the commandline:
36
37```
38repo-tools lint
39```
40
41## Community
42
43[Explore the Community](http://js-data.io/docs/community).
44
45## Support
46
47[Find out how to Get Support](http://js-data.io/docs/support).
48
49## Contributing
50
51[Read the Contributing Guide](http://js-data.io/docs/contributing).
52
53## License
54
55The MIT License (MIT)
56
57Copyright (c) 2016 js-data-repo-tools project authors
58
59* [LICENSE](https://github.com/js-data/js-data-repo-tools/blob/master/LICENSE)
60* [AUTHORS](https://github.com/js-data/js-data-repo-tools/blob/master/AUTHORS)
61* [CONTRIBUTORS](https://github.com/js-data/js-data-repo-tools/blob/master/CONTRIBUTORS)
62
63[sl_b]: http://slack.js-data.io/badge.svg
64[sl_l]: http://slack.js-data.io
65[npm_b]: https://img.shields.io/npm/v/js-data-repo-tools.svg?style=flat
66[npm_l]: https://www.npmjs.org/package/js-data-repo-tools
67[dn_b]: https://img.shields.io/npm/dm/js-data-repo-tools.svg?style=flat
68[dn_l]: https://www.npmjs.org/package/js-data-repo-tools