Package detail

@stencila/eslint-config

stencila300Apache-2.03.0.4

Shared ESLint configuration for Stencila projects

Stencila, dev, ESLint, config

readme

`@stencila/eslint-config`

Adding rules

When adding a rule, prefer error over warn as warnings tend to be ignored, whereas errors can not. If a rule is fixable (i.e. using the --fix makes errors go away) then there is no inconvenience anyway by making it an error instead of a warning.

General Usage

It's recommended that you install this package using NPM v7 or higher. This will ensure that any peerDependencies are automatically installed for you.

From the project where you would like to use these settings, run:

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

Then modify your package.json to include the following code block. If you already have a eslintConfig configuration defined there, you’ll need to modify it.

  // …
  "eslintConfig": {
    // If your project is inside a monorepo, include `"root": true`, otherwise it can be omitted
    "root": true,
    "extends": "@stencila/eslint-config",
    "parserOptions": {
      "project": "./tsconfig.json"
    }
  }
  // …

Installing with NPM v6 and below

For usage with NPM v6 and below, please follow the peerDependency warning messages shown in your console when running the above command, or see the list of peerDependencies in the package.json file and install them manually.

This is necessary because ESLint runs plugins relative to the end consuming project's root, you need to install the all required plugins as dependencies of the project. For details see ESLint documentation.

Using with React.js based projects

This is same as above, but adds a couple of extra React specific plugins

npm install --save-dev @stencila/eslint-config \
  eslint-plugin-jsx-a11y \
  eslint-plugin-react \
  eslint-plugin-react-hooks \

Then modify your package.json to include the following code block. If you already have a eslintConfig configuration defined there, you’ll need to modify it.

  // …
  "eslintConfig": {
    // If your project is inside a monorepo, include `"root": true`, otherwise it can be omitted
    "root": true,
    "extends": [
      "plugin:react/recommended",
      "plugin:jsx-a11y/recommended",
      "plugin:react-hooks/recommended",
      "@stencila/eslint-config"
    ],
    "parserOptions": {
      "project": "./tsconfig.json"
    }
  }
  // …

References

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.0.4 (2022-03-10)

Bug Fixes

ESLint: Change ESlint peer dependency version range (9b99e98)

3.0.3 (2022-03-10)

Bug Fixes

ESLint: Bump ESlint peer dependency version range (a52c521)

3.0.2 (2022-03-10)

Note: Version bump only for package @stencila/eslint-config

3.0.1 (2021-12-01)

Note: Version bump only for package @stencila/eslint-config

3.0.0 (2021-11-01)

Features

ESLint: Simplify config, drop custom configs for React (88265f1)

BREAKING CHANGES

ESLint: React specific configurations weren't used often, and so the current recommendation is to use other presets on top of Stencila's own.

2.0.22 (2021-10-27)

Note: Version bump only for package @stencila/eslint-config

2.0.21 (2021-10-27)

Bug Fixes

dependencies: update dependency eslint to v8 (7fad271)

2.0.20 (2021-10-27)

Bug Fixes

dependencies: update dependency eslint-plugin-prettier to v4 (3002532)
dependencies: update typescript-eslint monorepo to v5 (38f9730)

2.0.19 (2021-10-20)

Note: Version bump only for package @stencila/eslint-config

2.0.18 (2021-09-22)

Note: Version bump only for package @stencila/eslint-config

2.0.17 (2021-09-15)

Note: Version bump only for package @stencila/eslint-config

2.0.16 (2021-09-01)

Note: Version bump only for package @stencila/eslint-config

2.0.15 (2021-07-07)

Note: Version bump only for package @stencila/eslint-config

2.0.14 (2021-06-30)

Note: Version bump only for package @stencila/eslint-config

2.0.13 (2021-06-23)

Note: Version bump only for package @stencila/eslint-config

2.0.12 (2021-06-10)

Note: Version bump only for package @stencila/eslint-config

2.0.11 (2021-06-09)

Note: Version bump only for package @stencila/eslint-config

2.0.10 (2021-06-02)

Note: Version bump only for package @stencila/eslint-config

2.0.9 (2021-05-12)

Bug Fixes

Deps: Update dependencies (95e2d5b)

2.0.8 (2021-05-12)

Note: Version bump only for package @stencila/eslint-config

2.0.7 (2021-05-07)

Note: Version bump only for package @stencila/eslint-config

2.0.6 (2021-05-07)

Note: Version bump only for package @stencila/eslint-config

2.0.5 (2021-03-10)

Note: Version bump only for package @stencila/eslint-config

2.0.4 (2021-03-03)

Bug Fixes

dependencies: update dependency eslint-config-prettier to v8 (a8ba400)

2.0.3 (2021-03-03)

Note: Version bump only for package @stencila/eslint-config

2.0.2 (2021-02-17)

