eslint-confog-clockwork

ESLint shareable config for Clockwork

Install

npm install --save-dev eslint eslint-config-clockwork

Usage

Create a .eslintrc file in the root level of your project and add this:

{
    "extends": "clockwork"
}

Task runner plugins

• Gulp ESLint
• Grunt ESLint

NPM Script

Update scripts in your package.json at the root of your project.

"scripts": {
  "lint": "./node_modules/.bin/eslint <FOLDER_TO_LINT>"
}

Run the NPM script from the command line

npm run lint

Require before committing to GIT

Use Husky

npm install husky --save-dev

Add precommit to package.json scripts

"scripts": {
  "lint": "./node_modules/.bin/eslint <FOLDER_TO_LINT>",
  "precommit": "npm run lint"
}

Goals

• Focus on rules that could lead to bugs
• Prefer rules that increase readability over stylistic or religious wars (like spacing)
• Make linting easy for CMS, website and application projects
• Applicable to many contexts (jQuery, Angular, React, Vue & Node). Projects may extend it with specifics for each if necessary.

License

MIT