mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-05-18 12:02:33 +02:00
Compare commits
42 Commits
Author | SHA1 | Date | |
---|---|---|---|
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 |
@ -4,10 +4,10 @@
|
|||||||
"env": {
|
"env": {
|
||||||
"browser": true,
|
"browser": true,
|
||||||
"node": true,
|
"node": true,
|
||||||
"es2022": true
|
"es2024": true
|
||||||
},
|
},
|
||||||
"parserOptions": {
|
"parserOptions": {
|
||||||
"ecmaVersion": 2022,
|
"ecmaVersion": "latest",
|
||||||
"sourceType": "module",
|
"sourceType": "module",
|
||||||
"ecmaFeatures": {
|
"ecmaFeatures": {
|
||||||
"jsx": true
|
"jsx": true
|
||||||
@ -34,6 +34,7 @@
|
|||||||
"no-duplicate-imports": "error",
|
"no-duplicate-imports": "error",
|
||||||
"no-empty-character-class": "error",
|
"no-empty-character-class": "error",
|
||||||
"no-empty-pattern": "error",
|
"no-empty-pattern": "error",
|
||||||
|
"no-empty-static-block": "error",
|
||||||
"no-ex-assign": "error",
|
"no-ex-assign": "error",
|
||||||
"no-fallthrough": "error",
|
"no-fallthrough": "error",
|
||||||
"no-func-assign": "error",
|
"no-func-assign": "error",
|
||||||
@ -42,6 +43,7 @@
|
|||||||
"no-irregular-whitespace": "error",
|
"no-irregular-whitespace": "error",
|
||||||
"no-loss-of-precision": "error",
|
"no-loss-of-precision": "error",
|
||||||
"no-misleading-character-class": "error",
|
"no-misleading-character-class": "error",
|
||||||
|
"no-new-native-nonconstructor": "error",
|
||||||
"no-new-symbol": "error",
|
"no-new-symbol": "error",
|
||||||
"no-obj-calls": "error",
|
"no-obj-calls": "error",
|
||||||
"no-promise-executor-return": "error",
|
"no-promise-executor-return": "error",
|
||||||
@ -59,7 +61,7 @@
|
|||||||
"no-unsafe-negation": "error",
|
"no-unsafe-negation": "error",
|
||||||
"no-unsafe-optional-chaining": "error",
|
"no-unsafe-optional-chaining": "error",
|
||||||
"no-unused-private-class-members": "error",
|
"no-unused-private-class-members": "error",
|
||||||
"no-unused-vars": "error",
|
"no-unused-vars": ["error", { "varsIgnorePattern": "^_" }],
|
||||||
"no-use-before-define": [
|
"no-use-before-define": [
|
||||||
"error",
|
"error",
|
||||||
{
|
{
|
||||||
@ -110,7 +112,7 @@
|
|||||||
],
|
],
|
||||||
"no-multi-str": "error",
|
"no-multi-str": "error",
|
||||||
"no-new-func": "error",
|
"no-new-func": "error",
|
||||||
"no-new-object": "error",
|
"no-object-constructor": "error",
|
||||||
"no-octal": "error",
|
"no-octal": "error",
|
||||||
"no-octal-escape": "error",
|
"no-octal-escape": "error",
|
||||||
"no-proto": "error",
|
"no-proto": "error",
|
||||||
@ -166,22 +168,39 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"import/no-named-default": "error",
|
"import/no-named-default": "error",
|
||||||
|
"import/no-empty-named-blocks": "error",
|
||||||
|
|
||||||
"promise/param-names": "error",
|
"promise/param-names": "error",
|
||||||
"promise/no-new-statics": "error",
|
"promise/no-new-statics": "error",
|
||||||
|
|
||||||
"unicorn/better-regex": "error",
|
"unicorn/better-regex": "error",
|
||||||
"unicorn/catch-error-name": "error",
|
"unicorn/catch-error-name": "error",
|
||||||
|
"unicorn/consistent-destructuring": "error",
|
||||||
"unicorn/custom-error-definition": "error",
|
"unicorn/custom-error-definition": "error",
|
||||||
"unicorn/error-message": "error",
|
"unicorn/error-message": "error",
|
||||||
"unicorn/escape-case": "error",
|
"unicorn/escape-case": "error",
|
||||||
|
"unicorn/explicit-length-check": "error",
|
||||||
"unicorn/new-for-builtins": "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-array-push-push": "error",
|
||||||
|
"unicorn/no-document-cookie": "error",
|
||||||
|
"unicorn/no-empty-file": "error",
|
||||||
"unicorn/no-hex-escape": "error",
|
"unicorn/no-hex-escape": "error",
|
||||||
"unicorn/no-instanceof-array": "error",
|
"unicorn/no-instanceof-array": "error",
|
||||||
|
"unicorn/no-new-array": "error",
|
||||||
|
"unicorn/no-new-buffer": "error",
|
||||||
"unicorn/no-this-assignment": "error",
|
"unicorn/no-this-assignment": "error",
|
||||||
"unicorn/no-zero-fractions": "error",
|
"unicorn/no-zero-fractions": "error",
|
||||||
|
"unicorn/number-literal-case": "error",
|
||||||
"unicorn/prefer-node-protocol": "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": [
|
"overrides": [
|
||||||
{
|
{
|
||||||
@ -192,12 +211,13 @@
|
|||||||
"no-undef": "off",
|
"no-undef": "off",
|
||||||
"no-dupe-class-members": "off",
|
"no-dupe-class-members": "off",
|
||||||
"@typescript-eslint/no-dupe-class-members": "error",
|
"@typescript-eslint/no-dupe-class-members": "error",
|
||||||
"no-duplicate-imports": "off",
|
|
||||||
"@typescript-eslint/no-duplicate-imports": "error",
|
|
||||||
"no-loss-of-precision": "off",
|
"no-loss-of-precision": "off",
|
||||||
"@typescript-eslint/no-loss-of-precision": "error",
|
"@typescript-eslint/no-loss-of-precision": "error",
|
||||||
"no-unused-vars": "off",
|
"no-unused-vars": "off",
|
||||||
"@typescript-eslint/no-unused-vars": "error",
|
"@typescript-eslint/no-unused-vars": [
|
||||||
|
"error",
|
||||||
|
{ "varsIgnorePattern": "^_" }
|
||||||
|
],
|
||||||
"no-use-before-define": "off",
|
"no-use-before-define": "off",
|
||||||
"@typescript-eslint/no-use-before-define": [
|
"@typescript-eslint/no-use-before-define": [
|
||||||
"error",
|
"error",
|
||||||
@ -241,17 +261,12 @@
|
|||||||
"error",
|
"error",
|
||||||
{ "default": "array-simple" }
|
{ "default": "array-simple" }
|
||||||
],
|
],
|
||||||
"@typescript-eslint/consistent-type-assertions": [
|
"@typescript-eslint/ban-types": "error",
|
||||||
"error",
|
|
||||||
{
|
|
||||||
"assertionStyle": "as",
|
|
||||||
"objectLiteralTypeAssertions": "never"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"@typescript-eslint/consistent-type-definitions": [
|
"@typescript-eslint/consistent-type-definitions": [
|
||||||
"error",
|
"error",
|
||||||
"interface"
|
"interface"
|
||||||
],
|
],
|
||||||
|
"no-duplicate-imports": "off",
|
||||||
"@typescript-eslint/consistent-type-imports": "error",
|
"@typescript-eslint/consistent-type-imports": "error",
|
||||||
"@typescript-eslint/explicit-function-return-type": [
|
"@typescript-eslint/explicit-function-return-type": [
|
||||||
"error",
|
"error",
|
||||||
@ -304,11 +319,11 @@
|
|||||||
"@typescript-eslint/prefer-nullish-coalescing": [
|
"@typescript-eslint/prefer-nullish-coalescing": [
|
||||||
"error",
|
"error",
|
||||||
{
|
{
|
||||||
|
"ignoreTernaryTests": true,
|
||||||
"ignoreConditionalTests": false,
|
"ignoreConditionalTests": false,
|
||||||
"ignoreMixedLogicalExpressions": false
|
"ignoreMixedLogicalExpressions": false
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"@typescript-eslint/prefer-optional-chain": "error",
|
|
||||||
"@typescript-eslint/prefer-readonly": "error",
|
"@typescript-eslint/prefer-readonly": "error",
|
||||||
"@typescript-eslint/prefer-reduce-type-parameter": "error",
|
"@typescript-eslint/prefer-reduce-type-parameter": "error",
|
||||||
"@typescript-eslint/prefer-ts-expect-error": "error",
|
"@typescript-eslint/prefer-ts-expect-error": "error",
|
||||||
@ -319,7 +334,7 @@
|
|||||||
],
|
],
|
||||||
"@typescript-eslint/restrict-plus-operands": [
|
"@typescript-eslint/restrict-plus-operands": [
|
||||||
"error",
|
"error",
|
||||||
{ "checkCompoundAssignments": true }
|
{ "skipCompoundAssignments": true }
|
||||||
],
|
],
|
||||||
"@typescript-eslint/restrict-template-expressions": [
|
"@typescript-eslint/restrict-template-expressions": [
|
||||||
"error",
|
"error",
|
||||||
|
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. -->
|
<!-- 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
|
## List any relevant issue numbers
|
||||||
|
|
||||||
|
12
.github/workflows/lint.yml
vendored
12
.github/workflows/lint.yml
vendored
@ -10,19 +10,19 @@ jobs:
|
|||||||
lint:
|
lint:
|
||||||
runs-on: 'ubuntu-latest'
|
runs-on: 'ubuntu-latest'
|
||||||
steps:
|
steps:
|
||||||
- uses: 'actions/checkout@v3.0.0'
|
- uses: 'actions/checkout@v3.6.0'
|
||||||
|
|
||||||
- name: 'Use Node.js'
|
- name: 'Setup Node.js'
|
||||||
uses: 'actions/setup-node@v3.1.0'
|
uses: 'actions/setup-node@v3.8.1'
|
||||||
with:
|
with:
|
||||||
node-version: 'lts/*'
|
node-version: 'lts/*'
|
||||||
cache: 'npm'
|
cache: 'npm'
|
||||||
|
|
||||||
- name: 'Install'
|
- name: 'Install dependencies'
|
||||||
run: 'npm install'
|
run: 'npm clean-install'
|
||||||
|
|
||||||
- run: 'npm run lint:commit -- --to "${{ github.sha }}"'
|
- run: 'npm run lint:commit -- --to "${{ github.sha }}"'
|
||||||
- run: 'npm run lint:editorconfig'
|
- run: 'npm run lint:editorconfig'
|
||||||
- run: 'npm run lint:markdown'
|
- run: 'npm run lint:markdown'
|
||||||
- run: 'npm run lint:javascript'
|
- run: 'npm run lint:eslint'
|
||||||
- run: 'npm run lint:prettier'
|
- run: 'npm run lint:prettier'
|
||||||
|
18
.github/workflows/release.yml
vendored
18
.github/workflows/release.yml
vendored
@ -7,20 +7,28 @@ on:
|
|||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
runs-on: 'ubuntu-latest'
|
runs-on: 'ubuntu-latest'
|
||||||
|
permissions:
|
||||||
|
contents: 'write'
|
||||||
|
issues: 'write'
|
||||||
|
pull-requests: 'write'
|
||||||
|
id-token: 'write'
|
||||||
steps:
|
steps:
|
||||||
- uses: 'actions/checkout@v3.0.0'
|
- uses: 'actions/checkout@v3.6.0'
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
|
|
||||||
- name: 'Use Node.js'
|
- name: 'Setup Node.js'
|
||||||
uses: 'actions/setup-node@v3.1.0'
|
uses: 'actions/setup-node@v3.8.1'
|
||||||
with:
|
with:
|
||||||
node-version: 'lts/*'
|
node-version: 'lts/*'
|
||||||
cache: 'npm'
|
cache: 'npm'
|
||||||
|
|
||||||
- name: 'Install'
|
- name: 'Install dependencies'
|
||||||
run: 'npm install'
|
run: 'npm clean-install'
|
||||||
|
|
||||||
|
- name: 'Verify the integrity of provenance attestations and registry signatures for installed dependencies'
|
||||||
|
run: 'npm audit signatures'
|
||||||
|
|
||||||
- name: 'Release'
|
- name: 'Release'
|
||||||
run: 'npm run release'
|
run: 'npm run release'
|
||||||
|
10
.github/workflows/test.yml
vendored
10
.github/workflows/test.yml
vendored
@ -10,16 +10,16 @@ jobs:
|
|||||||
test:
|
test:
|
||||||
runs-on: 'ubuntu-latest'
|
runs-on: 'ubuntu-latest'
|
||||||
steps:
|
steps:
|
||||||
- uses: 'actions/checkout@v3.0.0'
|
- uses: 'actions/checkout@v3.6.0'
|
||||||
|
|
||||||
- name: 'Use Node.js'
|
- name: 'Setup Node.js'
|
||||||
uses: 'actions/setup-node@v3.1.0'
|
uses: 'actions/setup-node@v3.8.1'
|
||||||
with:
|
with:
|
||||||
node-version: 'lts/*'
|
node-version: 'lts/*'
|
||||||
cache: 'npm'
|
cache: 'npm'
|
||||||
|
|
||||||
- name: 'Install'
|
- name: 'Install dependencies'
|
||||||
run: 'npm install'
|
run: 'npm clean-install'
|
||||||
|
|
||||||
- name: 'Test'
|
- name: 'Test'
|
||||||
run: 'npm run test'
|
run: 'npm run test'
|
||||||
|
@ -1,10 +1,11 @@
|
|||||||
{
|
{
|
||||||
"config": {
|
"config": {
|
||||||
|
"extends": "markdownlint/style/prettier",
|
||||||
|
"relative-links": true,
|
||||||
"default": true,
|
"default": true,
|
||||||
"MD013": false,
|
"MD033": false
|
||||||
"MD033": false,
|
|
||||||
"MD041": false
|
|
||||||
},
|
},
|
||||||
"globs": ["**/*.{md,mdx}"],
|
"globs": ["**/*.{md,mdx}"],
|
||||||
"ignores": ["**/node_modules"]
|
"ignores": ["**/node_modules"],
|
||||||
|
"customRules": ["markdownlint-rule-relative-links"]
|
||||||
}
|
}
|
||||||
|
8
.taprc
8
.taprc
@ -1,8 +0,0 @@
|
|||||||
ts: false
|
|
||||||
jsx: false
|
|
||||||
flow: false
|
|
||||||
check-coverage: true
|
|
||||||
coverage: true
|
|
||||||
|
|
||||||
test-ignore:
|
|
||||||
- 'test/fixtures'
|
|
@ -60,7 +60,7 @@ representative at an online or offline event.
|
|||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
||||||
reported to the community leaders responsible for enforcement at
|
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 complaints will be reviewed and investigated promptly and fairly.
|
||||||
|
|
||||||
All community leaders are obligated to respect the privacy and security of the
|
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**! 🎉
|
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
|
## Types of contributions
|
||||||
|
|
||||||
- Reporting a bug.
|
- Reporting a bug.
|
||||||
@ -11,7 +19,7 @@ Thanks a lot for your interest in contributing to **eslint-config-conventions**!
|
|||||||
|
|
||||||
## Pull Requests
|
## 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.
|
- Ensure your code respect linting.
|
||||||
|
|
||||||
@ -21,26 +29,4 @@ If you're adding new features to **eslint-config-conventions**, please include t
|
|||||||
|
|
||||||
## Commits
|
## 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.
|
The commit message guidelines adheres to [Conventional Commits](https://www.conventionalcommits.org/) 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.
|
|
||||||
|
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
|||||||
MIT License
|
MIT License
|
||||||
|
|
||||||
Copyright (c) Divlo
|
Copyright (c) Théo LUDWIG
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
40
README.md
40
README.md
@ -11,8 +11,8 @@
|
|||||||
<a href="./LICENSE"><img src="https://img.shields.io/badge/licence-MIT-blue.svg" alt="Licence MIT"/></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>
|
<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 />
|
<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/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" /></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/test.yml"><img src="https://github.com/theoludwig/eslint-config-conventions/actions/workflows/test.yml/badge.svg?branch=develop" /></a>
|
||||||
<br />
|
<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://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>
|
<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>
|
||||||
@ -31,24 +31,19 @@ More information about **formatting rules** vs **code-quality rules** can be fou
|
|||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- [Node.js](https://nodejs.org/) >= 16.0.0
|
[Node.js](https://nodejs.org/) >= 18.0.0
|
||||||
|
|
||||||
### Installation
|
### 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
|
```sh
|
||||||
npm install --save-dev \
|
npm install --save-dev \
|
||||||
eslint@^8.9.0 \
|
eslint@^8.51.0 \
|
||||||
eslint-plugin-import@^2.26.0 \
|
eslint-plugin-import@^2.28.1 \
|
||||||
eslint-plugin-promise@^6.0.0 \
|
eslint-plugin-promise@^6.1.1 \
|
||||||
eslint-plugin-unicorn@^44.0.0 \
|
eslint-plugin-unicorn@^48.0.1 \
|
||||||
eslint-config-conventions@latest
|
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:
|
This list of dependencies are:
|
||||||
|
|
||||||
- [ESLint](https://github.com/eslint/eslint)
|
- [ESLint](https://github.com/eslint/eslint)
|
||||||
@ -62,16 +57,16 @@ If you want to use **TypeScript**, you also need to install:
|
|||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm install --save-dev \
|
npm install --save-dev \
|
||||||
typescript@^4.8.2 \
|
typescript@^5.2.2 \
|
||||||
@typescript-eslint/eslint-plugin@^5.36.1 \
|
@typescript-eslint/eslint-plugin@^6.8.0 \
|
||||||
@typescript-eslint/parser@^5.36.1
|
@typescript-eslint/parser@^6.8.0
|
||||||
```
|
```
|
||||||
|
|
||||||
Dependencies are:
|
Dependencies are:
|
||||||
|
|
||||||
- [TypeScript](https://github.com/Microsoft/TypeScript)
|
- [TypeScript](https://github.com/Microsoft/TypeScript)
|
||||||
- [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint); ESLint rules 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.
|
- [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint): ESLint parser for TypeScript.
|
||||||
|
|
||||||
### Configuration with [Prettier](https://prettier.io/) (recommended)
|
### 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
|
# Create an empty config file to let editors and other tools know you are using Prettier
|
||||||
# You can personalize it with your own rules
|
# You can personalize it with your own rules
|
||||||
echo {}> .prettierrc.json
|
echo "{}" > .prettierrc.json
|
||||||
```
|
```
|
||||||
|
|
||||||
#### `.eslintrc.json`
|
#### `.eslintrc.json`
|
||||||
@ -91,6 +86,7 @@ echo {}> .prettierrc.json
|
|||||||
{
|
{
|
||||||
"extends": ["conventions", "prettier"],
|
"extends": ["conventions", "prettier"],
|
||||||
"plugins": ["prettier"],
|
"plugins": ["prettier"],
|
||||||
|
"parser": "@typescript-eslint/parser",
|
||||||
"parserOptions": {
|
"parserOptions": {
|
||||||
"project": "./tsconfig.json"
|
"project": "./tsconfig.json"
|
||||||
},
|
},
|
||||||
@ -109,8 +105,8 @@ echo {}> .prettierrc.json
|
|||||||
```jsonc
|
```jsonc
|
||||||
{
|
{
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"lint:typescript": "eslint \"**/*.{js,jsx,ts,tsx}\" --ignore-path \".gitignore\"",
|
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --ignore-path .gitignore",
|
||||||
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\""
|
"lint:prettier": "prettier . --check"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@ -118,9 +114,9 @@ echo {}> .prettierrc.json
|
|||||||
### Usage
|
### Usage
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
npm run lint:typescript
|
npm run lint:eslint
|
||||||
# or to apply automatic fixes to code
|
# 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
|
# Validate code formatting in all supported languages by Prettier
|
||||||
npm run lint:prettier
|
npm run lint:prettier
|
||||||
|
19825
package-lock.json
generated
19825
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
67
package.json
67
package.json
@ -3,16 +3,16 @@
|
|||||||
"version": "0.0.0-development",
|
"version": "0.0.0-development",
|
||||||
"public": true,
|
"public": true,
|
||||||
"description": "ESLint shareable config to enforce strict conventions and good code quality.",
|
"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",
|
"license": "MIT",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/Divlo/eslint-config-conventions.git"
|
"url": "https://github.com/theoludwig/eslint-config-conventions.git"
|
||||||
},
|
},
|
||||||
"bugs": {
|
"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": [
|
"keywords": [
|
||||||
"eslintconfig",
|
"eslintconfig",
|
||||||
"eslint",
|
"eslint",
|
||||||
@ -27,48 +27,53 @@
|
|||||||
"index.js",
|
"index.js",
|
||||||
".eslintrc.json"
|
".eslintrc.json"
|
||||||
],
|
],
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public",
|
||||||
|
"provenance": true
|
||||||
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=16.0.0",
|
"node": ">=18.0.0",
|
||||||
"npm": ">=8.0.0"
|
"npm": ">=9.0.0"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"lint:commit": "commitlint",
|
"lint:commit": "commitlint",
|
||||||
"lint:editorconfig": "editorconfig-checker",
|
"lint:editorconfig": "editorconfig-checker",
|
||||||
"lint:markdown": "markdownlint-cli2",
|
"lint:markdown": "markdownlint-cli2",
|
||||||
"lint:javascript": "eslint \"**/*.{js,jsx,ts,tsx}\" -c \"eslintrc.json\"",
|
"lint:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json",
|
||||||
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
|
"lint:prettier": "prettier . --check",
|
||||||
"lint:staged": "lint-staged",
|
"lint:staged": "lint-staged",
|
||||||
"test": "tap",
|
"test": "node --test test/",
|
||||||
"release": "semantic-release",
|
"release": "semantic-release",
|
||||||
"postinstall": "husky install",
|
"postinstall": "husky install",
|
||||||
"prepublishOnly": "pinst --disable",
|
"prepublishOnly": "pinst --disable",
|
||||||
"postpublish": "pinst --enable"
|
"postpublish": "pinst --enable"
|
||||||
},
|
},
|
||||||
"peerDependencies": {
|
"peerDependencies": {
|
||||||
"eslint": "^8.9.0",
|
"eslint": "^8.51.0",
|
||||||
"eslint-plugin-import": "^2.26.0",
|
"eslint-plugin-import": "^2.28.1",
|
||||||
"eslint-plugin-promise": "^6.0.0",
|
"eslint-plugin-promise": "^6.1.1",
|
||||||
"eslint-plugin-unicorn": "^44.0.0"
|
"eslint-plugin-unicorn": "^48.0.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@commitlint/cli": "17.1.2",
|
"@commitlint/cli": "17.8.0",
|
||||||
"@commitlint/config-conventional": "17.1.0",
|
"@commitlint/config-conventional": "17.8.0",
|
||||||
"@types/eslint": "8.4.6",
|
"@tsconfig/strictest": "2.0.2",
|
||||||
"@types/tap": "15.0.7",
|
"@types/eslint": "8.44.5",
|
||||||
"@typescript-eslint/eslint-plugin": "5.39.0",
|
"@types/node": "20.8.7",
|
||||||
"@typescript-eslint/parser": "5.39.0",
|
"@typescript-eslint/eslint-plugin": "6.8.0",
|
||||||
"editorconfig-checker": "4.0.2",
|
"@typescript-eslint/parser": "6.8.0",
|
||||||
"eslint": "8.24.0",
|
"editorconfig-checker": "5.1.1",
|
||||||
"eslint-plugin-import": "2.26.0",
|
"eslint": "8.51.0",
|
||||||
"eslint-plugin-promise": "6.0.1",
|
"eslint-plugin-import": "2.28.1",
|
||||||
"eslint-plugin-unicorn": "44.0.0",
|
"eslint-plugin-promise": "6.1.1",
|
||||||
"husky": "8.0.1",
|
"eslint-plugin-unicorn": "48.0.1",
|
||||||
"lint-staged": "13.0.3",
|
"husky": "8.0.3",
|
||||||
"markdownlint-cli2": "0.5.1",
|
"lint-staged": "15.0.1",
|
||||||
|
"markdownlint-cli2": "0.10.0",
|
||||||
|
"markdownlint-rule-relative-links": "2.1.0",
|
||||||
"pinst": "3.0.0",
|
"pinst": "3.0.0",
|
||||||
"prettier": "2.7.1",
|
"prettier": "3.0.3",
|
||||||
"semantic-release": "19.0.5",
|
"semantic-release": "22.0.5",
|
||||||
"tap": "16.3.0",
|
"typescript": "5.2.2"
|
||||||
"typescript": "4.8.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) => {
|
const isObject = (object) => {
|
||||||
return typeof object === 'object' && object !== null
|
return typeof object === 'object' && object !== null
|
||||||
}
|
}
|
||||||
|
|
||||||
tap.test('test basic properties of config', async (t) => {
|
test('test basic properties of config', async () => {
|
||||||
t.ok(isObject(config.parserOptions))
|
assert.ok(isObject(config))
|
||||||
t.ok(isObject(config.env))
|
assert.ok(isObject(config.parserOptions))
|
||||||
t.ok(isObject(config.rules))
|
assert.ok(isObject(config.env))
|
||||||
t.ok(isObject(config.overrides))
|
assert.ok(isObject(config.rules))
|
||||||
|
assert.ok(isObject(config.overrides))
|
||||||
})
|
})
|
||||||
|
@ -1,5 +1,7 @@
|
|||||||
|
const test = require('node:test')
|
||||||
|
const assert = require('node:assert/strict')
|
||||||
|
|
||||||
const { ESLint } = require('eslint')
|
const { ESLint } = require('eslint')
|
||||||
const tap = require('tap')
|
|
||||||
|
|
||||||
const eslint = new ESLint({
|
const eslint = new ESLint({
|
||||||
ignore: false,
|
ignore: false,
|
||||||
@ -7,31 +9,31 @@ const eslint = new ESLint({
|
|||||||
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(
|
const [noErrors] = await eslint.lintFiles(
|
||||||
'test/fixtures/javascript-no-errors.js'
|
'test/fixtures/javascript-no-errors.js'
|
||||||
)
|
)
|
||||||
const [withErrors] = await eslint.lintFiles(
|
const [withErrors] = await eslint.lintFiles(
|
||||||
'test/fixtures/javascript-with-errors.js'
|
'test/fixtures/javascript-with-errors.js'
|
||||||
)
|
)
|
||||||
t.equal(noErrors.errorCount, 0)
|
assert.strictEqual(noErrors?.errorCount, 0)
|
||||||
t.equal(withErrors.errorCount, 3)
|
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(
|
const [noErrors] = await eslint.lintFiles(
|
||||||
'test/fixtures/typescript-no-errors.ts'
|
'test/fixtures/typescript-no-errors.ts'
|
||||||
)
|
)
|
||||||
const [withErrors] = await eslint.lintFiles(
|
const [withErrors] = await eslint.lintFiles(
|
||||||
'test/fixtures/javascript-with-errors.js'
|
'test/fixtures/javascript-with-errors.js'
|
||||||
)
|
)
|
||||||
t.equal(noErrors.errorCount, 0)
|
assert.strictEqual(noErrors?.errorCount, 0)
|
||||||
t.equal(withErrors.errorCount, 3)
|
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(
|
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)
|
||||||
})
|
})
|
||||||
|
@ -1,12 +1,11 @@
|
|||||||
{
|
{
|
||||||
|
"extends": "@tsconfig/strictest/tsconfig.json",
|
||||||
"compilerOptions": {
|
"compilerOptions": {
|
||||||
|
"resolveJsonModule": true,
|
||||||
"target": "ESNext",
|
"target": "ESNext",
|
||||||
"module": "commonjs",
|
"module": "commonjs",
|
||||||
"lib": ["ESNext"],
|
"lib": ["ESNext"],
|
||||||
"moduleResolution": "node",
|
"moduleResolution": "node",
|
||||||
"rootDir": "./",
|
"rootDir": "./"
|
||||||
"strict": true,
|
|
||||||
"skipLibCheck": true,
|
|
||||||
"esModuleInterop": true
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user