Note: Version bump only for package @stencila/eslint-config

2.0.1 (2021-02-11)

Bug Fixes

ESLint config: Add unused vars patterns (43cef6e)

2.0.0 (2021-02-09)

Bug Fixes

Dependencies: Update dependency standard to v16 (cbbadd9)

BREAKING CHANGES

Dependencies: Some significant changes to default StandardJS options See: https://standardjs.com/changelog.html

1.3.69 (2021-01-14)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.13.0 (96dd0a1)

1.3.68 (2021-01-07)

Bug Fixes

dependencies: update dependency eslint-plugin-prettier to ^3.3.1 (9994c3c)

1.3.67 (2021-01-07)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.12.0 (a2631e5)

1.3.66 (2021-01-06)

Bug Fixes

dependencies: update dependency eslint to ^7.17.0 (2bb9b74)

1.3.65 (2021-01-02)

Bug Fixes

dependencies: update dependency eslint-plugin-react to ^7.22.0 (b872ad6)

1.3.64 (2020-12-31)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.11.1 (7346cf8)

1.3.63 (2020-12-24)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.11.0 (5e86830)

1.3.62 (2020-12-23)

Bug Fixes

dependencies: update dependency eslint-config-prettier to ^7.1.0 (b12c118)

1.3.61 (2020-12-23)

Bug Fixes

dependencies: update dependency eslint to ^7.16.0 (d740bca)

1.3.60 (2020-12-17)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.10.0 (9de52d9)

1.3.59 (2020-12-17)

Bug Fixes

dependencies: update dependency eslint-plugin-prettier to ^3.3.0 (0c9d5bf)

1.3.58 (2020-12-16)

Note: Version bump only for package @stencila/eslint-config

1.3.57 (2020-12-10)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.9.1 (086128c)

1.3.56 (2020-12-09)

Bug Fixes

dependencies: update dependency eslint-config-prettier to v7 (31a587c)

1.3.55 (2020-12-09)

Bug Fixes

dependencies: update dependency eslint-plugin-prettier to ^3.2.0 (720ddbb)

1.3.54 (2020-12-09)

Bug Fixes

dependencies: update dependency eslint to ^7.15.0 (af7f68e)

1.3.53 (2020-12-07)

Note: Version bump only for package @stencila/eslint-config

1.3.52 (2020-12-03)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.9.0 (c624afe)

1.3.51 (2020-11-26)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.8.2 (759effa)

1.3.50 (2020-11-25)

Bug Fixes

dependencies: update dependency eslint to ^7.14.0 (f24736f)

1.3.49 (2020-11-25)

Note: Version bump only for package @stencila/eslint-config

1.3.48 (2020-11-20)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.8.1 (979ecc4)

1.3.47 (2020-11-12)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.7.0 (c65dfaa)

1.3.46 (2020-11-11)

Bug Fixes

dependencies: update dependency eslint to ^7.13.0 (ec82fd5)

1.3.45 (2020-11-05)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.6.1 (a82cdb9)

1.3.44 (2020-10-30)

Bug Fixes

dependencies: update dependency eslint-config-prettier to ^6.15.0 (a280b41)

1.3.43 (2020-10-30)

Bug Fixes

dependencies: update dependency eslint to ^7.12.1 (eece3e1)

1.3.42 (2020-10-30)

Note: Version bump only for package @stencila/eslint-config

1.3.41 (2020-10-29)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.6.0 (2b447f9)

1.3.40 (2020-10-23)

Bug Fixes

dependencies: update dependency eslint-plugin-react-hooks to ^4.2.0 (6226878)

1.3.39 (2020-10-23)

Bug Fixes

dependencies: update dependency eslint-plugin-react to ^7.21.5 (2afac22)

1.3.38 (2020-10-22)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.5.0 (621f971)

1.3.37 (2020-10-21)

Bug Fixes

dependencies: update dependency eslint-config-prettier to ^6.13.0 (23d9b8a)

1.3.36 (2020-10-15)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.4.1 (7af437b)

1.3.35 (2020-10-14)

Bug Fixes

dependencies: update dependency eslint-plugin-react to ^7.21.4 (64f442e)

1.3.34 (2020-10-14)

Bug Fixes

dependencies: update dependency eslint to ^7.11.0 (4cd55ef)

1.3.33 (2020-10-08)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.4.0 (fddc809)

1.3.32 (2020-10-07)

Bug Fixes

dependencies: update dependency eslint-plugin-react to ^7.21.3 (f452695)

1.3.31 (2020-10-01)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.3.0 (f529494)

1.3.30 (2020-09-30)

Bug Fixes

dependencies: update dependency eslint-config-prettier to ^6.12.0 (b897ae9)

1.3.29 (2020-09-28)

Bug Fixes

