mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-05-18 12:02:33 +02:00
Compare commits
28 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
|
@ -4,10 +4,10 @@
|
||||
"env": {
|
||||
"browser": true,
|
||||
"node": true,
|
||||
"es2022": true
|
||||
"es2024": true
|
||||
},
|
||||
"parserOptions": {
|
||||
"ecmaVersion": 2022,
|
||||
"ecmaVersion": "latest",
|
||||
"sourceType": "module",
|
||||
"ecmaFeatures": {
|
||||
"jsx": true
|
||||
@ -112,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",
|
||||
@ -175,17 +175,32 @@
|
||||
|
||||
"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-array-push-push": "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 +211,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",
|
||||
@ -253,6 +266,7 @@
|
||||
"error",
|
||||
"interface"
|
||||
],
|
||||
"no-duplicate-imports": "off",
|
||||
"@typescript-eslint/consistent-type-imports": "error",
|
||||
"@typescript-eslint/explicit-function-return-type": [
|
||||
"error",
|
||||
@ -305,6 +319,7 @@
|
||||
"@typescript-eslint/prefer-nullish-coalescing": [
|
||||
"error",
|
||||
{
|
||||
"ignoreTernaryTests": true,
|
||||
"ignoreConditionalTests": false,
|
||||
"ignoreMixedLogicalExpressions": false
|
||||
}
|
||||
@ -319,7 +334,7 @@
|
||||
],
|
||||
"@typescript-eslint/restrict-plus-operands": [
|
||||
"error",
|
||||
{ "checkCompoundAssignments": true }
|
||||
{ "skipCompoundAssignments": true }
|
||||
],
|
||||
"@typescript-eslint/restrict-template-expressions": [
|
||||
"error",
|
||||
|
4
.github/workflows/lint.yml
vendored
4
.github/workflows/lint.yml
vendored
@ -10,10 +10,10 @@ jobs:
|
||||
lint:
|
||||
runs-on: 'ubuntu-latest'
|
||||
steps:
|
||||
- uses: 'actions/checkout@v3.5.2'
|
||||
- uses: 'actions/checkout@v3.6.0'
|
||||
|
||||
- name: 'Setup Node.js'
|
||||
uses: 'actions/setup-node@v3.6.0'
|
||||
uses: 'actions/setup-node@v3.8.1'
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
|
4
.github/workflows/release.yml
vendored
4
.github/workflows/release.yml
vendored
@ -13,13 +13,13 @@ jobs:
|
||||
pull-requests: 'write'
|
||||
id-token: 'write'
|
||||
steps:
|
||||
- uses: 'actions/checkout@v3.5.2'
|
||||
- uses: 'actions/checkout@v3.6.0'
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: 'Setup Node.js'
|
||||
uses: 'actions/setup-node@v3.6.0'
|
||||
uses: 'actions/setup-node@v3.8.1'
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
|
4
.github/workflows/test.yml
vendored
4
.github/workflows/test.yml
vendored
@ -10,10 +10,10 @@ jobs:
|
||||
test:
|
||||
runs-on: 'ubuntu-latest'
|
||||
steps:
|
||||
- uses: 'actions/checkout@v3.5.2'
|
||||
- uses: 'actions/checkout@v3.6.0'
|
||||
|
||||
- name: 'Setup Node.js'
|
||||
uses: 'actions/setup-node@v3.6.0'
|
||||
uses: 'actions/setup-node@v3.8.1'
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
|
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
|
||||
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.
|
||||
|
||||
|
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
|
||||
|
34
README.md
34
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="./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" /></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 />
|
||||
<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>
|
||||
@ -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.33.0 \
|
||||
eslint-plugin-import@^2.27.5 \
|
||||
eslint@^8.51.0 \
|
||||
eslint-plugin-import@^2.28.1 \
|
||||
eslint-plugin-promise@^6.1.1 \
|
||||
eslint-plugin-unicorn@^47.0.0 \
|
||||
eslint-plugin-unicorn@^48.0.1 \
|
||||
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@^5.0.4 \
|
||||
@typescript-eslint/eslint-plugin@^5.59.5 \
|
||||
@typescript-eslint/parser@^5.59.5
|
||||
typescript@^5.2.2 \
|
||||
@typescript-eslint/eslint-plugin@^6.8.0 \
|
||||
@typescript-eslint/parser@^6.8.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: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"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
7779
package-lock.json
generated
7779
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
57
package.json
57
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,48 @@
|
||||
"provenance": true
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=16.0.0",
|
||||
"node": ">=18.0.0",
|
||||
"npm": ">=9.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:eslint": "eslint . --max-warnings 0 --report-unused-disable-directives --config eslintrc.json",
|
||||
"lint:prettier": "prettier . --check",
|
||||
"lint:staged": "lint-staged",
|
||||
"test": "tap",
|
||||
"test": "node --test test/",
|
||||
"release": "semantic-release",
|
||||
"postinstall": "husky install",
|
||||
"prepublishOnly": "pinst --disable",
|
||||
"postpublish": "pinst --enable"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"eslint": "^8.33.0",
|
||||
"eslint-plugin-import": "^2.27.5",
|
||||
"eslint": "^8.51.0",
|
||||
"eslint-plugin-import": "^2.28.1",
|
||||
"eslint-plugin-promise": "^6.1.1",
|
||||
"eslint-plugin-unicorn": "^47.0.0"
|
||||
"eslint-plugin-unicorn": "^48.0.1"
|
||||
},
|
||||
"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",
|
||||
"@commitlint/cli": "17.8.0",
|
||||
"@commitlint/config-conventional": "17.8.0",
|
||||
"@tsconfig/strictest": "2.0.2",
|
||||
"@types/eslint": "8.44.5",
|
||||
"@types/node": "20.8.7",
|
||||
"@typescript-eslint/eslint-plugin": "6.8.0",
|
||||
"@typescript-eslint/parser": "6.8.0",
|
||||
"editorconfig-checker": "5.1.1",
|
||||
"eslint": "8.51.0",
|
||||
"eslint-plugin-import": "2.28.1",
|
||||
"eslint-plugin-promise": "6.1.1",
|
||||
"eslint-plugin-unicorn": "47.0.0",
|
||||
"eslint-plugin-unicorn": "48.0.1",
|
||||
"husky": "8.0.3",
|
||||
"lint-staged": "13.2.2",
|
||||
"markdownlint-cli2": "0.7.1",
|
||||
"markdownlint-rule-relative-links": "1.1.2",
|
||||
"lint-staged": "15.0.1",
|
||||
"markdownlint-cli2": "0.10.0",
|
||||
"markdownlint-rule-relative-links": "2.1.0",
|
||||
"pinst": "3.0.0",
|
||||
"prettier": "2.8.8",
|
||||
"semantic-release": "21.0.2",
|
||||
"tap": "16.3.4",
|
||||
"typescript": "5.0.4"
|
||||
"prettier": "3.0.3",
|
||||
"semantic-release": "22.0.5",
|
||||
"typescript": "5.2.2"
|
||||
}
|
||||
}
|
||||
|
@ -1,14 +1,20 @@
|
||||
const tap = require('tap')
|
||||
const test = require('node:test')
|
||||
const assert = require('node:assert/strict')
|
||||
|
||||
const config = require('../index.js')
|
||||
|
||||
/**
|
||||
* @param {unknown} object
|
||||
* @returns {boolean}
|
||||
*/
|
||||
const isObject = (object) => {
|
||||
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))
|
||||
})
|
||||
|
@ -1,5 +1,7 @@
|
||||
const test = require('node:test')
|
||||
const assert = require('node:assert/strict')
|
||||
|
||||
const { ESLint } = require('eslint')
|
||||
const tap = require('tap')
|
||||
|
||||
const eslint = new ESLint({
|
||||
ignore: false,
|
||||
@ -7,31 +9,31 @@ const eslint = new ESLint({
|
||||
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'
|
||||
)
|
||||
const [withErrors] = await eslint.lintFiles(
|
||||
'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'
|
||||
)
|
||||
const [withErrors] = await eslint.lintFiles(
|
||||
'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'
|
||||
)
|
||||
t.equal(lintResult.errorCount, 0)
|
||||
assert.strictEqual(lintResult?.errorCount, 0)
|
||||
})
|
||||
|
@ -1,6 +1,7 @@
|
||||
{
|
||||
"extends": "@tsconfig/strictest/tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"resolveJsonModule": true,
|
||||
"target": "ESNext",
|
||||
"module": "commonjs",
|
||||
"lib": ["ESNext"],
|
||||
|
Reference in New Issue
Block a user