eslint-config-twolfson
ESLint configuration for @twolfson
This was built to create a common versioned location for @twolfson's style choices. For @twolfson's JSCS and JSHint preferences, see twolfson-style
Getting Started
Install our package along side eslint
via: npm install eslint-config-twolfson
Once it's installed, extend our package via .eslintrc.js
. We recommend the following setup:
moduleexports = // Inherit from our package extends: 'eslint-config-twolfson' // Configure our environment // http://eslint.org/docs/user-guide/configuring#specifying-environments env: node: true mocha: true ;
Once it's configured, we can run our linter:
eslint directory/to/lint
Documentation
Preferred setup
We have the following as our preferred setup for our packages:
.eslintrc.js:
moduleexports = // Inherit from our package extends: 'eslint-config-twolfson' // Configure our environment // http://eslint.org/docs/user-guide/configuring#specifying-environments env: node: true mocha: true ;
package.json:
// ..."scripts": "precheck": "eslint directory/to/lint" "lint": "eslint directory/to/lint --max-warnings 0" "test": "npm run precheck && mocha && npm run lint"// ...
Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint via npm run lint
and test via npm test
.
Donating
Support this project and others by twolfson via donations.
http://twolfson.com/support-me
Unlicense
As of May 27 2017, Todd Wolfson has released this repository and its contents to the public domain.
It has been released under the UNLICENSE.