dependencies: update dependency eslint-plugin-react to ^7.21.2 (a9523e7)

1.3.28 (2020-09-28)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^4.2.0 (83480de)

1.3.27 (2020-09-28)

Bug Fixes

dependencies: update dependency eslint to ^7.10.0 (02a2329)
dependencies: update dependency eslint-plugin-react-hooks to ^4.1.2 (0c60fbb)

1.3.26 (2020-09-09)

Bug Fixes

dependencies: update typescript-eslint monorepo to v4 (47a16d6)

1.3.25 (2020-09-09)

Bug Fixes

dependencies: update dependency eslint to ^7.8.1 (6aa9463)

1.3.24 (2020-08-27)

Note: Version bump only for package @stencila/eslint-config

1.3.23 (2020-08-27)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^3.10.1 (828890e)

1.3.22 (2020-08-19)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^3.9.1 (82e1dd8)

1.3.21 (2020-08-19)

Bug Fixes

dependencies: update dependency eslint-plugin-react to ^7.20.6 (159f15a)

1.3.20 (2020-08-19)

Bug Fixes

dependencies: update dependency eslint to ^7.7.0 (17ab988)
dependencies: update dependency eslint-plugin-react-hooks to ^4.1.0 (0f32800)

1.3.19 (2020-08-13)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^3.9.0 (ae8a0a7)

1.3.18 (2020-08-10)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^3.8.0 (b374446)

1.3.17 (2020-08-10)

Bug Fixes

dependencies: update dependency eslint to ^7.6.0 (d46b273)
dependencies: update dependency eslint-plugin-react to ^7.20.5 (1b3e7cb)

1.3.16 (2020-07-23)

Bug Fixes

dependencies: update dependency eslint to ^7.5.0 (7758771)

1.3.15 (2020-07-21)

Note: Version bump only for package @stencila/eslint-config

1.3.14 (2020-07-21)

Bug Fixes

dependencies: update dependency eslint-plugin-react-hooks to ^4.0.8 (6d41d20)
dependencies: update typescript-eslint monorepo to ^3.7.0 (bbd2875)

1.3.13 (2020-07-08)

Bug Fixes

dependencies: update dependency eslint to ^7.4.0 (6761137)

1.3.12 (2020-07-08)

Bug Fixes

dependencies: update dependency eslint-plugin-react-hooks to ^4.0.6 (8c47a64)
dependencies: update typescript-eslint monorepo to ^3.6.0 (13b9464)

1.3.11 (2020-07-03)

Bug Fixes

dependencies: update dependency eslint-plugin-react-hooks to ^4.0.5 (d948ff7)

1.3.10 (2020-07-03)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^3.5.0 (4f2c70d)

1.3.9 (2020-07-03)

Note: Version bump only for package @stencila/eslint-config

1.3.8 (2020-07-03)

Bug Fixes

dependencies: update dependency eslint-plugin-react to ^7.20.3 (44891ab)

1.3.7 (2020-07-03)

Bug Fixes

dependencies: update dependency eslint to ^7.3.1 (734877e)

1.3.6 (2020-06-17)

Bug Fixes

dependencies: update dependency eslint-plugin-prettier to ^3.1.4 (5cc0678)
dependencies: update typescript-eslint monorepo to ^3.3.0 (c4b52b5)

1.3.5 (2020-06-17)

Bug Fixes

dependencies: update dependency eslint to ^7.2.0 (eda645c)

1.3.4 (2020-06-05)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^3.1.0 (7ae9637)

1.3.3 (2020-06-05)

Note: Version bump only for package @stencila/eslint-config

1.3.2 (2020-05-27)

Note: Version bump only for package @stencila/eslint-config

1.3.1 (2020-05-27)

Bug Fixes

ESLint: Use update ban-ts-ignore rule name (ae301c7)

1.3.0 (2020-05-27)

Features

ESLint: Enable no-shadow rule. Close #64 (812c8f2)

1.2.24 (2020-05-27)

Bug Fixes

dependencies: update typescript-eslint monorepo to v3 (86cc18f)

1.2.23 (2020-05-27)

Bug Fixes

dependencies: update dependency eslint to ^7.1.0 (7ce938f)
dependencies: update dependency eslint-plugin-react-hooks to ^4.0.4 (4c1a962)

1.2.22 (2020-05-20)

Bug Fixes

dependencies: update dependency eslint-plugin-react-hooks to ^4.0.2 (2061071)
dependencies: update typescript-eslint monorepo to ^2.34.0 (464d4de)

1.2.21 (2020-05-20)

Note: Version bump only for package @stencila/eslint-config

1.2.20 (2020-05-13)

Bug Fixes

dependencies: update dependency eslint-plugin-react-hooks to ^4.0.1 (d6e28c8)

1.2.19 (2020-05-13)

Bug Fixes

