Shared eslint config for Sinon

The sharable eslint config for all Sinon.JS projects.

The package includes all the dependencies to have a working eslint setup that works with the configuration. Adopting projects will only need to install @sinonjs/eslint-config.

Install

$ npm install @sinonjs/eslint-config --save-dev

Usage

Add this to the package.json:

{
  "eslintConfig": {
    "extends": "@sinonjs/eslint-config"
  }
}

Create a .browserslistrc in the root of the project

> 0.5%
last 2 versions
Firefox ESR
not dead
not IE 11
not op_mini all
maintained node versions

Visit browserslist.dev to see what this translates to.

Changes

5.0.3

• 0ae5053 Upgrade packages: eslint-plugin-compat blocking Eslint 9 (Carl-Erik Kopseng)

  Eslint-plugin-compat has not been maintained for 7 months. Version 9 of Eslint has long been out and a PR exists for fixing the compatibility. We might need to either fork or find something else. https://github.com/amilajack/eslint-plugin-compat/pull/609

Released by Carl-Erik Kopseng on 2024-04-25.

5.0.2

• 9753796 chore: update browserslist (Morgan Roderick)

Released by Morgan Roderick on 2023-12-27.

5.0.1

• c2ad115 Use Typescript flavored JSDoc (Carl-Erik Kopseng)

Released by Carl-Erik Kopseng on 2023-11-28.

5.0.0

• eab78ee Upgrade packages to support Node >= 20 (Carl-Erik Kopseng)

Released by Carl-Erik Kopseng on 2023-11-28.

4.1.0

• 3aa7026 Fix failing parsing of destructuring assignment (Carl-Erik Kopseng)

  https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment#specifications

4.0.5

• 2b0f92b Upgrade dependencies (Carl-Erik Kopseng)
• 097f653 Target all extensions matching .test. and -test. (Carl-Erik Kopseng)

  Fixes an issue where .mjs test files were not checked with this config.

Released by Carl-Erik Kopseng on 2022-01-28.

4.0.4

• 06c342a Bump glob-parent from 5.1.1 to 5.1.2 (dependabot[bot])

  Bumps glob-parent from 5.1.1 to 5.1.2.

  • Release notes
  • Changelog
  • Commits

  ---

  updated-dependencies:

  • dependency-name: glob-parent dependency-type: indirect ...

  Signed-off-by: dependabot[bot] support@github.com

Released by Morgan Roderick on 2021-07-08.

4.0.3

