JavaScript Standard Style - ESLint Shareable Config
npm install eslint-config-standard[ci-image]: https://github.com/standard/eslint-config-standard/actions/workflows/ci.yml/badge.svg?branch=master
[ci-url]: https://github.com/standard/eslint-config-standard/actions/workflows/ci.yml
[npm-image]: https://img.shields.io/npm/v/eslint-config-standard.svg
[npm-url]: https://npmjs.org/package/eslint-config-standard
[downloads-image]: https://img.shields.io/npm/dm/eslint-config-standard.svg
[downloads-url]: https://npmjs.org/package/eslint-config-standard
[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[standard-url]: https://standardjs.com
#### An ESLint Shareable Config for JavaScript Standard Style
This module is for advanced users. You probably want to use standard instead :)
``bash`
npm install eslint-config-standard
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.
If you want to set up the config automatically, follow these steps in your project directory:
1. npx eslint --init
2. Select "Use a popular style guide."
3. Select "Standard."
4. Select a config file format.
5. If prompted, confirm the installation of the necessary dependencies.
The above steps will automatically set up an ESLint configuration and install the necessary dependencies for you.
If you want to set up the config manually, run the following command:
`bash`
npm install --save-dev eslint-config-standard eslint-plugin-promise eslint-plugin-import eslint-plugin-n
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.
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.
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.
`markdown`
`markdown``
For the full listing of rules, editor plugins, FAQs, and more, visit the main
JavaScript Standard Style repo.
MIT. Copyright (c) Feross Aboukhadijeh.