Skip to content
This repository was archived by the owner on Jan 19, 2024. It is now read-only.

Commit 085d926

Browse files
authored
0.11.0 (#98)
Moved `eslint-plugin-mocha` and the `chai-as-promised` plugin into an [independent configuration](https://github.com/xpring-eng/eslint-config-mocha). This is necessary so that consumers of this config are not locked in to Mocha, and have the flexibility to choose Jest (or any other testing library) as they see fit.
1 parent 53a31a0 commit 085d926

8 files changed

+16
-182
lines changed

CHANGELOG.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,18 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
76

8-
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
7+
This project DOES NOT adhere to Semantic Versioning. New rules may be added in minor versions that cause previously passing code to fail linting. That is working as intended, since the benefits of stricter rules that automatically get introduced when using Dependabot usually outweigh the inconvenience of infrequently having to update code to follow a stricter standard (or adding a `/*eslint-disable*/` comment).
98

109
## [Unreleased]
1110

11+
## 0.11.0 - July 28, 2020
12+
13+
Moved `eslint-plugin-mocha` and the `chai-as-promised` plugin into an [independent configuration](https://github.com/xpring-eng/eslint-config-mocha).
14+
15+
This is necessary so that consumers of this config are not locked in to Mocha, and have the flexibility to choose Jest (or any other testing library) as they see fit.
16+
1217
## 0.10.0 - July 21, 2020
1318

1419
- Change `max-statements` restriction from `10` to `15`.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ npm install --save-dev typescript @typescript-eslint/parser
1515
# Ensure ESLint & Prettier are installed
1616
npm install --save-dev eslint prettier
1717
# Install plugins used by @xpring-eng/eslint-config-base
18-
npm install --save-dev @typescript-eslint/eslint-plugin eslint-plugin-import eslint-plugin-mocha eslint-plugin-prettier eslint-plugin-tsdoc
18+
npm install --save-dev @typescript-eslint/eslint-plugin eslint-plugin-import eslint-plugin-prettier eslint-plugin-jsdoc eslint-plugin-tsdoc eslint-plugin-array-func eslint-plugin-eslint-comments eslint-plugin-node
1919

2020
# Install the Xpring ESLint config
2121
npm install --save-dev @xpring-eng/eslint-config-base

index.js

-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ module.exports = {
2727
'./rules/node',
2828
'./rules/import',
2929
'./rules/array-func',
30-
'./rules/mocha',
31-
'./rules/chai-as-promised',
3230
'./rules/prettier',
3331
].map(require.resolve),
3432
rules: {},

package-lock.json

+1-23
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+2-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@xpring-eng/eslint-config-base",
3-
"version": "0.10.0",
3+
"version": "0.11.0",
44
"description": "Xpring's base TS ESLint config, following our styleguide",
55
"keywords": [
66
"eslint",
@@ -10,7 +10,7 @@
1010
],
1111
"repository": {
1212
"type": "git",
13-
"url": "https://github.com/xpring-eng/eslint"
13+
"url": "https://github.com/xpring-eng/eslint-config-base"
1414
},
1515
"license": "MIT",
1616
"main": "index.js",
@@ -27,7 +27,6 @@
2727
"eslint-config-prettier": "^6.11.0"
2828
},
2929
"devDependencies": {
30-
"@fintechstudios/eslint-plugin-chai-as-promised": "^3.0.2",
3130
"@typescript-eslint/eslint-plugin": "^3.7.0",
3231
"@typescript-eslint/parser": "^3.7.0",
3332
"eslint": "^7.5.0",
@@ -36,23 +35,20 @@
3635
"eslint-plugin-eslint-comments": "^3.2.0",
3736
"eslint-plugin-import": "^2.22.0",
3837
"eslint-plugin-jsdoc": "^29.1.0",
39-
"eslint-plugin-mocha": "^7.0.1",
4038
"eslint-plugin-node": "^11.1.0",
4139
"eslint-plugin-prettier": "^3.1.3",
4240
"eslint-plugin-tsdoc": "^0.2.5",
4341
"prettier": "^2.0.5",
4442
"typescript": "^3.9.3"
4543
},
4644
"peerDependencies": {
47-
"@fintechstudios/eslint-plugin-chai-as-promised": "^3.0.2",
4845
"@typescript-eslint/eslint-plugin": "^3.7.0",
4946
"@typescript-eslint/parser": "^3.7.0",
5047
"eslint": "^7.5.0",
5148
"eslint-plugin-array-func": "^3.1.6",
5249
"eslint-plugin-eslint-comments": "^3.2.0",
5350
"eslint-plugin-import": "^2.22.0",
5451
"eslint-plugin-jsdoc": "^29.0.0",
55-
"eslint-plugin-mocha": "^7.0.1",
5652
"eslint-plugin-node": "^11.1.0",
5753
"eslint-plugin-prettier": "^3.1.3",
5854
"eslint-plugin-tsdoc": "^0.2.5",

rules/chai-as-promised.js

-23
This file was deleted.

rules/eslint-core/style.js

+4
Original file line numberDiff line numberDiff line change
@@ -347,6 +347,10 @@ module.exports = {
347347
{
348348
files: ['test/**/*.test.ts'],
349349
rules: {
350+
// For our test files, the pattern is to have unnamed functions
351+
// https://eslint.org/docs/rules/func-names
352+
'func-names': 'off',
353+
350354
// We use `const var = function expression` in tests to wrap functions that we expect to throw an error
351355
'func-style': 'off',
352356

rules/mocha.js

-124
This file was deleted.

0 commit comments

Comments
 (0)