@platoai/eslint-config

0.0.5 • Public • Published

@platoai/eslint-config

npm version

ESLint shareable config for the Plato AI style.

Installation

npm install --save-dev eslint @platoai/eslint-config

Usage

Once the @platoai/eslint-config package is installed, you can use it by specifying @platoai in the extends section of your ESLint configuration.

{
  "extends": "@platoai",
  "rules": {
    // Additional, per-project rules...
  }
}

Using the @platoai config with eslint:recommended

There are several rules in the eslint:recommended ruleset that Plato AI style is not opinionated about that you might want to enforce in your project.

To use Plato AI style in conjunction with ESLint's recommended rule set, extend them both, making sure to list @platoai last:

{
  "extends": ["eslint:recommended", "@platoai"],
  "rules": {
    // Additional, per-project rules...
  }
}

To see how the @platoai config compares with eslint:recommended, refer to the source code of index.js, which lists every ESLint rule along with whether (and how) it is enforced by the @platoai config.

License

Apache-2 © Google

Package Sidebar

Install

npm i @platoai/eslint-config

Weekly Downloads

3

Version

0.0.5

License

Apache-2.0

Last publish

Collaborators

  • mwilliammyers