https://github.com/prolificinteractive/prolific-cleaner
Sets up javascript projects to be linted and checked for code styles based on commit and push git hooks.
https://github.com/prolificinteractive/prolific-cleaner
Last synced: 10 months ago
JSON representation
Sets up javascript projects to be linted and checked for code styles based on commit and push git hooks.
- Host: GitHub
- URL: https://github.com/prolificinteractive/prolific-cleaner
- Owner: prolificinteractive
- Created: 2015-03-05T03:08:24.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-03-15T16:22:58.000Z (over 11 years ago)
- Last Synced: 2025-01-20T20:53:29.616Z (over 1 year ago)
- Language: JavaScript
- Size: 148 KB
- Stars: 1
- Watchers: 43
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Prolific Cleaner
## Installation
Add the following to `pakage.json` file.
```
"devDependencies": {
"prolific-cleaner": "git+https://github.com/prolificinteractive/prolific-cleaner.git#master"
}
```
Run `npm install`
## Usage
Once it is installed you should notice that some lines were added to your package.json file.
```
"scripts": {
"test": "node -e \"require('grunt').tasks(['test']);\"",
"test-all": "node -e \"require('grunt').tasks(['test-all']);\"",
"prepush": "npm test"
}
```
Now when you push your code npm test will run a suite of linters and code styling checks against
your project. You can also add a `precommit` script that will add run your script prior to commits
as a pre-commit git hook.
For more info see [lintlovin](https://github.com/bloglovin/lintlovin).
## About And Contributing
This project is a light wrapper for [lintlovin](https://github.com/bloglovin/lintlovin).
All it does is install custom configuration files, preventing copy and pasting across projects.
The configuration files are found in the defaults folder and are used for the following.
* .editorconfig -> [lintspaces](https://github.com/schorfES/node-lintspaces)
* .jscsrc -> [jscs](http://jscs.info/rules.html)
* .jshintrc -> [jshint](http://jshint.com/docs/options/)
* Gruntfile.js -> Default Gruntfile to run everything this can be added to.
Feel free to make pull requests to update these.
## License
[LICENSE (MIT)](https://github.com/schorfES/node-lintspaces/blob/master/LICENSE)