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

Commit

Permalink
0.11.0 (#98)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
0xCLARITY authored Jul 28, 2020
1 parent 53a31a0 commit 085d926
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 182 deletions.
11 changes: 8 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@

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

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

See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
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).

## [Unreleased]

## 0.11.0 - July 28, 2020

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.

## 0.10.0 - July 21, 2020

- Change `max-statements` restriction from `10` to `15`.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ npm install --save-dev typescript @typescript-eslint/parser
# Ensure ESLint & Prettier are installed
npm install --save-dev eslint prettier
# Install plugins used by @xpring-eng/eslint-config-base
npm install --save-dev @typescript-eslint/eslint-plugin eslint-plugin-import eslint-plugin-mocha eslint-plugin-prettier eslint-plugin-tsdoc
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

# Install the Xpring ESLint config
npm install --save-dev @xpring-eng/eslint-config-base
Expand Down
2 changes: 0 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,6 @@ module.exports = {
'./rules/node',
'./rules/import',
'./rules/array-func',
'./rules/mocha',
'./rules/chai-as-promised',
'./rules/prettier',
].map(require.resolve),
rules: {},
Expand Down
24 changes: 1 addition & 23 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 2 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@xpring-eng/eslint-config-base",
"version": "0.10.0",
"version": "0.11.0",
"description": "Xpring's base TS ESLint config, following our styleguide",
"keywords": [
"eslint",
Expand All @@ -10,7 +10,7 @@
],
"repository": {
"type": "git",
"url": "https://github.com/xpring-eng/eslint"
"url": "https://github.com/xpring-eng/eslint-config-base"
},
"license": "MIT",
"main": "index.js",
Expand All @@ -27,7 +27,6 @@
"eslint-config-prettier": "^6.11.0"
},
"devDependencies": {
"@fintechstudios/eslint-plugin-chai-as-promised": "^3.0.2",
"@typescript-eslint/eslint-plugin": "^3.7.0",
"@typescript-eslint/parser": "^3.7.0",
"eslint": "^7.5.0",
Expand All @@ -36,23 +35,20 @@
"eslint-plugin-eslint-comments": "^3.2.0",
"eslint-plugin-import": "^2.22.0",
"eslint-plugin-jsdoc": "^29.1.0",
"eslint-plugin-mocha": "^7.0.1",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-prettier": "^3.1.3",
"eslint-plugin-tsdoc": "^0.2.5",
"prettier": "^2.0.5",
"typescript": "^3.9.3"
},
"peerDependencies": {
"@fintechstudios/eslint-plugin-chai-as-promised": "^3.0.2",
"@typescript-eslint/eslint-plugin": "^3.7.0",
"@typescript-eslint/parser": "^3.7.0",
"eslint": "^7.5.0",
"eslint-plugin-array-func": "^3.1.6",
"eslint-plugin-eslint-comments": "^3.2.0",
"eslint-plugin-import": "^2.22.0",
"eslint-plugin-jsdoc": "^29.0.0",
"eslint-plugin-mocha": "^7.0.1",
"eslint-plugin-node": "^11.1.0",
"eslint-plugin-prettier": "^3.1.3",
"eslint-plugin-tsdoc": "^0.2.5",
Expand Down
23 changes: 0 additions & 23 deletions rules/chai-as-promised.js

This file was deleted.

4 changes: 4 additions & 0 deletions rules/eslint-core/style.js
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,10 @@ module.exports = {
{
files: ['test/**/*.test.ts'],
rules: {
// For our test files, the pattern is to have unnamed functions
// https://eslint.org/docs/rules/func-names
'func-names': 'off',

// We use `const var = function expression` in tests to wrap functions that we expect to throw an error
'func-style': 'off',

Expand Down
124 changes: 0 additions & 124 deletions rules/mocha.js

This file was deleted.

0 comments on commit 085d926

Please sign in to comment.