eslint-config-standard-trailing-commas
v6.1.0
Published
JavaScript Standard Style with Trailing Commas - ESLint Shareable Config
Downloads
339
Maintainers
Readme
Standard Trailing Commas
A fork of eslint-config-standard which enforces the use of trailing, aka dangling, commas in object literals & arrays that span multiple lines.
Why would you want to use this? From the eslint documentation page for this rule:
Trailing commas simplify adding and removing items to objects and arrays, since only the lines you are modifying must be touched. Another argument in favor of trailing commas is that it improves the clarity of diffs when an item is added or removed from an object or array
Instructions
First, install the eslint config & required plugins.
npm i -D eslint-config-standard-trailing-commas eslint-plugin-standard eslint-plugin-promise
Then, add this to your .eslintrc.json file:
{
"extends": "standard-trailing-commas"
}
Or this, if using React:
{
"extends": ["standard-trailing-commas", "standard-react"]
}
Original Standard documentation shown below for reference:
Standard - ESLint Shareable Config
An ESLint Shareable Config for JavaScript Standard Style
This module is for advanced users. You probably want to use standard
instead :)
Install
npm install eslint-config-standard
Usage
Shareable configs are designed to work with the extends
feature of .eslintrc
files.
You can learn more about
Shareable Configs on the
official ESLint website.
To use the JavaScript Standard Style shareable config, first run this:
npm install eslint-config-standard eslint-plugin-standard eslint-plugin-promise
Then, add this to your .eslintrc file:
{
"extends": "standard"
}
Note: We omitted the eslint-config-
prefix since it is automatically assumed by ESLint.
You can override settings from the shareable config by adding them directly into your
.eslintrc
file.
Looking for something easier than this?
The easiest way to use JavaScript Standard Style to check your code is to use the
standard
package. This comes with a global
Node command line program (standard
) that you can run or add to your npm test
script
to quickly check your style.
Badge
Use this in one of your projects? Include one of these badges in your readme to let people know that your code is using the standard style.
[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](http://standardjs.com)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com)
Learn more
For the full listing of rules, editor plugins, FAQs, and more, visit the main JavaScript Standard Style repo.
License
MIT. Copyright (c) Feross Aboukhadijeh.