1
1
mirror of https://github.com/theoludwig/eslint-config-conventions.git synced 2025-05-18 12:02:33 +02:00

Compare commits

..

23 Commits

Author SHA1 Message Date
08602b1c53 build(deps): update latest
BREAKING CHANGE: peerDependencies: `eslint-plugin-unicorn@^46.0.0`
2023-04-02 20:53:26 +02:00
1779517f5c feat: add @typescript-eslint/ban-types
BREAKING CHANGE: New rule introduced
2023-02-06 23:52:11 +01:00
81b37b523c feat: add import/no-empty-named-blocks
BREAKING CHANGE: New rule introduced
2023-02-06 23:48:24 +01:00
a95ac7ec8b fix: relax @typescript-eslint/consistent-type-assertions 2023-02-06 23:43:23 +01:00
32481c316f fix: relax no-unused-vars ignore variable starting with _ 2023-02-06 23:42:09 +01:00
c3ddbc73b7 feat: add no-empty-static-block
Ref: https://eslint.org/docs/latest/rules/no-empty-static-block

BREAKING CHANGE: New rule introduced
2023-02-06 23:37:55 +01:00
1934d3525a feat: add no-new-native-nonconstructor
Ref: https://eslint.org/docs/latest/rules/no-new-native-nonconstructor

BREAKING CHANGE: New rule introduced
2023-02-06 23:36:21 +01:00
4f625c3b88 build(deps): update latest
BREAKING CHANGE: peerDependencies:
`eslint@^8.33.0`, `eslint-plugin-import@^2.27.5`,
`eslint-plugin-promise@^6.1.1`, `eslint-plugin-unicorn@^45.0.2`
2023-02-06 23:33:28 +01:00
e24964a60a build(deps): update latest 2023-01-10 13:27:35 +01:00
fcc107bdec fix: relax @typescript-eslint/prefer-optional-chain 2022-11-21 09:09:06 +01:00
666a3dee2d feat: add unicorn/no-typeof-undefined
BREAKING CHANGE: New rule introduced

BREAKING CHANGE: peerDependencies: `eslint-plugin-unicorn@^45.0.0`
2022-11-21 09:08:19 +01:00
0ce46310ed build(deps): update latest
BREAKING CHANGE: peerDependencies: `eslint-plugin-unicorn@^44.0.0`
2022-10-03 20:40:47 +02:00
e2b2c1c77f docs: fix typo 2022-09-20 23:08:10 +02:00
846a25943d perf: reduce package size by publishing only needed files 2022-09-01 01:17:47 +02:00
e0f93343fe test: fix with new rules introduced 2022-08-31 14:00:08 +02:00
c3b46debe6 feat: add @typescript-eslint/consistent-type-imports
Ref: https://typescript-eslint.io/rules/consistent-type-imports

BREAKING CHANGE: New rule introduced
2022-08-31 13:56:16 +02:00
c0ec89ed0c feat: add prefer-arrow-callback
Ref: https://eslint.org/docs/latest/rules/prefer-arrow-callback

BREAKING CHANGE: New rule introduced
2022-08-31 13:49:03 +02:00
099a3388a1 feat: add func-style: "expression"
Ref: https://eslint.org/docs/latest/rules/func-style

BREAKING CHANGE: New rule introduced
2022-08-31 13:44:54 +02:00
1f20fe89e8 fix: relax @typescript-eslint/no-empty-interface 2022-08-31 13:32:05 +02:00
3f1d1921ba feat: add arrow-body-style: "always"
Ref: https://eslint.org/docs/latest/rules/arrow-body-style

BREAKING CHANGE: New rule introduced
2022-08-31 13:27:37 +02:00
b743c94430 feat: add arrow-parens: "always"
Ref: https://eslint.org/docs/latest/rules/arrow-parens

BREAKING CHANGE: New rule introduced
2022-08-31 13:25:38 +02:00
f138acaf53 feat: add curly: "all"
Ref: https://eslint.org/docs/latest/rules/curly

