mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-05-18 12:02:33 +02:00
Compare commits
63 Commits
Author | SHA1 | Date | |
---|---|---|---|
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
|
|||
b1bd574d42 | |||
ca9b1db4bd | |||
3222d42e67 | |||
08602b1c53 | |||
1779517f5c | |||
81b37b523c | |||
a95ac7ec8b | |||
32481c316f | |||
c3ddbc73b7 | |||
1934d3525a | |||
4f625c3b88 | |||
e24964a60a | |||
fcc107bdec | |||
666a3dee2d | |||
0ce46310ed | |||
e2b2c1c77f | |||
846a25943d | |||
e0f93343fe | |||
c3b46debe6 | |||
c0ec89ed0c | |||
099a3388a1 | |||
1f20fe89e8 | |||
3f1d1921ba | |||
b743c94430 | |||
f138acaf53 | |||
435d3e9e5f | |||
637a79a8e7 | |||
61679195ee | |||
387509a30f | |||
4271efe20b |
@ -4,10 +4,10 @@
|
||||
"env": {
|
||||
"browser": true,
|
||||
"node": true,
|
||||
"es2022": true
|
||||
"es2024": true
|
||||
},
|
||||
"parserOptions": {
|
||||
"ecmaVersion": 2022,
|
||||
"ecmaVersion": "latest",
|
||||
"sourceType": "module",
|
||||
"ecmaFeatures": {
|
||||
"jsx": true
|
||||
@ -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",
|
||||
{
|
||||
@ -110,7 +112,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",
|
||||
@ -144,8 +146,12 @@
|
||||
"prefer-regex-literals": ["error", { "disallowRedundantWrapping": true }],
|
||||
"quote-props": ["error", "as-needed"],
|
||||
"radix": "error",
|
||||
"require-await": "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",
|
||||
@ -162,22 +168,38 @@
|
||||
}
|
||||
],
|
||||
"import/no-named-default": "error",
|
||||
"import/no-empty-named-blocks": "error",
|
||||
|
||||
"promise/param-names": "error",
|
||||
"promise/no-new-statics": "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/throw-new-error": "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": [
|
||||
{
|
||||
@ -188,12 +210,13 @@
|
||||
"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",
|
||||
"@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",
|
||||
@ -231,25 +254,19 @@
|
||||
],
|
||||
"no-useless-constructor": "off",
|
||||
"@typescript-eslint/no-useless-constructor": "error",
|
||||
"require-await": "off",
|
||||
"@typescript-eslint/require-await": "error",
|
||||
|
||||
"@typescript-eslint/adjacent-overload-signatures": "error",
|
||||
"@typescript-eslint/array-type": [
|
||||
"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"
|
||||
],
|
||||
"no-duplicate-imports": "off",
|
||||
"@typescript-eslint/consistent-type-imports": "error",
|
||||
"@typescript-eslint/explicit-function-return-type": [
|
||||
"error",
|
||||
{
|
||||
@ -278,10 +295,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",
|
||||
@ -300,16 +313,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-unsafe-unary-minus": "error",
|
||||
"@typescript-eslint/prefer-function-type": "error",
|
||||
"@typescript-eslint/prefer-includes": "error",
|
||||
"@typescript-eslint/prefer-nullish-coalescing": [
|
||||
"error",
|
||||
{
|
||||
"ignoreTernaryTests": true,
|
||||
"ignoreConditionalTests": false,
|
||||
"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",
|
||||
@ -320,7 +334,7 @@
|
||||
],
|
||||
"@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
|
||||
|
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
2
.github/PULL_REQUEST_TEMPLATE.md
vendored
@ -1,6 +1,6 @@
|
||||
<!-- Please first discuss the change you wish to make via issue before making a change. It might avoid a waste of your time. -->
|
||||
|
||||
## What changes this PR introduce?
|
||||
# What changes this PR introduce?
|
||||
|
||||
## List any relevant issue numbers
|
||||
|
||||
|
26
.github/workflows/lint.yml
vendored
26
.github/workflows/lint.yml
vendored
@ -1,4 +1,4 @@
|
||||
name: 'Lint'
|
||||
name: "Lint"
|
||||
|
||||
on:
|
||||
push:
|
||||
@ -8,21 +8,21 @@ on:
|
||||
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: 'ubuntu-latest'
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: 'actions/checkout@v2.4.0'
|
||||
- uses: "actions/checkout@v4.1.1"
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.1"
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
||||
- name: 'Install'
|
||||
run: 'npm 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:javascript'
|
||||
- run: 'npm run lint:prettier'
|
||||
- run: "npm run lint:editorconfig"
|
||||
- run: "npm run lint:markdown"
|
||||
- run: "npm run lint:eslint"
|
||||
- run: "npm run lint:prettier"
|
||||
|
30
.github/workflows/release.yml
vendored
30
.github/workflows/release.yml
vendored
@ -1,4 +1,4 @@
|
||||
name: 'Release'
|
||||
name: "Release"
|
||||
|
||||
on:
|
||||
push:
|
||||
@ -6,24 +6,32 @@ on:
|
||||
|
||||
jobs:
|
||||
release:
|
||||
runs-on: 'ubuntu-latest'
|
||||
runs-on: "ubuntu-latest"
|
||||
permissions:
|
||||
contents: "write"
|
||||
issues: "write"
|
||||
pull-requests: "write"
|
||||
id-token: "write"
|
||||
steps:
|
||||
- uses: 'actions/checkout@v2.4.0'
|
||||
- uses: "actions/checkout@v4.1.1"
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.1"
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
||||
- name: 'Install'
|
||||
run: 'npm install'
|
||||
- name: "Install dependencies"
|
||||
run: "npm clean-install"
|
||||
|
||||
- name: 'Release'
|
||||
run: 'npm run release'
|
||||
- name: "Verify the integrity of provenance attestations and registry signatures for installed dependencies"
|
||||
run: "npm audit signatures"
|
||||
|
||||
- name: "Release"
|
||||
run: "npm run release"
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
22
.github/workflows/test.yml
vendored
22
.github/workflows/test.yml
vendored
@ -1,4 +1,4 @@
|
||||
name: 'Test'
|
||||
name: "Test"
|
||||
|
||||
on:
|
||||
push:
|
||||
@ -8,18 +8,18 @@ on:
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: 'ubuntu-latest'
|
||||
runs-on: "ubuntu-latest"
|
||||
steps:
|
||||
- uses: 'actions/checkout@v2.4.0'
|
||||
- uses: "actions/checkout@v4.1.1"
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
- name: "Setup Node.js"
|
||||
uses: "actions/setup-node@v4.0.1"
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
node-version: "lts/*"
|
||||
cache: "npm"
|
||||
|
||||
- name: 'Install'
|
||||
run: 'npm install'
|
||||
- name: "Install dependencies"
|
||||
run: "npm clean-install"
|
||||
|
||||
- name: 'Test'
|
||||
run: 'npm run test'
|
||||
- name: "Test"
|
||||
run: "npm run test"
|
||||
|
1
.gitignore
vendored
1
.gitignore
vendored
@ -4,6 +4,7 @@ node_modules
|
||||
|
||||
# testing
|
||||
coverage
|
||||
.nyc_output
|
||||
|
||||
# debug
|
||||
npm-debug.log*
|
||||
|
@ -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"]
|
||||
}
|
||||
|
11
.markdownlint-cli2.jsonc
Normal file
11
.markdownlint-cli2.jsonc
Normal file
@ -0,0 +1,11 @@
|
||||
{
|
||||
"config": {
|
||||
"extends": "markdownlint/style/prettier",
|
||||
"relative-links": true,
|
||||
"default": true,
|
||||
"MD033": false
|
||||
},
|
||||
"globs": ["**/*.{md,mdx}"],
|
||||
"ignores": ["**/node_modules"],
|
||||
"customRules": ["markdownlint-rule-relative-links"]
|
||||
}
|
@ -1,6 +0,0 @@
|
||||
{
|
||||
"default": true,
|
||||
"MD013": false,
|
||||
"MD033": false,
|
||||
"MD041": false
|
||||
}
|
@ -1,6 +1,3 @@
|
||||
{
|
||||
"singleQuote": true,
|
||||
"jsxSingleQuote": true,
|
||||
"semi": false,
|
||||
"trailingComma": "none"
|
||||
"semi": false
|
||||
}
|
||||
|
2
.vscode/settings.json
vendored
2
.vscode/settings.json
vendored
@ -5,6 +5,6 @@
|
||||
"prettier.configPath": ".prettierrc.json",
|
||||
"editor.formatOnSave": true,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.fixAll": true
|
||||
"source.fixAll": "explicit"
|
||||
}
|
||||
}
|
||||
|
@ -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
|
||||
|
@ -2,6 +2,14 @@
|
||||
|
||||
Thanks a lot for your interest in contributing to **eslint-config-conventions**! 🎉
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
**eslint-config-conventions** adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it. Please read [the full text](./CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
|
||||
|
||||
## Open Development
|
||||
|
||||
All work on **eslint-config-conventions** happens directly on this repository. Both core team members and external contributors send pull requests which go through the same review process.
|
||||
|
||||
## Types of contributions
|
||||
|
||||
- Reporting a bug.
|
||||
@ -11,7 +19,7 @@ Thanks a lot for your interest in contributing to **eslint-config-conventions**!
|
||||
|
||||
## 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.
|
||||
|
||||
@ -21,26 +29,4 @@ If you're adding new features to **eslint-config-conventions**, please include t
|
||||
|
||||
## Commits
|
||||
|
||||
The commit message guidelines respect [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) and [Semantic Versioning](https://semver.org/) for releases.
|
||||
|
||||
### Types
|
||||
|
||||
Types define which kind of changes you made to the project.
|
||||
|
||||
| Types | Description |
|
||||
| -------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| feat | A new feature. |
|
||||
| fix | A bug fix. |
|
||||
| docs | Documentation only changes. |
|
||||
| style | Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). |
|
||||
| refactor | A code change that neither fixes a bug nor adds a feature. |
|
||||
| perf | A code change that improves performance. |
|
||||
| test | Adding missing tests or correcting existing tests. |
|
||||
| build | Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm). |
|
||||
| ci | Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs). |
|
||||
| chore | Other changes that don't modify src or test files. |
|
||||
| revert | Reverts a previous commit. |
|
||||
|
||||
### Scopes
|
||||
|
||||
Scopes define what part of the code changed.
|
||||
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) and [Semantic Versioning](https://semver.org/) for releases.
|
||||
|
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) Divlo
|
||||
Copyright (c) Théo LUDWIG
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
44
README.md
44
README.md
@ -7,12 +7,12 @@
|
||||
</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>
|
||||
@ -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).
|
||||
|
||||
@ -31,24 +31,19 @@ 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.9.0 \
|
||||
eslint-plugin-import@^2.25.4 \
|
||||
eslint-plugin-promise@^6.0.0 \
|
||||
eslint-plugin-unicorn@^41.0.0 \
|
||||
eslint@^8.53.0 \
|
||||
eslint-plugin-import@^2.29.0 \
|
||||
eslint-plugin-promise@^6.1.1 \
|
||||
eslint-plugin-unicorn@^50.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:
|
||||
|
||||
- [ESLint](https://github.com/eslint/eslint)
|
||||
@ -62,16 +57,16 @@ If you want to use **TypeScript**, you also need to install:
|
||||
|
||||
```sh
|
||||
npm install --save-dev \
|
||||
typescript@^4.4.0 \
|
||||
@typescript-eslint/eslint-plugin@^5.12.0 \
|
||||
@typescript-eslint/parser@^5.12.0
|
||||
typescript@^5.2.2 \
|
||||
@typescript-eslint/eslint-plugin@^6.11.0 \
|
||||
@typescript-eslint/parser@^6.11.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)
|
||||
|
||||
@ -82,7 +77,7 @@ 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
|
||||
echo "{}" > .prettierrc.json
|
||||
```
|
||||
|
||||
#### `.eslintrc.json`
|
||||
@ -91,6 +86,7 @@ echo {}> .prettierrc.json
|
||||
{
|
||||
"extends": ["conventions", "prettier"],
|
||||
"plugins": ["prettier"],
|
||||
"parser": "@typescript-eslint/parser",
|
||||
"parserOptions": {
|
||||
"project": "./tsconfig.json"
|
||||
},
|
||||
@ -109,8 +105,8 @@ echo {}> .prettierrc.json
|
||||
```jsonc
|
||||
{
|
||||
"scripts": {
|
||||
"lint:typescript": "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,9 +114,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
|
||||
|
2
index.js
2
index.js
@ -1 +1 @@
|
||||
module.exports = require('./.eslintrc.json')
|
||||
module.exports = require("./.eslintrc.json")
|
||||
|
15134
package-lock.json
generated
15134
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
73
package.json
73
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",
|
||||
@ -23,48 +23,57 @@
|
||||
"conventions"
|
||||
],
|
||||
"main": "index.js",
|
||||
"files": [
|
||||
"index.js",
|
||||
".eslintrc.json"
|
||||
],
|
||||
"publishConfig": {
|
||||
"access": "public",
|
||||
"provenance": true
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16.0.0",
|
||||
"npm": ">=8.0.0"
|
||||
"node": ">=18.0.0",
|
||||
"npm": ">=9.0.0"
|
||||
},
|
||||
"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:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
|
||||
"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": "tape \"test/**/*.js\"",
|
||||
"test": "node --test test/",
|
||||
"release": "semantic-release",
|
||||
"postinstall": "husky install",
|
||||
"prepublishOnly": "pinst --disable",
|
||||
"postpublish": "pinst --enable"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"eslint": "^8.9.0",
|
||||
"eslint-plugin-import": "^2.25.4",
|
||||
"eslint-plugin-promise": "^6.0.0",
|
||||
"eslint-plugin-unicorn": "^41.0.0"
|
||||
"eslint": "^8.53.0",
|
||||
"eslint-plugin-import": "^2.29.0",
|
||||
"eslint-plugin-promise": "^6.1.1",
|
||||
"eslint-plugin-unicorn": "^49.0.0 || ^50.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "16.2.3",
|
||||
"@commitlint/config-conventional": "16.2.1",
|
||||
"editorconfig-checker": "4.0.2",
|
||||
"eslint": "8.11.0",
|
||||
"@types/eslint": "8.4.1",
|
||||
"eslint-plugin-import": "2.25.4",
|
||||
"eslint-plugin-promise": "6.0.0",
|
||||
"eslint-plugin-unicorn": "41.0.0",
|
||||
"typescript": "4.6.2",
|
||||
"@typescript-eslint/parser": "5.15.0",
|
||||
"@typescript-eslint/eslint-plugin": "5.15.0",
|
||||
"tape": "5.5.2",
|
||||
"husky": "7.0.4",
|
||||
"lint-staged": "12.3.6",
|
||||
"markdownlint-cli": "0.31.1",
|
||||
"@types/tape": "4.13.2",
|
||||
"@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",
|
||||
"pinst": "3.0.0",
|
||||
"prettier": "2.6.0",
|
||||
"semantic-release": "19.0.2"
|
||||
"prettier": "3.1.1",
|
||||
"semantic-release": "22.0.12",
|
||||
"typescript": "5.3.3"
|
||||
}
|
||||
}
|
||||
|
@ -1,15 +1,20 @@
|
||||
const test = require('tape')
|
||||
const test = require("node:test")
|
||||
const assert = require("node:assert/strict")
|
||||
|
||||
const config = require('../index.js')
|
||||
const config = require("../index.js")
|
||||
|
||||
test('test basic properties of config', function (t) {
|
||||
t.ok(isObject(config.parserOptions))
|
||||
t.ok(isObject(config.env))
|
||||
t.ok(isObject(config.rules))
|
||||
t.ok(isObject(config.overrides))
|
||||
t.end()
|
||||
})
|
||||
|
||||
function isObject(object) {
|
||||
return typeof object === 'object' && object !== null
|
||||
/**
|
||||
* @param {unknown} object
|
||||
* @returns {boolean}
|
||||
*/
|
||||
const isObject = (object) => {
|
||||
return typeof object === "object" && object !== null
|
||||
}
|
||||
|
||||
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"
|
||||
|
2
test/fixtures/top-level-await.mjs
vendored
2
test/fixtures/top-level-await.mjs
vendored
@ -1,3 +1,3 @@
|
||||
const foo = await 1
|
||||
const bar = function () {}
|
||||
const bar = () => {}
|
||||
await bar(foo)
|
||||
|
@ -1,40 +1,39 @@
|
||||
const { ESLint } = require('eslint')
|
||||
const test = require('tape')
|
||||
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",
|
||||
})
|
||||
|
||||
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)
|
||||
t.end()
|
||||
assert.strictEqual(noErrors?.errorCount, 0)
|
||||
assert.strictEqual(withErrors?.errorCount, 3)
|
||||
})
|
||||
|
||||
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)
|
||||
t.end()
|
||||
assert.strictEqual(noErrors?.errorCount, 0)
|
||||
assert.strictEqual(withErrors?.errorCount, 3)
|
||||
})
|
||||
|
||||
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)
|
||||
t.end()
|
||||
assert.strictEqual(lintResult?.errorCount, 0)
|
||||
})
|
||||
|
@ -1,12 +1,11 @@
|
||||
{
|
||||
"extends": "@tsconfig/strictest/tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"resolveJsonModule": true,
|
||||
"target": "ESNext",
|
||||
"module": "commonjs",
|
||||
"lib": ["ESNext"],
|
||||
"moduleResolution": "node",
|
||||
"rootDir": "./",
|
||||
"strict": true,
|
||||
"skipLibCheck": true,
|
||||
"esModuleInterop": true
|
||||
"rootDir": "./"
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user