mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-05-18 12:02:33 +02:00
Compare commits
72 Commits
v9.0.0
...
92e6e56884
Author | SHA1 | Date | |
---|---|---|---|
92e6e56884
|
|||
305df380aa
|
|||
8b3d9109d7
|
|||
d0fa4e3688
|
|||
9fa86e2133
|
|||
6cb7af3a05
|
|||
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
|
|||
f243013173
|
|||
d3d71f9a78
|
|||
6a064c227e
|
|||
113a469ac5
|
|||
0e2b2ae89d
|
|||
d91b2a2538
|
|||
d8b3ef6646
|
|||
d149fdd6ab
|
|||
6345bddd38
|
|||
4e99d69598
|
|||
adf01e1e8c
|
|||
8bfeaadf32
|
|||
807c201955
|
|||
381f5cb9cf
|
|||
c431a208e9
|
|||
f622982fdb
|
|||
d59b088bff
|
|||
2fd4edbf5b
|
|||
8837b8737b
|
|||
cbbb8dfe28
|
|||
2fcede3f0a
|
|||
80c00f5fa8
|
|||
7f7ab46896
|
|||
eab075e291
|
|||
244b74679a
|
|||
07595ccb56
|
|||
d0e9004ce3
|
|||
1e29cef968
|
|||
f89c4415cf
|
|||
34ec74cff7
|
|||
f5a69d69f5
|
|||
e071e917f6
|
|||
528a31316d
|
@ -1 +0,0 @@
|
||||
{ "extends": ["@commitlint/config-conventional"] }
|
@ -1,13 +1,13 @@
|
||||
{
|
||||
"root": true,
|
||||
"plugins": ["import", "promise", "unicorn"],
|
||||
"plugins": ["promise", "unicorn"],
|
||||
"env": {
|
||||
"browser": true,
|
||||
"node": true,
|
||||
"es2022": true
|
||||
"es2024": true
|
||||
},
|
||||
"parserOptions": {
|
||||
"ecmaVersion": 2022,
|
||||
"ecmaVersion": "latest",
|
||||
"sourceType": "module",
|
||||
"ecmaFeatures": {
|
||||
"jsx": 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",
|
||||
@ -112,7 +114,7 @@
|
||||
],
|
||||
"no-multi-str": "error",
|
||||
"no-new-func": "error",
|
||||
"no-new-object": "error",
|
||||
"no-object-constructor": "error",
|
||||
"no-octal": "error",
|
||||
"no-octal-escape": "error",
|
||||
"no-proto": "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,39 +157,38 @@
|
||||
"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",
|
||||
"unicorn/consistent-destructuring": "error",
|
||||
"unicorn/custom-error-definition": "error",
|
||||
"unicorn/error-message": "error",
|
||||
"unicorn/escape-case": "error",
|
||||
"unicorn/explicit-length-check": "error",
|
||||
"unicorn/new-for-builtins": "error",
|
||||
"unicorn/no-array-callback-reference": "error",
|
||||
"unicorn/no-array-for-each": "error",
|
||||
"unicorn/no-array-method-this-argument": "error",
|
||||
"unicorn/no-document-cookie": "error",
|
||||
"unicorn/no-empty-file": "error",
|
||||
"unicorn/no-hex-escape": "error",
|
||||
"unicorn/no-instanceof-array": "error",
|
||||
"unicorn/no-new-array": "error",
|
||||
"unicorn/no-new-buffer": "error",
|
||||
"unicorn/no-this-assignment": "error",
|
||||
"unicorn/no-zero-fractions": "error",
|
||||
"unicorn/number-literal-case": "error",
|
||||
"unicorn/prefer-node-protocol": "error",
|
||||
"unicorn/throw-new-error": "error",
|
||||
"unicorn/no-typeof-undefined": "error"
|
||||
"unicorn/no-typeof-undefined": "error",
|
||||
"unicorn/require-array-join-separator": "error",
|
||||
"unicorn/prefer-number-properties": "error",
|
||||
"unicorn/prefer-modern-math-apis": "error",
|
||||
"unicorn/template-indent": "error"
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
@ -196,8 +199,6 @@
|
||||
"no-undef": "off",
|
||||
"no-dupe-class-members": "off",
|
||||
"@typescript-eslint/no-dupe-class-members": "error",
|
||||
"no-duplicate-imports": "off",
|
||||
"@typescript-eslint/no-duplicate-imports": "error",
|
||||
"no-loss-of-precision": "off",
|
||||
"@typescript-eslint/no-loss-of-precision": "error",
|
||||
"no-unused-vars": "off",
|
||||
@ -242,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": [
|
||||
@ -253,6 +255,7 @@
|
||||
"error",
|
||||
"interface"
|
||||
],
|
||||
"no-duplicate-imports": "off",
|
||||
"@typescript-eslint/consistent-type-imports": "error",
|
||||
"@typescript-eslint/explicit-function-return-type": [
|
||||
"error",
|
||||
@ -263,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",
|
||||
@ -300,11 +296,17 @@
|
||||
"@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",
|
||||
{
|
||||
"ignoreTernaryTests": true,
|
||||
"ignoreConditionalTests": false,
|
||||
"ignoreMixedLogicalExpressions": false
|
||||
}
|
||||
@ -313,13 +315,15 @@
|
||||
"@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 }
|
||||
],
|
||||
"@typescript-eslint/restrict-plus-operands": [
|
||||
"error",
|
||||
{ "checkCompoundAssignments": true }
|
||||
{ "skipCompoundAssignments": true }
|
||||
],
|
||||
"@typescript-eslint/restrict-template-expressions": [
|
||||
"error",
|
||||
|
8
.github/ISSUE_TEMPLATE/BUG.md
vendored
8
.github/ISSUE_TEMPLATE/BUG.md
vendored
@ -1,8 +1,8 @@
|
||||
---
|
||||
name: '🐛 Bug Report'
|
||||
about: 'Report an unexpected problem or unintended behavior.'
|
||||
title: '[Bug]'
|
||||
labels: 'bug'
|
||||
name: "🐛 Bug Report"
|
||||
about: "Report an unexpected problem or unintended behavior."
|
||||
title: "[Bug]"
|
||||
labels: "bug"
|
||||
---
|
||||
|
||||
<!--
|
||||
|
8
.github/ISSUE_TEMPLATE/DOCUMENTATION.md
vendored
8
.github/ISSUE_TEMPLATE/DOCUMENTATION.md
vendored
@ -1,8 +1,8 @@
|
||||
---
|
||||
name: '📜 Documentation'
|
||||
about: 'Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...).'
|
||||
title: '[Documentation]'
|
||||
labels: 'documentation'
|
||||
name: "📜 Documentation"
|
||||
about: "Correct spelling errors, improvements or additions to documentation files (README, CONTRIBUTING...)."
|
||||
title: "[Documentation]"
|
||||
labels: "documentation"
|
||||
---
|
||||
|
||||
<!-- Please make sure your issue has not already been fixed. -->
|
||||
|
8
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
8
.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
vendored
@ -1,8 +1,8 @@
|
||||
---
|
||||
name: '✨ Feature Request'
|
||||
about: 'Suggest a new feature idea.'
|
||||
title: '[Feature]'
|
||||
labels: 'feature request'
|
||||
name: "✨ Feature Request"
|
||||
about: "Suggest a new feature idea."
|
||||
title: "[Feature]"
|
||||
labels: "feature request"
|
||||
---
|
||||
|
||||
<!-- Please make sure your issue has not already been fixed. -->
|
||||
|
8
.github/ISSUE_TEMPLATE/IMPROVEMENT.md
vendored
8
.github/ISSUE_TEMPLATE/IMPROVEMENT.md
vendored
@ -1,8 +1,8 @@
|
||||
---
|
||||
name: '🔧 Improvement'
|
||||
about: 'Improve structure/format/performance/refactor/tests of the code.'
|
||||
title: '[Improvement]'
|
||||
labels: 'improvement'
|
||||
name: "🔧 Improvement"
|
||||
about: "Improve structure/format/performance/refactor/tests of the code."
|
||||
title: "[Improvement]"
|
||||
labels: "improvement"
|
||||
---
|
||||
|
||||
<!-- Please make sure your issue has not already been fixed. -->
|
||||
|
8
.github/ISSUE_TEMPLATE/QUESTION.md
vendored
8
.github/ISSUE_TEMPLATE/QUESTION.md
vendored
@ -1,8 +1,8 @@
|
||||
---
|
||||
name: '🙋 Question'
|
||||
about: 'Further information is requested.'
|
||||
title: '[Question]'
|
||||
labels: 'question'
|
||||
name: "🙋 Question"
|
||||
about: "Further information is requested."
|
||||
title: "[Question]"
|
||||
labels: "question"
|
||||
---
|
||||
|
||||
### Question
|
||||
|
36
.github/workflows/lint.yml
vendored
36
.github/workflows/lint.yml
vendored
@ -1,28 +1,34 @@
|
||||
name: 'Lint'
|
||||
name: "Lint"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [develop]
|
||||
pull_request:
|
||||
branches: [master, develop]
|
||||
branches: [main, develop]
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: 'ubuntu-latest'
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: 'actions/checkout@v3.5.2'
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
|
||||
- name: 'Setup Node.js'
|
||||
uses: 'actions/setup-node@v3.6.0'
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.3"
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
|
||||
- name: 'Install dependencies'
|
||||
run: 'npm clean-install'
|
||||
- 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.0.1"
|
||||
|
36
.github/workflows/release.yml
vendored
36
.github/workflows/release.yml
vendored
@ -1,37 +1,37 @@
|
||||
name: 'Release'
|
||||
name: "Release"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [master]
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: 'ubuntu-latest'
|
||||
runs-on: "ubuntu-latest"
|
||||
permissions:
|
||||
contents: 'write'
|
||||
issues: 'write'
|
||||
pull-requests: 'write'
|
||||
id-token: 'write'
|
||||
contents: "write"
|
||||
issues: "write"
|
||||
pull-requests: "write"
|
||||
id-token: "write"
|
||||
steps:
|
||||
- uses: 'actions/checkout@v3.5.2'
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: 'Setup Node.js'
|
||||
uses: 'actions/setup-node@v3.6.0'
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.3"
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
|
||||
- name: 'Install dependencies'
|
||||
run: 'npm clean-install'
|
||||
- name: "Install dependencies"
|
||||
run: "npm clean-install"
|
||||
|
||||
- name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
|
||||
run: 'npm audit signatures'
|
||||
- name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
|
||||
run: "npm audit signatures"
|
||||
|
||||
- name: 'Release'
|
||||
run: 'npm run release'
|
||||
- name: "Release"
|
||||
run: "node --run release"
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
24
.github/workflows/test.yml
vendored
24
.github/workflows/test.yml
vendored
@ -1,25 +1,25 @@
|
||||
name: 'Test'
|
||||
name: "Test"
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [develop]
|
||||
pull_request:
|
||||
branches: [master, develop]
|
||||
branches: [main, develop]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: 'ubuntu-latest'
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: 'actions/checkout@v3.5.2'
|
||||
- uses: "actions/checkout@v4.1.7"
|
||||
|
||||
- name: 'Setup Node.js'
|
||||
uses: 'actions/setup-node@v3.6.0'
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.3"
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
node-version: "22.x"
|
||||
cache: "npm"
|
||||
|
||||
- name: 'Install dependencies'
|
||||
run: 'npm clean-install'
|
||||
- name: "Install dependencies"
|
||||
run: "npm clean-install"
|
||||
|
||||
- name: 'Test'
|
||||
run: 'npm run test'
|
||||
- name: "Test"
|
||||
run: "node --run test"
|
||||
|
@ -1,4 +0,0 @@
|
||||
#!/bin/sh
|
||||
. "$(dirname "$0")/_/husky.sh"
|
||||
|
||||
npm run lint:commit -- --edit
|
@ -1,5 +0,0 @@
|
||||
#!/bin/sh
|
||||
. "$(dirname "$0")/_/husky.sh"
|
||||
|
||||
npm run lint:staged
|
||||
npm run test
|
@ -1,6 +0,0 @@
|
||||
{
|
||||
"*": ["editorconfig-checker"],
|
||||
"*.{js,jsx,ts,tsx}": ["prettier --write", "eslint --fix"],
|
||||
"*.{json,jsonc,yml,yaml}": ["prettier --write"],
|
||||
"*.{md,mdx}": ["prettier --write", "markdownlint-cli2 --fix"]
|
||||
}
|
@ -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"],
|
||||
}
|
||||
|
4
.npmrc
4
.npmrc
@ -1,2 +1,2 @@
|
||||
save-exact=true
|
||||
provenance=true
|
||||
save-exact = true
|
||||
provenance = true
|
||||
|
@ -1,6 +1,3 @@
|
||||
{
|
||||
"singleQuote": true,
|
||||
"jsxSingleQuote": true,
|
||||
"semi": false,
|
||||
"trailingComma": "none"
|
||||
"semi": false
|
||||
}
|
||||
|
@ -1,18 +1,8 @@
|
||||
{
|
||||
"branches": ["master"],
|
||||
"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
.taprc
8
.taprc
@ -1,8 +0,0 @@
|
||||
ts: false
|
||||
jsx: false
|
||||
flow: false
|
||||
check-coverage: true
|
||||
coverage: true
|
||||
|
||||
test-ignore:
|
||||
- 'test/fixtures'
|
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": true
|
||||
}
|
||||
}
|
@ -60,7 +60,7 @@ representative at an online or offline event.
|
||||
|
||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||
reported to the community leaders responsible for enforcement at
|
||||
<contact@divlo.fr>.
|
||||
<contact@theoludwig.fr>.
|
||||
All complaints will be reviewed and investigated promptly and fairly.
|
||||
|
||||
All community leaders are obligated to respect the privacy and security of the
|
||||
|
@ -19,7 +19,7 @@ All work on **eslint-config-conventions** happens directly on this repository. B
|
||||
|
||||
## Pull Requests
|
||||
|
||||
- **Please first discuss** the change you wish to make via [issue](https://github.com/Divlo/eslint-config-conventions/issues) before making a change. It might avoid a waste of your time.
|
||||
- **Please first discuss** the change you wish to make via [issue](https://github.com/theoludwig/eslint-config-conventions/issues) before making a change. It might avoid a waste of your time.
|
||||
|
||||
- Ensure your code respect linting.
|
||||
|
||||
|
4
LICENSE
4
LICENSE
@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
# MIT License
|
||||
|
||||
Copyright (c) Divlo
|
||||
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
|
||||
|
106
README.md
106
README.md
@ -4,15 +4,13 @@
|
||||
<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" /></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 />
|
||||
<a href="https://github.com/Divlo/eslint-config-conventions/actions/workflows/lint.yml"><img src="https://github.com/Divlo/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" /></a>
|
||||
<a href="https://github.com/Divlo/eslint-config-conventions/actions/workflows/test.yml"><img src="https://github.com/Divlo/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
|
||||
<a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/lint.yml/badge.svg?branch=develop" alt="lint action" /></a>
|
||||
<a href="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" alt="test action" /></a>
|
||||
<br />
|
||||
<a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg" alt="Conventional Commits" /></a>
|
||||
<a href="https://github.com/semantic-release/semantic-release"><img src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg" alt="semantic-release" /></a>
|
||||
@ -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.
|
||||
|
||||
@ -31,86 +29,94 @@ More information about **formatting rules** vs **code-quality rules** can be fou
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [Node.js](https://nodejs.org/) >= 16.0.0
|
||||
[Node.js](https://nodejs.org/) >= 18.0.0
|
||||
|
||||
### Installation
|
||||
|
||||
`npm@<7` does not automatically install `peerDependencies`, so if that's what you're using, install them manually.
|
||||
Here is an example, but use it only for reference, because your decisions regarding version ranges and range specifiers may vary.
|
||||
|
||||
```sh
|
||||
npm install --save-dev \
|
||||
eslint@^8.33.0 \
|
||||
eslint-plugin-import@^2.27.5 \
|
||||
eslint@^8.56.0 \
|
||||
eslint-plugin-promise@^6.1.1 \
|
||||
eslint-plugin-unicorn@^47.0.0 \
|
||||
eslint-plugin-unicorn@^53.0.0 \
|
||||
eslint-config-conventions@latest
|
||||
```
|
||||
|
||||
Yes, this is a large number of packages. This is due to [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458).
|
||||
|
||||
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.0.4 \
|
||||
@typescript-eslint/eslint-plugin@^5.59.5 \
|
||||
@typescript-eslint/parser@^5.59.5
|
||||
"typescript@^5.3.3" \
|
||||
"@typescript-eslint/eslint-plugin@>=6.21.0" \
|
||||
"@typescript-eslint/parser@>=6.21.0"
|
||||
```
|
||||
|
||||
Dependencies are:
|
||||
|
||||
- [TypeScript](https://github.com/Microsoft/TypeScript)
|
||||
- [@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.
|
||||
- [@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:
|
||||
|
||||
```sh
|
||||
npm install --save-dev prettier eslint-config-prettier eslint-plugin-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`
|
||||
#### `.eslintrc.json` (JavaScript)
|
||||
|
||||
```json
|
||||
{
|
||||
"extends": ["conventions", "prettier"],
|
||||
"plugins": ["prettier"],
|
||||
"parserOptions": {
|
||||
"project": "./tsconfig.json"
|
||||
},
|
||||
"rules": {
|
||||
"prettier/prettier": "error"
|
||||
}
|
||||
"extends": ["conventions"],
|
||||
"plugins": ["promise", "unicorn"]
|
||||
}
|
||||
```
|
||||
|
||||
**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).
|
||||
#### `.eslintrc.json` (TypeScript)
|
||||
|
||||
`"parserOptions.project"` is only required if you use **TypeScript**.
|
||||
```json
|
||||
{
|
||||
"extends": ["conventions"],
|
||||
"plugins": ["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
|
||||
|
||||
# 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
|
||||
```
|
||||
|
||||
That's all! No need to update the `.eslintrc.json` configuration.
|
||||
|
||||
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 \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
|
||||
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\""
|
||||
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
|
||||
"lint:prettier": "prettier . --check"
|
||||
}
|
||||
}
|
||||
```
|
||||
@ -118,12 +124,12 @@ echo {}> .prettierrc.json
|
||||
### 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
|
||||
|
2
index.js
2
index.js
@ -1 +1 @@
|
||||
module.exports = require('./.eslintrc.json')
|
||||
module.exports = require("./.eslintrc.json")
|
||||
|
11998
package-lock.json
generated
11998
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
65
package.json
65
package.json
@ -3,16 +3,16 @@
|
||||
"version": "0.0.0-development",
|
||||
"public": true,
|
||||
"description": "ESLint shareable config to enforce strict conventions and good code quality.",
|
||||
"author": "Divlo <contact@divlo.fr>",
|
||||
"author": "Théo LUDWIG <contact@theoludwig.fr>",
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/Divlo/eslint-config-conventions.git"
|
||||
"url": "https://github.com/theoludwig/eslint-config-conventions.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/Divlo/eslint-config-conventions/issues"
|
||||
"url": "https://github.com/theoludwig/eslint-config-conventions/issues"
|
||||
},
|
||||
"homepage": "https://github.com/Divlo/eslint-config-conventions#readme",
|
||||
"homepage": "https://github.com/theoludwig/eslint-config-conventions#readme",
|
||||
"keywords": [
|
||||
"eslintconfig",
|
||||
"eslint",
|
||||
@ -32,49 +32,34 @@
|
||||
"provenance": true
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16.0.0",
|
||||
"npm": ">=9.0.0"
|
||||
"node": ">=18.0.0"
|
||||
},
|
||||
"scripts": {
|
||||
"lint:commit": "commitlint",
|
||||
"lint:editorconfig": "editorconfig-checker",
|
||||
"lint:markdown": "markdownlint-cli2",
|
||||
"lint:eslint": "eslint \".\" -c \"eslintrc.json\"",
|
||||
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
|
||||
"lint:staged": "lint-staged",
|
||||
"test": "tap",
|
||||
"release": "semantic-release",
|
||||
"postinstall": "husky install",
|
||||
"prepublishOnly": "pinst --disable",
|
||||
"postpublish": "pinst --enable"
|
||||
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json",
|
||||
"lint:prettier": "prettier . --check",
|
||||
"test": "node --test",
|
||||
"release": "semantic-release"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"eslint": "^8.33.0",
|
||||
"eslint-plugin-import": "^2.27.5",
|
||||
"eslint-plugin-promise": "^6.1.1",
|
||||
"eslint-plugin-unicorn": "^47.0.0"
|
||||
"eslint": "^8.56.0",
|
||||
"eslint-plugin-promise": "^6.1.1 || ^7.0.0",
|
||||
"eslint-plugin-unicorn": "^51.0.1 || ^52.0.0 || ^53.0.0 || ^54.0.0 || ^55.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "17.6.3",
|
||||
"@commitlint/config-conventional": "17.6.3",
|
||||
"@tsconfig/strictest": "2.0.1",
|
||||
"@types/eslint": "8.37.0",
|
||||
"@types/tap": "15.0.8",
|
||||
"@typescript-eslint/eslint-plugin": "5.59.5",
|
||||
"@typescript-eslint/parser": "5.59.5",
|
||||
"editorconfig-checker": "5.0.1",
|
||||
"eslint": "8.40.0",
|
||||
"eslint-plugin-import": "2.27.5",
|
||||
"eslint-plugin-promise": "6.1.1",
|
||||
"eslint-plugin-unicorn": "47.0.0",
|
||||
"husky": "8.0.3",
|
||||
"lint-staged": "13.2.2",
|
||||
"markdownlint-cli2": "0.7.1",
|
||||
"markdownlint-rule-relative-links": "1.1.2",
|
||||
"pinst": "3.0.0",
|
||||
"prettier": "2.8.8",
|
||||
"semantic-release": "21.0.2",
|
||||
"tap": "16.3.4",
|
||||
"typescript": "5.0.4"
|
||||
"@types/eslint": "8.56.11",
|
||||
"@types/node": "20.14.12",
|
||||
"@typescript-eslint/eslint-plugin": "7.17.0",
|
||||
"@typescript-eslint/parser": "7.17.0",
|
||||
"editorconfig-checker": "5.1.8",
|
||||
"eslint": "8.57.0",
|
||||
"eslint-plugin-promise": "7.0.0",
|
||||
"eslint-plugin-unicorn": "55.0.0",
|
||||
"markdownlint-cli2": "0.13.0",
|
||||
"markdownlint-rule-relative-links": "3.0.0",
|
||||
"prettier": "3.3.3",
|
||||
"semantic-release": "23.1.1",
|
||||
"typescript": "5.5.4"
|
||||
}
|
||||
}
|
||||
|
@ -1,14 +1,20 @@
|
||||
const tap = require('tap')
|
||||
const test = require("node:test")
|
||||
const assert = require("node:assert/strict")
|
||||
|
||||
const config = require('../index.js')
|
||||
const config = require("../index.js")
|
||||
|
||||
/**
|
||||
* @param {unknown} object
|
||||
* @returns {boolean}
|
||||
*/
|
||||
const isObject = (object) => {
|
||||
return typeof object === 'object' && object !== null
|
||||
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))
|
||||
test("test basic properties of config", async () => {
|
||||
assert.ok(isObject(config))
|
||||
assert.ok(isObject(config.parserOptions))
|
||||
assert.ok(isObject(config.env))
|
||||
assert.ok(isObject(config.rules))
|
||||
assert.ok(isObject(config.overrides))
|
||||
})
|
||||
|
2
test/fixtures/javascript-with-errors.js
vendored
2
test/fixtures/javascript-with-errors.js
vendored
@ -1 +1 @@
|
||||
'invalid eqeqeq' == 'invalid eqeqeq'
|
||||
"invalid eqeqeq" == "invalid eqeqeq"
|
||||
|
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()
|
@ -1,37 +1,46 @@
|
||||
const { ESLint } = require('eslint')
|
||||
const tap = require('tap')
|
||||
const test = require("node:test")
|
||||
const assert = require("node:assert/strict")
|
||||
|
||||
const { ESLint } = require("eslint")
|
||||
|
||||
const eslint = new ESLint({
|
||||
ignore: false,
|
||||
useEslintrc: false,
|
||||
overrideConfigFile: 'eslintrc.json'
|
||||
overrideConfigFile: "eslintrc.json",
|
||||
})
|
||||
|
||||
tap.test('ensure we validate correctly JavaScript files', async (t) => {
|
||||
test("ensure we validate correctly JavaScript files", async () => {
|
||||
const [noErrors] = await eslint.lintFiles(
|
||||
'test/fixtures/javascript-no-errors.js'
|
||||
"test/fixtures/javascript-no-errors.js",
|
||||
)
|
||||
const [withErrors] = await eslint.lintFiles(
|
||||
'test/fixtures/javascript-with-errors.js'
|
||||
"test/fixtures/javascript-with-errors.js",
|
||||
)
|
||||
t.equal(noErrors.errorCount, 0)
|
||||
t.equal(withErrors.errorCount, 3)
|
||||
assert.strictEqual(noErrors?.errorCount, 0)
|
||||
assert.strictEqual(withErrors?.errorCount, 3)
|
||||
})
|
||||
|
||||
tap.test('ensure we validate correctly TypeScript files', async (t) => {
|
||||
test("ensure we validate correctly TypeScript files", async () => {
|
||||
const [noErrors] = await eslint.lintFiles(
|
||||
'test/fixtures/typescript-no-errors.ts'
|
||||
"test/fixtures/typescript-no-errors.ts",
|
||||
)
|
||||
const [withErrors] = await eslint.lintFiles(
|
||||
'test/fixtures/javascript-with-errors.js'
|
||||
"test/fixtures/javascript-with-errors.js",
|
||||
)
|
||||
t.equal(noErrors.errorCount, 0)
|
||||
t.equal(withErrors.errorCount, 3)
|
||||
assert.strictEqual(noErrors?.errorCount, 0)
|
||||
assert.strictEqual(withErrors?.errorCount, 3)
|
||||
})
|
||||
|
||||
tap.test('ensure we allow top-level await', async (t) => {
|
||||
test("ensure we allow top-level await", async () => {
|
||||
const [lintResult] = await eslint.lintFiles(
|
||||
'test/fixtures/top-level-await.mjs'
|
||||
"test/fixtures/top-level-await.mjs",
|
||||
)
|
||||
t.equal(lintResult.errorCount, 0)
|
||||
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)
|
||||
})
|
||||
|
@ -1,6 +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