BREAKING CHANGE: New rule introduced
2022-08-31 13:22:20 +02:00
435d3e9e5f build(deps): update latest 2022-08-31 13:17:00 +02:00
13 changed files with 3544 additions and 11283 deletions

View File

@ -34,6 +34,7 @@
"no-duplicate-imports": "error",
"no-empty-character-class": "error",
"no-empty-pattern": "error",
"no-empty-static-block": "error",
"no-ex-assign": "error",
"no-fallthrough": "error",
"no-func-assign": "error",
@ -42,6 +43,7 @@
"no-irregular-whitespace": "error",
"no-loss-of-precision": "error",
"no-misleading-character-class": "error",
"no-new-native-nonconstructor": "error",
"no-new-symbol": "error",
"no-obj-calls": "error",
"no-promise-executor-return": "error",
@ -59,7 +61,7 @@
"no-unsafe-negation": "error",
"no-unsafe-optional-chaining": "error",
"no-unused-private-class-members": "error",
"no-unused-vars": "error",
"no-unused-vars": ["error", { "varsIgnorePattern": "^_" }],
"no-use-before-define": [
"error",
{
@ -145,6 +147,11 @@
"quote-props": ["error", "as-needed"],
"radix": "error",
"yoda": ["error", "never"],
"curly": ["error", "all"],
"func-style": ["error", "expression"],
"prefer-arrow-callback": "error",
"arrow-parens": ["error", "always"],
"arrow-body-style": ["error", "always"],
"import/no-absolute-path": "error",
"import/no-webpack-loader-syntax": "error",
@ -161,6 +168,7 @@
}
],
"import/no-named-default": "error",
"import/no-empty-named-blocks": "error",
"promise/param-names": "error",
"promise/no-new-statics": "error",
@ -176,7 +184,8 @@
"unicorn/no-this-assignment": "error",
"unicorn/no-zero-fractions": "error",
"unicorn/prefer-node-protocol": "error",
"unicorn/throw-new-error": "error"
"unicorn/throw-new-error": "error",
"unicorn/no-typeof-undefined": "error"
},
"overrides": [
{
@ -192,7 +201,10 @@
"no-loss-of-precision": "off",
"@typescript-eslint/no-loss-of-precision": "error",
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": "error",
"@typescript-eslint/no-unused-vars": [
"error",
{ "varsIgnorePattern": "^_" }
],
"no-use-before-define": "off",
"@typescript-eslint/no-use-before-define": [
"error",
@ -236,17 +248,12 @@
"error",
{ "default": "array-simple" }
],
"@typescript-eslint/consistent-type-assertions": [
"error",
{
"assertionStyle": "as",
"objectLiteralTypeAssertions": "never"
}
],
"@typescript-eslint/ban-types": "error",
"@typescript-eslint/consistent-type-definitions": [
"error",
"interface"
],
"@typescript-eslint/consistent-type-imports": "error",
"@typescript-eslint/explicit-function-return-type": [
"error",
{
@ -275,10 +282,6 @@
],
"@typescript-eslint/no-base-to-string": "error",
"@typescript-eslint/no-dynamic-delete": "error",
"@typescript-eslint/no-empty-interface": [
"error",
{ "allowSingleExtends": true }
],
"@typescript-eslint/no-extra-non-null-assertion": "error",
"@typescript-eslint/no-extraneous-class": [
"error",
@ -306,7 +309,6 @@
"ignoreMixedLogicalExpressions": false
}
],
"@typescript-eslint/prefer-optional-chain": "error",
"@typescript-eslint/prefer-readonly": "error",
"@typescript-eslint/prefer-reduce-type-parameter": "error",
"@typescript-eslint/prefer-ts-expect-error": "error",

View File

@ -10,10 +10,10 @@ jobs:
lint:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.0.0'
- uses: 'actions/checkout@v3.5.0'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: 'lts/*'
cache: 'npm'
@ -24,5 +24,5 @@ jobs:
- run: 'npm run lint:commit -- --to "${{ github.sha }}"'
- run: 'npm run lint:editorconfig'
- run: 'npm run lint:markdown'
- run: 'npm run lint:javascript'
- run: 'npm run lint:eslint'
- run: 'npm run lint:prettier'

View File

@ -8,13 +8,13 @@ jobs:
release:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.0.0'
- uses: 'actions/checkout@v3.5.0'
with:
fetch-depth: 0
persist-credentials: false
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: 'lts/*'
cache: 'npm'

View File

@ -10,10 +10,10 @@ jobs:
test:
runs-on: 'ubuntu-latest'
steps:
- uses: 'actions/checkout@v3.0.0'
- uses: 'actions/checkout@v3.5.0'
- name: 'Use Node.js'
uses: 'actions/setup-node@v3.1.0'
uses: 'actions/setup-node@v3.6.0'
with:
node-version: 'lts/*'
cache: 'npm'

View File

@ -2,5 +2,5 @@
"*": ["editorconfig-checker"],
"*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
"*.{json,jsonc,yml,yaml}": ["prettier --write"],
"*.{md,mdx}": ["prettier --write", "markdownlint --dot --fix"]
"*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
}

5
.markdownlint-cli2.jsonc Normal file
View File

@ -0,0 +1,5 @@
{
"globs": ["**/*.{md,mdx}"],
"ignores": ["**/node_modules"],
"customRules": ["markdownlint-rule-relative-links"]
}

View File

@ -1,6 +1,7 @@
{
"default": true,
"MD013": false,
"relative-links": true,
"extends": "markdownlint/style/prettier",
"MD033": false,
"MD041": false
}

View File

@ -23,7 +23,7 @@
**eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality, it is highly inspired from [eslint-config-standard-with-typescript](https://github.com/standard/eslint-config-standard-with-typescript) but it is **stricter** and with **no formatting rules**, **only code-quality rules**. It supports both **JavaScript** and **TypeScript**.
This configuration is mostly **for catching bugs** and **code-quality** so it is recommanded to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration.
This configuration is mostly **for catching bugs** and **code-quality** so it is recommended to use it with [Prettier](https://prettier.io/) for a consistent code style, it works with any `.prettierrc.json` configuration.
More information about **formatting rules** vs **code-quality rules** can be found on [Prettier vs. Linters](https://prettier.io/docs/en/comparison.html).
@ -40,10 +40,10 @@ Here is an example, but use it only for reference, because your decisions regard
```sh
npm install --save-dev \
eslint@^8.9.0 \
eslint-plugin-import@^2.26.0 \
eslint-plugin-promise@^6.0.0 \
eslint-plugin-unicorn@^43.0.0 \
eslint@^8.33.0 \
eslint-plugin-import@^2.27.5 \
eslint-plugin-promise@^6.1.1 \
eslint-plugin-unicorn@^46.0.0 \
eslint-config-conventions@latest
```
@ -62,9 +62,9 @@ If you want to use **TypeScript**, you also need to install:
```sh
npm install --save-dev \
typescript@^4.6.0 \
@typescript-eslint/eslint-plugin@^5.18.0 \
@typescript-eslint/parser@^5.18.0
typescript@^5.0.3 \
@typescript-eslint/eslint-plugin@^5.57.0 \
@typescript-eslint/parser@^5.57.0
```
Dependencies are:
@ -109,7 +109,7 @@ echo {}> .prettierrc.json
```jsonc
{
"scripts": {
"lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
"lint:eslint": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\""
}
}
@ -118,9 +118,9 @@ echo {}> .prettierrc.json
### Usage
```sh
npm run lint:typescript
npm run lint:eslint
# or to apply automatic fixes to code
npm run lint:typescript -- --fix
npm run lint:eslint -- --fix
# Validate code formatting in all supported languages by Prettier
npm run lint:prettier

14679
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -23,6 +23,10 @@
"conventions"
],
"main": "index.js",
"files": [
"index.js",
".eslintrc.json"
],
"engines": {
"node": ">=16.0.0",
"npm": ">=8.0.0"
@ -30,8 +34,8 @@
"scripts": {
"lint:commit": "commitlint",
"lint:editorconfig": "editorconfig-checker",
"lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
"lint:javascript": "eslint \"**/*.{js,jsx,ts,tsx}\" -c \"eslintrc.json\"",
"lint:markdown": "markdownlint-cli2",
"lint:eslint": "eslint \"**/*.{js,jsx,ts,tsx}\" -c \"eslintrc.json\"",
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
"lint:staged": "lint-staged",
"test": "tap",
@ -41,30 +45,32 @@
"postpublish": "pinst --enable"
},
"peerDependencies": {
"eslint": "^8.9.0",
"eslint-plugin-import": "^2.26.0",
"eslint-plugin-promise": "^6.0.0",
"eslint-plugin-unicorn": "^43.0.0"
"eslint": "^8.33.0",
"eslint-plugin-import": "^2.27.5",
"eslint-plugin-promise": "^6.1.1",
"eslint-plugin-unicorn": "^46.0.0"
},
"devDependencies": {
"@commitlint/cli": "17.0.3",
"@commitlint/config-conventional": "17.0.3",
"@types/eslint": "8.4.5",
"@types/tap": "15.0.7",
"@typescript-eslint/eslint-plugin": "5.30.6",
"@typescript-eslint/parser": "5.30.6",
"editorconfig-checker": "4.0.2",
"eslint": "8.19.0",
"eslint-plugin-import": "2.26.0",
"eslint-plugin-promise": "6.0.0",
"eslint-plugin-unicorn": "43.0.1",
"husky": "8.0.1",
"lint-staged": "13.0.3",
"markdownlint-cli": "0.31.1",
"@commitlint/cli": "17.5.1",
"@commitlint/config-conventional": "17.4.4",
"@tsconfig/strictest": "2.0.0",
"@types/eslint": "8.37.0",
"@types/tap": "15.0.8",
"@typescript-eslint/eslint-plugin": "5.57.0",
"@typescript-eslint/parser": "5.57.0",
"editorconfig-checker": "5.0.1",
"eslint": "8.37.0",
"eslint-plugin-import": "2.27.5",
"eslint-plugin-promise": "6.1.1",
"eslint-plugin-unicorn": "46.0.0",
"husky": "8.0.3",
"lint-staged": "13.2.0",
"markdownlint-cli2": "0.6.0",
"markdownlint-rule-relative-links": "1.1.1",
"pinst": "3.0.0",
"prettier": "2.7.1",
"semantic-release": "19.0.3",
"tap": "16.3.0",
"typescript": "4.7.4"
"prettier": "2.8.7",
"semantic-release": "21.0.1",
"tap": "16.3.4",
"typescript": "5.0.3"
}
}

View File

@ -2,13 +2,13 @@ const tap = require('tap')
const config = require('../index.js')
const isObject = (object) => {
return typeof object === 'object' && object !== null
}
tap.test('test basic properties of config', async (t) => {
t.ok(isObject(config.parserOptions))
t.ok(isObject(config.env))
t.ok(isObject(config.rules))
t.ok(isObject(config.overrides))
})
function isObject(object) {
return typeof object === 'object' && object !== null
}

View File

@ -1,3 +1,3 @@
const foo = await 1
const bar = function () {}
const bar = () => {}
await bar(foo)

View File

@ -1,12 +1,10 @@
{
"extends": "@tsconfig/strictest/tsconfig.json",
"compilerOptions": {
"target": "ESNext",
"module": "commonjs",
"lib": ["ESNext"],
"moduleResolution": "node",
"rootDir": "./",
"strict": true,
"skipLibCheck": true,
"esModuleInterop": true
"rootDir": "./"
}
}