mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-05-18 12:02:33 +02:00
Compare commits
15 Commits
Author | SHA1 | Date | |
---|---|---|---|
19f74fc6a2
|
|||
bcd9fe10d3
|
|||
c2147dbc7a
|
|||
e6a222d01f
|
|||
eac273c076
|
|||
0df1b867a4 | |||
92e6e56884
|
|||
305df380aa
|
|||
8b3d9109d7
|
|||
d0fa4e3688
|
|||
9fa86e2133
|
|||
6cb7af3a05
|
|||
b4de437548
|
|||
c751162403
|
|||
152ccba986
|
@ -1 +0,0 @@
|
||||
{ "extends": ["@commitlint/config-conventional"] }
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"root": true,
|
||||
"plugins": ["import", "promise", "unicorn"],
|
||||
"plugins": ["promise", "unicorn"],
|
||||
"env": {
|
||||
"browser": true,
|
||||
"node": true,
|
||||
@ -93,25 +93,12 @@
|
||||
],
|
||||
"no-array-constructor": "error",
|
||||
"no-caller": "error",
|
||||
"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",
|
||||
"no-implied-eval": "error",
|
||||
"no-mixed-operators": [
|
||||
"error",
|
||||
{
|
||||
"groups": [
|
||||
["==", "!=", "===", "!==", ">", ">=", "<", "<="],
|
||||
["&&", "||"],
|
||||
["in", "instanceof"]
|
||||
],
|
||||
"allowSamePrecedence": true
|
||||
}
|
||||
],
|
||||
"no-multi-str": "error",
|
||||
"no-new-func": "error",
|
||||
"no-object-constructor": "error",
|
||||
@ -142,39 +129,20 @@
|
||||
"no-var": "error",
|
||||
"no-void": ["error", { "allowAsStatement": true }],
|
||||
"no-with": "error",
|
||||
"no-return-await": "error",
|
||||
"object-shorthand": ["error", "properties"],
|
||||
"one-var": ["error", { "initialized": "never" }],
|
||||
"prefer-const": ["error", { "destructuring": "all" }],
|
||||
"prefer-object-has-own": "error",
|
||||
"prefer-promise-reject-errors": "error",
|
||||
"prefer-regex-literals": ["error", { "disallowRedundantWrapping": true }],
|
||||
"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",
|
||||
"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",
|
||||
"import/no-anonymous-default-export": "error",
|
||||
|
||||
"promise/param-names": "error",
|
||||
"promise/no-new-statics": "error",
|
||||
"promise/no-multiple-resolved": "error",
|
||||
@ -206,6 +174,7 @@
|
||||
"unicorn/require-array-join-separator": "error",
|
||||
"unicorn/prefer-number-properties": "error",
|
||||
"unicorn/prefer-modern-math-apis": "error",
|
||||
"unicorn/prefer-structured-clone": "error",
|
||||
"unicorn/template-indent": "error"
|
||||
},
|
||||
"overrides": [
|
||||
@ -217,8 +186,6 @@
|
||||
"no-undef": "off",
|
||||
"no-dupe-class-members": "off",
|
||||
"@typescript-eslint/no-dupe-class-members": "error",
|
||||
"no-loss-of-precision": "off",
|
||||
"@typescript-eslint/no-loss-of-precision": "error",
|
||||
"no-unused-vars": "off",
|
||||
"@typescript-eslint/no-unused-vars": [
|
||||
"error",
|
||||
@ -249,7 +216,7 @@
|
||||
{ "builtinGlobals": false }
|
||||
],
|
||||
"no-throw-literal": "off",
|
||||
"@typescript-eslint/no-throw-literal": "error",
|
||||
"@typescript-eslint/only-throw-error": "error",
|
||||
"no-unused-expressions": "off",
|
||||
"@typescript-eslint/no-unused-expressions": [
|
||||
"error",
|
||||
@ -261,14 +228,15 @@
|
||||
],
|
||||
"no-useless-constructor": "off",
|
||||
"@typescript-eslint/no-useless-constructor": "error",
|
||||
"@typescript-eslint/no-useless-template-literals": "error",
|
||||
"@typescript-eslint/no-unnecessary-template-expression": "error",
|
||||
|
||||
"@typescript-eslint/adjacent-overload-signatures": "error",
|
||||
"@typescript-eslint/array-type": [
|
||||
"error",
|
||||
{ "default": "array-simple" }
|
||||
],
|
||||
"@typescript-eslint/ban-types": "error",
|
||||
"@typescript-eslint/no-unsafe-function-type": "error",
|
||||
"@typescript-eslint/no-wrapper-object-types": "error",
|
||||
"@typescript-eslint/consistent-type-definitions": [
|
||||
"error",
|
||||
"interface"
|
||||
@ -313,7 +281,6 @@
|
||||
],
|
||||
"@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",
|
||||
@ -331,7 +298,7 @@
|
||||
],
|
||||
"@typescript-eslint/prefer-readonly": "error",
|
||||
"@typescript-eslint/prefer-reduce-type-parameter": "error",
|
||||
"@typescript-eslint/prefer-ts-expect-error": "error",
|
||||
"@typescript-eslint/prefer-return-this-type": "error",
|
||||
"@typescript-eslint/promise-function-async": "error",
|
||||
"prefer-promise-reject-errors": "off",
|
||||
"@typescript-eslint/prefer-promise-reject-errors": "error",
|
||||
@ -347,7 +314,8 @@
|
||||
"error",
|
||||
{ "allowNumber": true }
|
||||
],
|
||||
"@typescript-eslint/return-await": ["error", "always"],
|
||||
"no-return-await": "off",
|
||||
"@typescript-eslint/return-await": "error",
|
||||
"@typescript-eslint/strict-boolean-expressions": [
|
||||
"error",
|
||||
{
|
||||
@ -359,8 +327,7 @@
|
||||
"allowNullableNumber": false,
|
||||
"allowAny": false
|
||||
}
|
||||
],
|
||||
"@typescript-eslint/type-annotation-spacing": "error"
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
|
22
.github/workflows/lint.yml
vendored
22
.github/workflows/lint.yml
vendored
@ -10,19 +10,25 @@ jobs:
|
||||
lint:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.1.6"
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.2"
|
||||
uses: "actions/setup-node@v4.0.3"
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
|
||||
- name: "Install dependencies"
|
||||
run: "npm clean-install"
|
||||
|
||||
- run: 'npm run lint:commit -- --to "${{ github.sha }}"'
|
||||
- run: "npm run lint:editorconfig"
|
||||
- run: "npm run lint:markdown"
|
||||
- run: "npm run lint:eslint"
|
||||
- run: "npm run lint:prettier"
|
||||
- run: "node --run lint:editorconfig"
|
||||
- run: "node --run lint:markdown"
|
||||
- run: "node --run lint:eslint"
|
||||
- run: "node --run lint:prettier"
|
||||
|
||||
commitlint:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
|
||||
- uses: "wagoid/commitlint-github-action@v6.1.2"
|
||||
|
8
.github/workflows/release.yml
vendored
8
.github/workflows/release.yml
vendored
@ -13,15 +13,15 @@ jobs:
|
||||
pull-requests: "write"
|
||||
id-token: "write"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.1.6"
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.2"
|
||||
uses: "actions/setup-node@v4.0.3"
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
|
||||
- name: "Install dependencies"
|
||||
@ -31,7 +31,7 @@ jobs:
|
||||
run: "npm audit signatures"
|
||||
|
||||
- name: "Release"
|
||||
run: "npm run release"
|
||||
run: "node --run release"
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
8
.github/workflows/test.yml
vendored
8
.github/workflows/test.yml
vendored
@ -10,16 +10,16 @@ jobs:
|
||||
test:
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: "actions/checkout@v4.1.6"
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.2"
|
||||
uses: "actions/setup-node@v4.0.3"
|
||||
with:
|
||||
node-version: "lts/*"
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
|
||||
- name: "Install dependencies"
|
||||
run: "npm clean-install"
|
||||
|
||||
- name: "Test"
|
||||
run: "npm run test"
|
||||
run: "node --run test"
|
||||
|
@ -1,3 +0,0 @@
|
||||
#!/usr/bin/env sh
|
||||
|
||||
npm run lint:commit -- --edit
|
@ -1,4 +0,0 @@
|
||||
#!/usr/bin/env sh
|
||||
|
||||
npm run lint:staged
|
||||
npm run test
|
@ -1,7 +0,0 @@
|
||||
{
|
||||
"**/*": ["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"
|
||||
]
|
||||
}
|
4
.npmrc
4
.npmrc
@ -1,2 +1,2 @@
|
||||
save-exact=true
|
||||
provenance=true
|
||||
save-exact = true
|
||||
provenance = true
|
||||
|
@ -1,18 +1,8 @@
|
||||
{
|
||||
"branches": ["main", { "name": "beta", "prerelease": true }],
|
||||
"plugins": [
|
||||
[
|
||||
"@semantic-release/commit-analyzer",
|
||||
{
|
||||
"preset": "conventionalcommits"
|
||||
}
|
||||
],
|
||||
[
|
||||
"@semantic-release/release-notes-generator",
|
||||
{
|
||||
"preset": "conventionalcommits"
|
||||
}
|
||||
],
|
||||
"@semantic-release/commit-analyzer",
|
||||
"@semantic-release/release-notes-generator",
|
||||
"@semantic-release/npm",
|
||||
"@semantic-release/github"
|
||||
]
|
||||
|
8
.vscode/extensions.json
vendored
8
.vscode/extensions.json
vendored
@ -1,8 +0,0 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"editorconfig.editorconfig",
|
||||
"esbenp.prettier-vscode",
|
||||
"dbaeumer.vscode-eslint",
|
||||
"davidanson.vscode-markdownlint"
|
||||
]
|
||||
}
|
10
.vscode/settings.json
vendored
10
.vscode/settings.json
vendored
@ -1,10 +0,0 @@
|
||||
{
|
||||
"typescript.tsdk": "node_modules/typescript/lib",
|
||||
"typescript.preferences.importModuleSpecifierEnding": "js",
|
||||
"editor.defaultFormatter": "esbenp.prettier-vscode",
|
||||
"prettier.configPath": ".prettierrc.json",
|
||||
"editor.formatOnSave": true,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.fixAll": "explicit"
|
||||
}
|
||||
}
|
30
README.md
30
README.md
@ -35,18 +35,16 @@ More information about **formatting rules** vs **code-quality rules** can be fou
|
||||
|
||||
```sh
|
||||
npm install --save-dev \
|
||||
eslint@^8.56.0 \
|
||||
eslint-plugin-import@^2.29.1 \
|
||||
eslint-plugin-promise@^6.1.1 \
|
||||
eslint-plugin-unicorn@^53.0.0 \
|
||||
eslint@^8.57.0 \
|
||||
eslint-plugin-promise@^7.0.0 \
|
||||
eslint-plugin-unicorn@^55.0.0 \
|
||||
eslint-config-conventions@latest
|
||||
```
|
||||
|
||||
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 Plugins](https://eslint.org/docs/user-guide/configuring/plugins)
|
||||
- [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`
|
||||
@ -57,9 +55,9 @@ If you want to use **TypeScript**, you also need to install:
|
||||
|
||||
```sh
|
||||
npm install --save-dev \
|
||||
"typescript@^5.3.3" \
|
||||
"@typescript-eslint/eslint-plugin@>=6.21.0" \
|
||||
"@typescript-eslint/parser@>=6.21.0"
|
||||
"typescript@^5.6.2" \
|
||||
"@typescript-eslint/eslint-plugin@^8.0.0" \
|
||||
"@typescript-eslint/parser@^8.0.0"
|
||||
```
|
||||
|
||||
Dependencies are:
|
||||
@ -74,8 +72,9 @@ Dependencies are:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": true,
|
||||
"extends": ["conventions"],
|
||||
"plugins": ["import", "promise", "unicorn"]
|
||||
"plugins": ["promise", "unicorn"]
|
||||
}
|
||||
```
|
||||
|
||||
@ -83,15 +82,16 @@ Dependencies are:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": true,
|
||||
"extends": ["conventions"],
|
||||
"plugins": ["import", "promise", "unicorn"],
|
||||
"plugins": ["promise", "unicorn"],
|
||||
"overrides": [
|
||||
{
|
||||
"files": ["*.ts", "*.tsx"],
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"plugins": ["@typescript-eslint"],
|
||||
"parserOptions": {
|
||||
"project": "./tsconfig.json"
|
||||
"projectService": true
|
||||
}
|
||||
}
|
||||
]
|
||||
@ -126,12 +126,12 @@ We discourage usage of [eslint-config-prettier](https://github.com/prettier/esli
|
||||
### Usage
|
||||
|
||||
```sh
|
||||
npm run lint:eslint
|
||||
node --run lint:eslint
|
||||
# or to apply automatic fixes to code
|
||||
npm run lint:eslint -- --fix
|
||||
node --run lint:eslint -- --fix
|
||||
|
||||
# Validate code formatting in all supported languages by Prettier
|
||||
npm run lint:prettier
|
||||
node --run lint:prettier
|
||||
```
|
||||
|
||||
## 💡 Contributing
|
||||
|
4616
package-lock.json
generated
4616
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
45
package.json
45
package.json
@ -35,44 +35,31 @@
|
||||
"node": ">=18.0.0"
|
||||
},
|
||||
"scripts": {
|
||||
"lint:commit": "commitlint",
|
||||
"lint:editorconfig": "editorconfig-checker",
|
||||
"lint:markdown": "markdownlint-cli2",
|
||||
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json",
|
||||
"lint:prettier": "prettier . --check",
|
||||
"lint:staged": "lint-staged",
|
||||
"test": "node --test",
|
||||
"release": "semantic-release",
|
||||
"postinstall": "husky",
|
||||
"prepublishOnly": "pinst --disable",
|
||||
"postpublish": "pinst --enable"
|
||||
"release": "semantic-release"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"eslint": "^8.56.0",
|
||||
"eslint-plugin-import": "^2.29.1",
|
||||
"eslint-plugin-promise": "^6.1.1",
|
||||
"eslint-plugin-unicorn": "^51.0.1 || ^52.0.0 || ^53.0.0"
|
||||
"eslint": "^8.57.0",
|
||||
"eslint-plugin-promise": "^7.0.0",
|
||||
"eslint-plugin-unicorn": "^55.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "19.2.2",
|
||||
"@commitlint/config-conventional": "19.2.2",
|
||||
"@tsconfig/strictest": "2.0.5",
|
||||
"@types/eslint": "8.56.10",
|
||||
"@types/node": "20.12.12",
|
||||
"@typescript-eslint/eslint-plugin": "7.10.0",
|
||||
"@typescript-eslint/parser": "7.10.0",
|
||||
"editorconfig-checker": "5.1.5",
|
||||
"eslint": "8.57.0",
|
||||
"eslint-plugin-import": "2.29.1",
|
||||
"eslint-plugin-promise": "6.1.1",
|
||||
"eslint-plugin-unicorn": "53.0.0",
|
||||
"husky": "9.0.11",
|
||||
"lint-staged": "15.2.2",
|
||||
"markdownlint-cli2": "0.13.0",
|
||||
"markdownlint-rule-relative-links": "2.3.2",
|
||||
"pinst": "3.0.0",
|
||||
"prettier": "3.2.5",
|
||||
"@types/eslint": "8.56.12",
|
||||
"@types/node": "22.5.5",
|
||||
"@typescript-eslint/eslint-plugin": "8.6.0",
|
||||
"@typescript-eslint/parser": "8.6.0",
|
||||
"editorconfig-checker": "5.1.8",
|
||||
"eslint": "8.57.1",
|
||||
"eslint-plugin-promise": "7.1.0",
|
||||
"eslint-plugin-unicorn": "55.0.0",
|
||||
"markdownlint-cli2": "0.14.0",
|
||||
"markdownlint-rule-relative-links": "3.0.0",
|
||||
"prettier": "3.3.3",
|
||||
"semantic-release": "23.1.1",
|
||||
"typescript": "5.4.5"
|
||||
"typescript": "5.6.2"
|
||||
}
|
||||
}
|
||||
|
@ -1,7 +1,7 @@
|
||||
{
|
||||
"extends": "@tsconfig/strictest/tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"resolveJsonModule": true,
|
||||
"strict": true,
|
||||
"target": "ESNext",
|
||||
"module": "commonjs",
|
||||
"lib": ["ESNext"],
|
||||
|
Reference in New Issue
Block a user