• 60d64d9 Bump browserslist from 4.16.3 to 4.16.6 (#10) (dependabot[bot])

  Bumps browserslist from 4.16.3 to 4.16.6.

  • Release notes

  • Changelog

  • Commits

  Signed-off-by: dependabot[bot] support@github.com

  Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Released by Morgan Roderick on 2021-05-29.

4.0.2

• 9874e52 disable arrow-parens (Carl-Erik Kopseng)

Released by Carl-Erik Kopseng on 2021-05-11.

4.0.1

• 166b2bb Include .browserlistrc in included files (Carl-Erik Kopseng)

  See sinonjs/sinon#2366

  Makes it possible to reuse it.

Released by Morgan Roderick on 2021-05-04.

4.0.0

• 6dc048a Configure eslint and prettier (Morgan Roderick)

  This repository should at least follow the same rules as the dependent projects

  Also run prettier on index.js to make it compliant

• 23fec22 Increate max-nested-callbacks (Morgan Roderick)

  This is a pragmatic measure to not have to refactor all the consuming libraries at this time. This can be improved in the future

• 0ead948 Update README.md (Morgan Roderick)
• 23237ae Remove configuration of eslint-plugin-prettier (Morgan Roderick)

  Downstream projects have switched to using prettier --check to verify that code follows style guide.

  Example: https://github.com/sinonjs/sinon/pull/2324

• 000a452 Add eslint-plugin-jsdoc as a dependency (Morgan Roderick)
• 8fbffa1 Add eslint-plugin-compat as dependency (Morgan Roderick)

  The current recommended configuration is:

  > 0.5%
  last 2 versions
  Firefox ESR
  not dead
  not IE 11
  not op_mini all
  maintained node versions

  This configuration will need to be manually set in a .browserslistrc file in projects consuming this package (@sinonjs/eslint-config).

• 7080861 Configure eslint-plugin-mocha (Morgan Roderick)
• 5a2eb0b Add .prettierrc and .prettierignore (Morgan Roderick)
• 621c2f1 Configure parser: use ES2017 (Morgan Roderick)

  Also drop AMD support, we were not using it anyway.

  This effectively drops IE11 and legacy Edge, as they can't parse ES2017.

• a05b116 Confiure symbol-description (Morgan Roderick)

  See https://eslint.org/docs/rules/symbol-description

• 6496a25 Configure require-yield (Morgan Roderick)

  See https://eslint.org/docs/rules/require-yield

• 4107521 Configure no-useless-rename (Morgan Roderick)

  See https://eslint.org/docs/rules/no-useless-rename

• 10553f6 Configure no-useless-constructor (Morgan Roderick)

  See https://eslint.org/docs/rules/no-useless-constructor

• 6b49ddc Configure no-useless-computed-key (Morgan Roderick)

  See https://eslint.org/docs/rules/no-useless-computed-key

• 5649825 Configure no-this-before-super (Morgan Roderick)

  See https://eslint.org/docs/rules/no-this-before-super

• 652de47 Configure no-restricted-exports (Morgan Roderick)

  See https://eslint.org/docs/rules/no-restricted-exports

• b13753c Configure no-new-symbol (Morgan Roderick)

  See https://eslint.org/docs/rules/no-new-symbol

• ab04bf2 Configure no-duplicate-imports (Morgan Roderick)

  See https://eslint.org/docs/rules/no-duplicate-imports

• da6118b Configure no-dupe-class-members (Morgan Roderick)

  See https://eslint.org/docs/rules/no-dupe-class-members

• 3846a73 Configure no-confusing-arrow (Morgan Roderick)

  See https://eslint.org/docs/rules/no-confusing-arrow

• c9c849f Configure no-class-assign (Morgan Roderick)

  See https://eslint.org/docs/rules/no-class-assign

• b367df6 Configure constructor-super (Morgan Roderick)

  See https://eslint.org/docs/rules/constructor-super

• 21792c4 Configure arrow-parens (Morgan Roderick)

  See https://eslint.org/docs/rules/arrow-parens

• 0e8ea1a Configure arrow-body-style (Morgan Roderick)

  See https://eslint.org/docs/rules/arrow-body-style

• 885b429 Let prettier handle semi colons (Morgan Roderick)
• 4e841fa Let prettier handle line lengths (Morgan Roderick)
• ff4df53 Rename to use id-denylist (Morgan Roderick)
• 42ed7cc Remove unused nodeAndCommonJS section (Morgan Roderick)

  The rules are not are not even used, are deprecated in eslint@7 and the [eslint-plugin-node][1] project they've been extracted to looks to have gone stale.

  We clearly are doing fine without them

  [1]: https://github.com/mysticatea/eslint-plugin-node

• 95372f0 Configure require-await as error (Morgan Roderick)

  See https://eslint.org/docs/rules/require-await

• 2bdb2b5 Configure prefer-regex-literals as off (Morgan Roderick)

  See https://eslint.org/docs/rules/prefer-regex-literals

• f93c307 Configure prefer-promise-reject-errors as error (Morgan Roderick)
• cc77ae7 Configure no-useless-catch (Morgan Roderick)

  See https://eslint.org/docs/rules/no-useless-catch

• d3a6c2f Make no-return-await an error (Morgan Roderick)
• 41fdf58 Configure no-nonoctal-decimal-escape (Morgan Roderick)

  See https://eslint.org/docs/rules/no-nonoctal-decimal-escape

• 38fba1c Configure no-constructor-return (Morgan Roderick)

  See https://eslint.org/docs/rules/no-constructor-return

• 5cfc3a2 Configure grouped-accessor-pairs (Morgan Roderick)

  See https://eslint.org/docs/rules/grouped-accessor-pairs

• b8c7606 Configure default-param-last (Morgan Roderick)

  See https://eslint.org/docs/rules/default-param-last

• 029c9bb Configure default-case-last (Morgan Roderick)

  See https://eslint.org/docs/rules/default-case-last

• 1b02f41 Configure no-useless-backreference (Morgan Roderick)

  See https://eslint.org/docs/rules/no-useless-backreference

• d5872f4 Configure no-unsafe-optional-chaining (Morgan Roderick)

  See https://eslint.org/docs/rules/no-unsafe-optional-chaining

• c869683 Configure no-unreachable-loop (Morgan Roderick)

  See https://eslint.org/docs/rules/no-unreachable-loop

• f4fde1c Configure no-setter-return (Morgan Roderick)

  See https://eslint.org/docs/rules/no-setter-return

• eb4d5b2 Configure no-promise-executor-return (Morgan Roderick)

  See https://eslint.org/docs/rules/no-promise-executor-return

• 34d9f29 Configure no-loss-of-precision (Morgan Roderick)

  See https://eslint.org/docs/rules/no-loss-of-precision

• 78584d0 Configure no-import-assign (Morgan Roderick)

  See https://eslint.org/docs/rules/no-import-assign

• 5c41d80 Configure no-dupe-else-if (Morgan Roderick)

  See https://eslint.org/docs/rules/no-dupe-else-if

• 149645d Quotes are handled by prettier now (Morgan Roderick)
• a669299 Add eslint-plugin-mocha as dependency (Morgan Roderick)
• 1b5381e Add eslint dependency (Morgan Roderick)

  By adding this as a dependency, downstream projects won't need to keep track of adding the correct eslint version for every version of eslint-config-sinon, which makes it a lot easier to keep up with maintenance.

• dc72863 Add @studio/changes (Morgan Roderick)
• 461e543 Rename package to @sinonjs/eslint-config (Morgan Roderick)
• a8bc416 4.0.0 (Morgan Roderick)
• 956db70 Add linting of jsdoc comments (Morgan Roderick)
• c601913 Add CONTRIBUTING.md and CODE_OF_CONDUCT.md (Morgan Roderick)
• 4d92c92 3.0.1 (Morgan Roderick)
• f8e6287 Disable no-use-before-define for functions (Morgan Roderick)

  Functions are hoisted, so they're safe to use before they're defined

• 210ba1b 3.0.0 (Morgan Roderick)
• e46ca1d Remove require-jsdoc (Morgan Roderick)

  It has been deprecated, see https://eslint.org/docs/rules/require-jsdoc

• a3d06e7 Fix copy-paste error for array-element-newline (Morgan Roderick)
• 7eb6698 Add prefer-named-capture-group (Morgan Roderick)

  And set it to "off", as Sinon targets ES5.1

• 398f46c Remove no-valid-jsdoc (Morgan Roderick)

  It has been deprecated, see https://eslint.org/docs/rules/valid-jsdoc

• defc11d Require eslint@6.1.0 as peer dependency (Morgan Roderick)
• 849e706 Disable all rules handled by prettier (Morgan Roderick)
• 57b22c5 Set new major version (Morgan Roderick)
• 3b77f63 Enable more rules in 'ecmascript6' (Morgan Roderick)
• d8bea0e Enable more rules in 'node and commonjs' (Morgan Roderick)
• ef0f234 Enable more rules in 'variables' (Morgan Roderick)
• 6a316d4 Enable more rules in 'best practices' (Morgan Roderick)
• 7fe220c Enable more rules in 'possible errors' (Morgan Roderick)
• a3c3032 Format line for readability (Morgan Roderick)
• b086018 Extract ES6 settings to own object (Morgan Roderick)
• 831b1ab Extract stylistic issues to own object (Morgan Roderick)
• f639abf Extract Node and CommonJS settings to own object (Morgan Roderick)
• 13786a4 Extract variables to their own object (Morgan Roderick)
• d2af386 Extract strict mode to own object (Morgan Roderick)
• ad2b906 Extract best practices to their own object (Morgan Roderick)
• cfaf279 Extract possible errors to their own object (Morgan Roderick)
• 0f7441a 1.0.3 (Carl-Erik Kopseng)
• 3dad8b4 Use Eslint 4 (Carl-Erik Kopseng)
• 7f6ca5c 1.0.2 (Maximilian Antoni)
• 6bd7e8d Set ecmaVersion to 5 (#1) (Morgan Roderick)

  This is the version supported in sinonjs/sinon, and should be the

  default across all projects.

  Individual projects can set their own version, if they need to override

  this

• 971e0c3 1.0.1 (Maximilian Antoni)
• 95cf683 Fix repository URL (Maximilian Antoni)
• 4c12349 Extract Sinon.JS eslint configs (Maximilian Antoni)
• 1b1cb8e Add LICENSE (Maximilian Antoni)
• b58b1c1 Add README.md (Maximilian Antoni)

Released by Morgan Roderick on 2021-03-12.