ESLint Config

A personal ESLint config, but with ESLint itself and all the necessary shareable config, plugins, and parser as dependencies.

Provides an eslint command which runs ESLint with this module's .eslintrc in the context of this module's dependencies, so I don't have to manage these dependencies in every project.

Table of Contents

• Installation
• Thanks
• Troubleshooting
• Authors
• Contribute
• License
• Changelog

Installation

Install this package:

$ npm install --save-dev @sebastienbarre/eslint-config

then update your package.json:

{
  "scripts": {
    "lint": "eslint src tests"
  }
}

Thanks

• Jonny Buchanan for his Config → Tools: ESLint post detailing this approach and implementing it in insin/eslint-config-jonnybuchanan.

Troubleshooting

For roadhump/SublimeLinter-eslint to lint with these settings, make sure to install this package globally:

$ npm install -g @sebastienbarre/eslint-config

Authors

Sebastien Barre

• Email: [email protected]
• Web: http://barre.io
• Twitter: sebastienbarre

Contribute

• Check for open issues, especially the ones already available, or open a fresh issue to start a discussion around a feature idea or a bug.
• If you feel uncomfortable or uncertain about an issue or your changes, feel free to email me and I will give you a hand.
• Fork the repository on GitHub to start making your changes to the master branch (or branch off of it).
• Write a test which shows that a bug exists, was fixed, or that a feature works as expected.
• Use npm run commit instead of git commit if you are unfamiliar with the [conventional-changelog] guidelines; this will ensure a Commitizen-friendly commit message will be generated, a convention that will in turn be leveraged by semantic-release.
• Send a pull request and notify me :) Thanks.

License

This software is released under the BSD License.

Changelog

All notable changes to this project are documented automatically on the Github releases page. This project believes in Semantic Versioning and Keep a CHANGELOG. It uses commitizen and semantic-release to help.