https://github.com/junosuarez/quality
zero configuration code and module linting
https://github.com/junosuarez/quality
Last synced: over 1 year ago
JSON representation
zero configuration code and module linting
- Host: GitHub
- URL: https://github.com/junosuarez/quality
- Owner: junosuarez
- License: isc
- Created: 2015-06-10T20:05:41.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-06-10T22:05:24.000Z (about 11 years ago)
- Last Synced: 2025-04-10T15:36:34.614Z (over 1 year ago)
- Language: JavaScript
- Size: 121 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# quality
zero configuration code and module linting
[](https://github.com/feross/standard)
[](https://github.com/jden/quality)
[](https://david-dm.org/jden/quality)
[](https://circleci.com/gh/jden/quality)
## installation & usage
```sh
$ npm install -save-dev quality
```
add to your package.json:
```json
"scripts": {
"test": "quality && "
}
```
## badge
Add to your readme so people can see your commitment to quality at a glance
[](https://github.com/jden/quality)
```md
[](https://github.com/jden/quality)
```
### standalone cli
```
$ quality
```
will run all quality checks for the module in the current directory.
`quality --verbose` will tell you more about what's going on as it's running:
```
$ quality --verbose
Checking dependencies
Checking for unused or missing dependencies in package.json...
Validating duplicate packages...
OK
Validating all require statements...
OK
Checking style
OK
```
`quality` exists with a `1` error code if problems are found and a `0` if everything is ok, so you
can easily combine it with other tools in shell scripts.
## checks
`quality` is the easiest way to add best-of linting and quality checking to your package
to make your (development) life easier. it is built on the following tools:
- [standard](https://github.com/feross/standard) - checks for javascript code style, syntax errors, variable scope errors
- [sanitycheck](https://github.com/jden/node-sanitycheck) - checks for missing & unused module dependencies in your code & package.json
## FAQ
### but I want to configure all of the things
Feel free to fork this and configure it to your heart's content to find defaults that
work for you and your team. When you do this, I recommend publishing it as an npm scoped
package, eg `@yourname/quality` so you can still benefit from ease of setup and consistency
across packages
### there is an aspect of quality that is currently completely missing from this module
feel free to open an issue! I'm interested in adding sensible defaults to reduce the
amount of things you have to think about when developing a new module while maintaining a
high level of overall quality. For example, there is an effort to develop
[standard-readme](https://github.com/zcei/standard-readme), which I'm interested in incorporating
in `quality` once it has been published and is somewhat stable.
## running the tests
From package root:
$ npm install
$ npm test
## contributors
- jden
## license
ISC. (c) MMXV jden . See LICENSE.md