dependencies: update dependency eslint-plugin-react to ^7.20.0 (f49c762)
dependencies: update typescript-eslint monorepo to ^2.33.0 (64aa05f)

1.2.18 (2020-05-13)

Bug Fixes

dependencies: update dependency eslint to v7 (efd2474)
dependencies: update dependency standard to ^14.3.4 (f4fd4df)

1.2.17 (2020-05-13)

Note: Version bump only for package @stencila/eslint-config

1.2.16 (2020-05-07)

Bug Fixes

dependencies: update dependency eslint-plugin-react-hooks to v4 (011f171)
dependencies: update typescript-eslint monorepo to ^2.31.0 (148a7d6)

1.2.15 (2020-04-23)

Note: Version bump only for package @stencila/eslint-config

1.2.14 (2020-04-23)

Bug Fixes

dependencies: update dependency eslint-config-prettier to ^6.11.0 (845ef84)

1.2.13 (2020-04-23)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^2.29.0 (5222857)

1.2.12 (2020-04-15)

Bug Fixes

dependencies: update dependency eslint-plugin-prettier to ^3.1.3 (7610962)

1.2.11 (2020-04-14)

Bug Fixes

dependencies: update dependency eslint-plugin-react-hooks to v3 (894cd65)
dependencies: update typescript-eslint monorepo to ^2.28.0 (fa5b024)

1.2.10 (2020-04-14)

Note: Version bump only for package @stencila/eslint-config

1.2.9 (2020-03-27)

Bug Fixes

dependencies: update dependency eslint-config-prettier to ^6.10.1 (ecb50f4)
dependencies: update dependency eslint-plugin-react-hooks to ^2.5.1 (17dac54)
dependencies: update typescript-eslint monorepo to ^2.25.0 (eebe278)

1.2.8 (2020-03-18)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^2.24.0 (b43709f)

1.2.7 (2020-03-18)

Bug Fixes

dependencies: update dependency @stencil/eslint-plugin to ^0.3.1 (475f292)
dependencies: update dependency standard to ^14.3.3 (2f9e4ae)
dependencies: update typescript-eslint monorepo to ^2.23.0 (55c5a25)

1.2.6 (2020-03-09)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^2.22.0 (b459af6)

1.2.5 (2020-02-26)

Bug Fixes

dependencies: update typescript-eslint monorepo to ^2.21.0 (d51d8ad)

1.2.4 (2020-02-26)

Note: Version bump only for package @stencila/eslint-config

1.2.3 (2020-02-26)

Bug Fixes

dependencies: update dependency eslint to ^6.8.0 (3cc1084)

1.2.2 (2020-02-26)

Bug Fixes

dependencies: update dependency eslint-config-prettier to ^6.10.0 (b71368b)

1.2.1 (2020-01-22)

Note: Version bump only for package @stencila/eslint-config

1.2.0 (2020-01-22)

Features

Eslint: Add new null coalescing and optional chaining rules (3931747)

1.1.10 (2020-01-07)

Note: Version bump only for package @stencila/eslint-config

1.1.9 (2019-12-17)

Note: Version bump only for package @stencila/eslint-config

1.1.8 (2019-12-16)

Note: Version bump only for package @stencila/eslint-config

1.1.7 (2019-11-22)

Note: Version bump only for package @stencila/eslint-config

1.1.6 (2019-11-21)

Note: Version bump only for package @stencila/eslint-config

1.1.5 (2019-11-21)

Note: Version bump only for package @stencila/eslint-config

1.1.4 (2019-10-16)

Bug Fixes

ESLint: Relax strict-boolean-expressions rule for null & undefined (94f292b)

1.1.3 (2019-10-16)

Note: Version bump only for package @stencila/eslint-config

1.1.2 (2019-09-04)

Note: Version bump only for package @stencila/eslint-config

1.1.1 (2019-07-12)

Bug Fixes

Install: Fix install issues and add postinstall hook (12b0294)

1.1.0 (2019-07-11)

Bug Fixes

ESLint: Add missing project config field (2d8bbdb)
ESLint: Add StencilJS lint configuration file to package files (8e3c091)
ESLint: Fix issues with using configuration from other projects (c47c2a6)
ESLint: Fix typo in Linting rule configuration (ba6d669)

Features

ESLint: Add custom linting rules (91cd2f5)

1.0.5 (2019-06-19)

Bug Fixes

Lerna: Fix install issues when bootstrapping the project (c6f0da1)

1.0.4 (2019-06-18)

Note: Version bump only for package @stencila/eslint-config

1.0.3 (2019-06-18)

Note: Version bump only for package @stencila/eslint-config

1.0.2 (2019-06-18)

Note: Version bump only for package @stencila/eslint-config

1.0.1 (2019-06-18)

Note: Version bump only for package @stencila/eslint-config