amercier / eslint-config-template

Skeleton for shareable ESLint configs

eslint-config-template

Skeleton for ESLint shareable configs.

Example of valid code:

// # TODO
//
// - Clone this repository and push it to your own. DO NOT FORK IT, unless you are certain you will
//   only do it once (GitHub doesn't allow multiple forks of the same project on the same account).
//
//       git clone https://github.com/amercier/eslint-config-template.git <YOUR_REPOSITORY_NAME>
//       git remote rename origin upstream
//       git remote add origin <YOUR_REPOSITORY_GIT_URL>
//       git push -u origin master
//
// - Enable repository in Travis CI, trigger manual build
// - Install and enable Greenkeeper: https://github.com/settings/installations/51959
// - Replace `amercier/eslint-config-template` by your Github repo
// - Replace `eslint-config-template` by your NPM package name
// - Replace `template` by your NPM package name without "eslint-config-"
// - Replace `Alex Mercier` by your name.
// - Replace `https://amercier.com/` by your website.
// - Replace `[e-mail]` by your e-mail address.
// - Replace description in `package.json`.
// - Replace keywords in `package.json` after "verify".
// - Go to https://www.npmjs.com/ and create a new NPM access token.
// - Set NPM_AUTH_TOKEN environment variable the token value in Travis CI project settings.
// - Run `git tag v0.0.0 && git push --tags` to publish version 0.0.0
// - Replace this todo list by actual Javascript example.
// - Mention template (optional):
//
//       > **Note:** this ESLint config was created using [eslint-config-template](https://github.com/amercier/eslint-config-template).
//
// - Edit `index.json`
// - Edit `test/fixture`
// - Set version to `0.1.0` in `package.json`
// - Run `git tag v0.1.0 && git push --tags` to publish version 0.1.0

Installation

Prerequisites:

• Node.js 4+, npm 3+.
• ESLint 4+

Important: please note ESLint needs to be installed alongside this module. Latest versions is recommended. This is because this modules uses peer dependencies to be more flexible. For Node 4 and 5, use eslint@4.

npm install --save-dev eslint
npm install --save-dev eslint-config-template

Usage

Add this to your .eslintrc.json:

{
  "extends": ["template"]
}

Contributing

Please read guidelines for contributing.

License