eslint-config-standard

What is eslint-config-standard?

The eslint-config-standard package is an ESLint Shareable Config that enforces a standard style guide for JavaScript code. It helps maintain code quality and consistency across projects by providing a set of rules and best practices.

What are eslint-config-standard's main functionalities?

Enforce coding style

By extending 'standard' in your ESLint configuration file, you can enforce a consistent coding style across your project.

{ "extends": "standard" }

Catch problematic patterns

The package includes rules that help catch common errors and problematic patterns in your JavaScript code.

/* eslint-env node */

function add(a, b) {
  return a + b;
}

add(1, 2);

Integrate with code editors

You can integrate eslint-config-standard with code editors to get real-time linting feedback as you write code.

// .eslintrc.js
module.exports = {
  extends: 'standard',
  // Additional, per-project rules...
};

Other packages similar to eslint-config-standard

eslint-config-airbnb

This package provides Airbnb's .eslintrc as an extensible shared config. It is known for its strict and opinionated rule set that enforces a specific coding style and best practices.

eslint-config-google

This package includes the ESLint rules used by Google. It is less opinionated than Airbnb's config but still enforces a consistent code style.

eslint-config-prettier

eslint-config-prettier disables all rules that are unnecessary or might conflict with Prettier. It is often used in conjunction with other ESLint configs to format code according to Prettier's rules.

README

eslint-config-standard

An ESLint Shareable Config for JavaScript Standard Style

Install

This module is for advanced users. You probably want to use standard instead :)

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.

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:

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.

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/standard/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.