mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-05-18 12:02:33 +02:00
Compare commits
33 Commits
v13.1.0
...
b4de437548
Author | SHA1 | Date | |
---|---|---|---|
b4de437548
|
|||
c751162403
|
|||
152ccba986
|
|||
10b5a0d8df
|
|||
815518c613
|
|||
860873aa4b
|
|||
5eacace152
|
|||
0dcde0af51
|
|||
b0fa907559
|
|||
d15df84a73
|
|||
aa4da3f6e8
|
|||
b180eae455
|
|||
31b226ffa4
|
|||
8403ef4254
|
|||
dbe252f3b4
|
|||
6e6a8d7aa1
|
|||
256a5024d6
|
|||
3d2e708e96
|
|||
b0f6ef585f
|
|||
7abcc179e5
|
|||
b72745bdbe
|
|||
89c012cac2
|
|||
00b7a2a89b
|
|||
a5036c8381
|
|||
c9365be768
|
|||
c1a524e31b
|
|||
8585574a70
|
|||
fce826e24a
|
|||
17e90bcc35
|
|||
dab4433431
|
|||
b671018a00
|
|||
17dea937eb
|
|||
7f3c152e61
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"root": true,
|
||||
"plugins": ["import", "promise", "unicorn"],
|
||||
"plugins": ["promise", "unicorn"],
|
||||
"env": {
|
||||
"browser": true,
|
||||
"node": true,
|
||||
@ -22,6 +22,7 @@
|
||||
"no-compare-neg-zero": "error",
|
||||
"no-cond-assign": "error",
|
||||
"no-const-assign": "error",
|
||||
"no-constant-binary-expression": "error",
|
||||
"no-constant-condition": "error",
|
||||
"no-constructor-return": "error",
|
||||
"no-control-regex": "error",
|
||||
@ -34,7 +35,6 @@
|
||||
"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",
|
||||
@ -51,6 +51,7 @@
|
||||
"no-self-assign": "error",
|
||||
"no-self-compare": "error",
|
||||
"no-setter-return": "error",
|
||||
"no-sparse-arrays": "error",
|
||||
"no-this-before-super": "error",
|
||||
"no-undef": "error",
|
||||
"no-unexpected-multiline": "error",
|
||||
@ -95,6 +96,7 @@
|
||||
"no-confusing-arrow": "error",
|
||||
"no-delete-var": "error",
|
||||
"no-empty": ["error", { "allowEmptyCatch": true }],
|
||||
"no-empty-static-block": "error",
|
||||
"no-eval": "error",
|
||||
"no-floating-decimal": "error",
|
||||
"no-global-assign": "error",
|
||||
@ -130,13 +132,15 @@
|
||||
}
|
||||
],
|
||||
"no-useless-call": "error",
|
||||
"no-useless-concat": "error",
|
||||
"no-useless-computed-key": "error",
|
||||
"no-useless-constructor": "error",
|
||||
"no-useless-escape": "error",
|
||||
"no-useless-rename": "error",
|
||||
"no-useless-return": "error",
|
||||
"no-else-return": ["error", { "allowElseIf": false }],
|
||||
"no-var": "error",
|
||||
"no-void": "error",
|
||||
"no-void": ["error", { "allowAsStatement": true }],
|
||||
"no-with": "error",
|
||||
"object-shorthand": ["error", "properties"],
|
||||
"one-var": ["error", { "initialized": "never" }],
|
||||
@ -153,25 +157,10 @@
|
||||
"arrow-parens": ["error", "always"],
|
||||
"arrow-body-style": ["error", "always"],
|
||||
|
||||
"import/no-absolute-path": "error",
|
||||
"import/no-webpack-loader-syntax": "error",
|
||||
"import/no-self-import": "error",
|
||||
"import/no-useless-path-segments": "error",
|
||||
"import/export": "error",
|
||||
"import/first": "error",
|
||||
"import/no-duplicates": "error",
|
||||
"import/order": [
|
||||
"error",
|
||||
{
|
||||
"groups": ["builtin", "external", "internal"],
|
||||
"newlines-between": "always"
|
||||
}
|
||||
],
|
||||
"import/no-named-default": "error",
|
||||
"import/no-empty-named-blocks": "error",
|
||||
|
||||
"promise/param-names": "error",
|
||||
"promise/no-new-statics": "error",
|
||||
"promise/no-multiple-resolved": "error",
|
||||
"promise/no-nesting": "error",
|
||||
|
||||
"unicorn/better-regex": "error",
|
||||
"unicorn/catch-error-name": "error",
|
||||
@ -254,6 +243,7 @@
|
||||
],
|
||||
"no-useless-constructor": "off",
|
||||
"@typescript-eslint/no-useless-constructor": "error",
|
||||
"@typescript-eslint/no-useless-template-literals": "error",
|
||||
|
||||
"@typescript-eslint/adjacent-overload-signatures": "error",
|
||||
"@typescript-eslint/array-type": [
|
||||
@ -276,13 +266,6 @@
|
||||
"allowDirectConstAssertionInArrowFunctions": true
|
||||
}
|
||||
],
|
||||
"@typescript-eslint/member-delimiter-style": [
|
||||
"error",
|
||||
{
|
||||
"multiline": { "delimiter": "none" },
|
||||
"singleline": { "delimiter": "comma", "requireLast": false }
|
||||
}
|
||||
],
|
||||
"@typescript-eslint/method-signature-style": "error",
|
||||
"@typescript-eslint/naming-convention": [
|
||||
"error",
|
||||
@ -313,8 +296,12 @@
|
||||
"@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
|
||||
"@typescript-eslint/no-unnecessary-type-assertion": "error",
|
||||
"@typescript-eslint/no-var-requires": "error",
|
||||
"@typescript-eslint/no-require-imports": "error",
|
||||
"@typescript-eslint/no-unsafe-unary-minus": "error",
|
||||
"@typescript-eslint/no-array-delete": "error",
|
||||
"@typescript-eslint/prefer-as-const": "error",
|
||||
"@typescript-eslint/prefer-function-type": "error",
|
||||
"@typescript-eslint/prefer-find": "error",
|
||||
"@typescript-eslint/prefer-includes": "error",
|
||||
"@typescript-eslint/prefer-nullish-coalescing": [
|
||||
"error",
|
||||
@ -328,6 +315,8 @@
|
||||
"@typescript-eslint/prefer-reduce-type-parameter": "error",
|
||||
"@typescript-eslint/prefer-ts-expect-error": "error",
|
||||
"@typescript-eslint/promise-function-async": "error",
|
||||
"prefer-promise-reject-errors": "off",
|
||||
"@typescript-eslint/prefer-promise-reject-errors": "error",
|
||||
"@typescript-eslint/require-array-sort-compare": [
|
||||
"error",
|
||||
{ "ignoreStringArrays": true }
|
||||
|
6
.github/workflows/lint.yml
vendored
6
.github/workflows/lint.yml
vendored
@ -4,16 +4,16 @@ on:
|
||||
push:
|
||||
branches: [develop]
|
||||
pull_request:
|
||||
branches: [master, develop]
|
||||
branches: [main, develop]
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.1.1"
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.1"
|
||||
uses: "actions/setup-node@v4.0.3"
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
6
.github/workflows/release.yml
vendored
6
.github/workflows/release.yml
vendored
@ -2,7 +2,7 @@ name: "Release"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master]
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
release:
|
||||
@ -13,13 +13,13 @@ jobs:
|
||||
pull-requests: "write"
|
||||
id-token: "write"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.1.1"
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.1"
|
||||
uses: "actions/setup-node@v4.0.3"
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
6
.github/workflows/test.yml
vendored
6
.github/workflows/test.yml
vendored
@ -4,16 +4,16 @@ on:
|
||||
push:
|
||||
branches: [develop]
|
||||
pull_request:
|
||||
branches: [master, develop]
|
||||
branches: [main, develop]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.1.1"
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.1"
|
||||
uses: "actions/setup-node@v4.0.3"
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
@ -1,4 +1,3 @@
|
||||
#!/bin/sh
|
||||
. "$(dirname "$0")/_/husky.sh"
|
||||
#!/usr/bin/env sh
|
||||
|
||||
npm run lint:commit -- --edit
|
||||
|
@ -1,5 +1,4 @@
|
||||
#!/bin/sh
|
||||
. "$(dirname "$0")/_/husky.sh"
|
||||
#!/usr/bin/env sh
|
||||
|
||||
npm run lint:staged
|
||||
npm run test
|
||||
|
@ -1,6 +1,7 @@
|
||||
{
|
||||
"*": ["editorconfig-checker"],
|
||||
"*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
|
||||
"*.{json,jsonc,yml,yaml}": ["prettier --write"],
|
||||
"*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
|
||||
"**/*": ["editorconfig-checker", "prettier --write --ignore-unknown"],
|
||||
"**/*.md": ["markdownlint-cli2 --fix --no-globs"],
|
||||
"**/*.{js,jsx,ts,tsx}": [
|
||||
"eslint --fix --max-warnings 0 --report-unused-disable-directives"
|
||||
]
|
||||
}
|
||||
|
@ -1,11 +1,11 @@
|
||||
{
|
||||
"config": {
|
||||
"extends": "markdownlint/style/prettier",
|
||||
"relative-links": true,
|
||||
"default": true,
|
||||
"MD033": false
|
||||
"relative-links": true,
|
||||
"no-inline-html": false,
|
||||
},
|
||||
"globs": ["**/*.{md,mdx}"],
|
||||
"globs": ["**/*.md"],
|
||||
"ignores": ["**/node_modules"],
|
||||
"customRules": ["markdownlint-rule-relative-links"]
|
||||
"customRules": ["markdownlint-rule-relative-links"],
|
||||
}
|
||||
|
@ -1,5 +1,5 @@
|
||||
{
|
||||
"branches": ["master"],
|
||||
"branches": ["main", { "name": "beta", "prerelease": true }],
|
||||
"plugins": [
|
||||
[
|
||||
"@semantic-release/commit-analyzer",
|
||||
|
4
LICENSE
4
LICENSE
@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
# MIT License
|
||||
|
||||
Copyright (c) Théo LUDWIG
|
||||
Copyright (c) Théo LUDWIG <contact@theoludwig.fr>
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
78
README.md
78
README.md
@ -4,10 +4,8 @@
|
||||
<strong><a href="https://eslint.org/docs/developer-guide/shareable-configs">ESLint shareable config</a> to enforce strict conventions and good code quality.</strong>
|
||||
</p>
|
||||
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="Contributing" /></a>
|
||||
<a href="./CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="CONTRIBUTING" /></a>
|
||||
<a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></a>
|
||||
<a href="./CODE_OF_CONDUCT.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg" alt="Contributor Covenant" /></a>
|
||||
<br />
|
||||
@ -21,7 +19,7 @@
|
||||
|
||||
## 📜 About
|
||||
|
||||
**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**.
|
||||
**eslint-config-conventions** is a [ESLint](https://eslint.org) configuration to enforce strict conventions and good code quality. It supports both **JavaScript** and **TypeScript**.
|
||||
|
||||
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.
|
||||
|
||||
@ -37,29 +35,29 @@ More information about **formatting rules** vs **code-quality rules** can be fou
|
||||
|
||||
```sh
|
||||
npm install --save-dev \
|
||||
eslint@^8.53.0 \
|
||||
eslint-plugin-import@^2.29.0 \
|
||||
eslint@^8.56.0 \
|
||||
eslint-plugin-promise@^6.1.1 \
|
||||
eslint-plugin-unicorn@^50.0.0 \
|
||||
eslint-plugin-unicorn@^53.0.0 \
|
||||
eslint-config-conventions@latest
|
||||
```
|
||||
|
||||
This list of dependencies are:
|
||||
Dependencies are:
|
||||
|
||||
- [ESLint](https://github.com/eslint/eslint)
|
||||
- 3 [ESLint Plugins](https://eslint.org/docs/user-guide/configuring/plugins)
|
||||
- [eslint-plugin-import](https://github.com/import-js/eslint-plugin-import)
|
||||
- [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise)
|
||||
- [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
|
||||
- This package: `eslint-config-conventions`
|
||||
|
||||
#### Installation with TypeScript
|
||||
|
||||
If you want to use **TypeScript**, you also need to install:
|
||||
|
||||
```sh
|
||||
npm install --save-dev \
|
||||
typescript@^5.2.2 \
|
||||
@typescript-eslint/eslint-plugin@^6.11.0 \
|
||||
@typescript-eslint/parser@^6.11.0
|
||||
"typescript@^5.3.3" \
|
||||
"@typescript-eslint/eslint-plugin@>=6.21.0" \
|
||||
"@typescript-eslint/parser@>=6.21.0"
|
||||
```
|
||||
|
||||
Dependencies are:
|
||||
@ -68,41 +66,53 @@ Dependencies are:
|
||||
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint): ESLint rules for TypeScript.
|
||||
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint): ESLint parser for TypeScript.
|
||||
|
||||
### Configuration with [Prettier](https://prettier.io/) (recommended)
|
||||
### Configuration
|
||||
|
||||
You will need to install some dependencies in addition to those required:
|
||||
#### `.eslintrc.json` (JavaScript)
|
||||
|
||||
```json
|
||||
{
|
||||
"extends": ["conventions"],
|
||||
"plugins": ["import", "promise", "unicorn"]
|
||||
}
|
||||
```
|
||||
|
||||
#### `.eslintrc.json` (TypeScript)
|
||||
|
||||
```json
|
||||
{
|
||||
"extends": ["conventions"],
|
||||
"plugins": ["import", "promise", "unicorn"],
|
||||
"overrides": [
|
||||
{
|
||||
"files": ["*.ts", "*.tsx"],
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"plugins": ["@typescript-eslint"],
|
||||
"parserOptions": {
|
||||
"project": "./tsconfig.json"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
#### Configuration with [Prettier](https://prettier.io/) (recommended)
|
||||
|
||||
```sh
|
||||
npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
|
||||
npm install --save-dev prettier
|
||||
|
||||
# Create an empty config file to let editors and other tools know you are using Prettier
|
||||
# You can personalize it with your own rules
|
||||
echo "{}" > .prettierrc.json
|
||||
```
|
||||
|
||||
#### `.eslintrc.json`
|
||||
That's all! No need to update the `.eslintrc.json` configuration.
|
||||
|
||||
```json
|
||||
{
|
||||
"extends": ["conventions", "prettier"],
|
||||
"plugins": ["prettier"],
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"parserOptions": {
|
||||
"project": "./tsconfig.json"
|
||||
},
|
||||
"rules": {
|
||||
"prettier/prettier": "error"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Note:** Please read some important instructions regarding the `project` option [here](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/parser/README.md#configuration).
|
||||
|
||||
`"parserOptions.project"` is only required if you use **TypeScript**.
|
||||
We discourage usage of [eslint-config-prettier](https://github.com/prettier/eslint-config-prettier) and [eslint-plugin-prettier](https://github.com/prettier/eslint-plugin-prettier), as `eslint-config-conventions` doesn't include any stylistic rules, and including these packages has several drawbacks (listed in [Integrating with Linters](https://prettier.io/docs/en/integrating-with-linters.html)) and brings no benefits for this configuration.
|
||||
|
||||
#### `package.json`
|
||||
|
||||
```jsonc
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
|
||||
|
6674
package-lock.json
generated
6674
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
49
package.json
49
package.json
@ -32,8 +32,7 @@
|
||||
"provenance": true
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18.0.0",
|
||||
"npm": ">=9.0.0"
|
||||
"node": ">=18.0.0"
|
||||
},
|
||||
"scripts": {
|
||||
"lint:commit": "commitlint",
|
||||
@ -42,38 +41,36 @@
|
||||
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json",
|
||||
"lint:prettier": "prettier . --check",
|
||||
"lint:staged": "lint-staged",
|
||||
"test": "node --test test/",
|
||||
"test": "node --test",
|
||||
"release": "semantic-release",
|
||||
"postinstall": "husky install",
|
||||
"postinstall": "husky",
|
||||
"prepublishOnly": "pinst --disable",
|
||||
"postpublish": "pinst --enable"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"eslint": "^8.53.0",
|
||||
"eslint-plugin-import": "^2.29.0",
|
||||
"eslint": "^8.56.0",
|
||||
"eslint-plugin-promise": "^6.1.1",
|
||||
"eslint-plugin-unicorn": "^49.0.0 || ^50.0.0"
|
||||
"eslint-plugin-unicorn": "^51.0.1 || ^52.0.0 || ^53.0.0 || ^54.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "18.4.3",
|
||||
"@commitlint/config-conventional": "18.4.3",
|
||||
"@tsconfig/strictest": "2.0.2",
|
||||
"@types/eslint": "8.56.0",
|
||||
"@types/node": "20.10.5",
|
||||
"@typescript-eslint/eslint-plugin": "6.15.0",
|
||||
"@typescript-eslint/parser": "6.15.0",
|
||||
"editorconfig-checker": "5.1.2",
|
||||
"eslint": "8.56.0",
|
||||
"eslint-plugin-import": "2.29.1",
|
||||
"eslint-plugin-promise": "6.1.1",
|
||||
"eslint-plugin-unicorn": "50.0.1",
|
||||
"husky": "8.0.3",
|
||||
"lint-staged": "15.2.0",
|
||||
"markdownlint-cli2": "0.11.0",
|
||||
"markdownlint-rule-relative-links": "2.1.1",
|
||||
"@commitlint/cli": "19.2.2",
|
||||
"@commitlint/config-conventional": "19.2.2",
|
||||
"@tsconfig/strictest": "2.0.5",
|
||||
"@types/eslint": "8.56.10",
|
||||
"@types/node": "20.14.10",
|
||||
"@typescript-eslint/eslint-plugin": "7.16.0",
|
||||
"@typescript-eslint/parser": "7.16.0",
|
||||
"editorconfig-checker": "5.1.8",
|
||||
"eslint": "8.57.0",
|
||||
"eslint-plugin-promise": "6.4.0",
|
||||
"eslint-plugin-unicorn": "54.0.0",
|
||||
"husky": "9.0.11",
|
||||
"lint-staged": "15.2.7",
|
||||
"markdownlint-cli2": "0.13.0",
|
||||
"markdownlint-rule-relative-links": "3.0.0",
|
||||
"pinst": "3.0.0",
|
||||
"prettier": "3.1.1",
|
||||
"semantic-release": "22.0.12",
|
||||
"typescript": "5.3.3"
|
||||
"prettier": "3.3.2",
|
||||
"semantic-release": "23.1.1",
|
||||
"typescript": "5.5.3"
|
||||
}
|
||||
}
|
||||
|
3
test/fixtures/typescript-no-errors-ignore-promise.ts
vendored
Normal file
3
test/fixtures/typescript-no-errors-ignore-promise.ts
vendored
Normal file
@ -0,0 +1,3 @@
|
||||
const returnsPromise = async (): Promise<void> => {}
|
||||
|
||||
void returnsPromise()
|
@ -37,3 +37,10 @@ test("ensure we allow top-level await", async () => {
|
||||
)
|
||||
assert.strictEqual(lintResult?.errorCount, 0)
|
||||
})
|
||||
|
||||
test("ensure we allow to ignore floating promise with void operator (@typescript-eslint/no-floating-promises)", async () => {
|
||||
const [lintResult] = await eslint.lintFiles(
|
||||
"test/fixtures/typescript-no-errors-ignore-promise.ts",
|
||||
)
|
||||
assert.strictEqual(lintResult?.errorCount, 0)
|
||||
})
|
||||
|
Reference in New Issue
Block a user