JavaScript Coding Standards
Write bulletproof JavaScript like a pro! 😎
About
This repository contains various configuration files for the awesome JavaScript linter, ESLint. The configuration files are purposefully separated into various categories to allow their composition according to developers' preferences or requirements. It should also make adoption of ESLint across existing codebases easier.
Usage
Installation
This package can be installed via npm (make sure you also install the latest version of ESLint):
npm install --save-dev eslint@latest @strv/eslint-config-javascript@latest
Configuration
Once the ruleset is installed, you must create your own .eslintrc.{js,json,yml} configuration file in your project's root (or in some of the subfolders, if you want to apply different rules to different parts of your code) and include those rulesets that you want to use. See the tutorial directory for, well... tutorial.
Integrating ESLint with your IDE/editor
See the editor-integrations document for tips.
Example configuration files
See the tutorial directory for lots of example config files.
Available rulesets
These are for Node.js code.
- @strv/javascript/environments/nodejs/v8-3
- @strv/javascript/environments/nodejs/v8
- @strv/javascript/environments/nodejs/v7
- @strv/javascript/environments/nodejs/v6
- @strv/javascript/environments/nodejs/optional
These are for browser-specific code which uses React.
- @strv/javascript/environments/react/v15
- @strv/javascript/environments/react/optional
This one includes rules which deal with how the code looks like and not how it works. It helps keep the code clean and consistent.
- @strv/javascript/coding-styles/recommended
This is a subset of the recommended
coding style ruleset and includes only rules which ESLint can fix automatically. This is great for gradual adoption of coding style rulesets into existing projects.
- @strv/javascript/coding-styles/fixable
License
This software is licensed under the BSD-3-Clause License. See the LICENSE file for more information.