mirror of
https://github.com/theoludwig/eslint-config-conventions.git
synced 2025-05-18 12:02:33 +02:00
Compare commits
16 Commits
Author | SHA1 | Date | |
---|---|---|---|
fcc107bdec | |||
666a3dee2d | |||
0ce46310ed | |||
e2b2c1c77f | |||
846a25943d | |||
e0f93343fe | |||
c3b46debe6 | |||
c0ec89ed0c | |||
099a3388a1 | |||
1f20fe89e8 | |||
3f1d1921ba | |||
b743c94430 | |||
f138acaf53 | |||
435d3e9e5f | |||
637a79a8e7 | |||
61679195ee |
@ -145,6 +145,11 @@
|
||||
"quote-props": ["error", "as-needed"],
|
||||
"radix": "error",
|
||||
"yoda": ["error", "never"],
|
||||
"curly": ["error", "all"],
|
||||
"func-style": ["error", "expression"],
|
||||
"prefer-arrow-callback": "error",
|
||||
"arrow-parens": ["error", "always"],
|
||||
"arrow-body-style": ["error", "always"],
|
||||
|
||||
"import/no-absolute-path": "error",
|
||||
"import/no-webpack-loader-syntax": "error",
|
||||
@ -176,7 +181,8 @@
|
||||
"unicorn/no-this-assignment": "error",
|
||||
"unicorn/no-zero-fractions": "error",
|
||||
"unicorn/prefer-node-protocol": "error",
|
||||
"unicorn/throw-new-error": "error"
|
||||
"unicorn/throw-new-error": "error",
|
||||
"unicorn/no-typeof-undefined": "error"
|
||||
},
|
||||
"overrides": [
|
||||
{
|
||||
@ -247,6 +253,7 @@
|
||||
"error",
|
||||
"interface"
|
||||
],
|
||||
"@typescript-eslint/consistent-type-imports": "error",
|
||||
"@typescript-eslint/explicit-function-return-type": [
|
||||
"error",
|
||||
{
|
||||
@ -275,10 +282,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",
|
||||
@ -306,7 +309,6 @@
|
||||
"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",
|
||||
|
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@v2.4.0'
|
||||
- uses: 'actions/checkout@v3.0.0'
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
uses: 'actions/setup-node@v3.1.0'
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
|
4
.github/workflows/release.yml
vendored
4
.github/workflows/release.yml
vendored
@ -8,13 +8,13 @@ jobs:
|
||||
release:
|
||||
runs-on: 'ubuntu-latest'
|
||||
steps:
|
||||
- uses: 'actions/checkout@v2.4.0'
|
||||
- uses: 'actions/checkout@v3.0.0'
|
||||
with:
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
uses: 'actions/setup-node@v3.1.0'
|
||||
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@v2.4.0'
|
||||
- uses: 'actions/checkout@v3.0.0'
|
||||
|
||||
- name: 'Use Node.js'
|
||||
uses: 'actions/setup-node@v2.5.1'
|
||||
uses: 'actions/setup-node@v3.1.0'
|
||||
with:
|
||||
node-version: 'lts/*'
|
||||
cache: 'npm'
|
||||
|
@ -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"]
|
||||
}
|
||||
|
10
.markdownlint-cli2.jsonc
Normal file
10
.markdownlint-cli2.jsonc
Normal file
@ -0,0 +1,10 @@
|
||||
{
|
||||
"config": {
|
||||
"default": true,
|
||||
"MD013": false,
|
||||
"MD033": false,
|
||||
"MD041": false
|
||||
},
|
||||
"globs": ["**/*.{md,mdx}"],
|
||||
"ignores": ["**/node_modules"]
|
||||
}
|
@ -1,6 +0,0 @@
|
||||
{
|
||||
"default": true,
|
||||
"MD013": false,
|
||||
"MD033": false,
|
||||
"MD041": false
|
||||
}
|
12
README.md
12
README.md
@ -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).
|
||||
|
||||
@ -41,9 +41,9 @@ Here is an example, but use it only for reference, because your decisions regard
|
||||
```sh
|
||||
npm install --save-dev \
|
||||
eslint@^8.9.0 \
|
||||
eslint-plugin-import@^2.25.4 \
|
||||
eslint-plugin-import@^2.26.0 \
|
||||
eslint-plugin-promise@^6.0.0 \
|
||||
eslint-plugin-unicorn@^41.0.0 \
|
||||
eslint-plugin-unicorn@^45.0.0 \
|
||||
eslint-config-conventions@latest
|
||||
```
|
||||
|
||||
@ -62,9 +62,9 @@ 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@^4.8.2 \
|
||||
@typescript-eslint/eslint-plugin@^5.36.1 \
|
||||
@typescript-eslint/parser@^5.36.1
|
||||
```
|
||||
|
||||
Dependencies are:
|
||||
|
7100
package-lock.json
generated
7100
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
44
package.json
44
package.json
@ -23,6 +23,10 @@
|
||||
"conventions"
|
||||
],
|
||||
"main": "index.js",
|
||||
"files": [
|
||||
"index.js",
|
||||
".eslintrc.json"
|
||||
],
|
||||
"engines": {
|
||||
"node": ">=16.0.0",
|
||||
"npm": ">=8.0.0"
|
||||
@ -30,7 +34,7 @@
|
||||
"scripts": {
|
||||
"lint:commit": "commitlint",
|
||||
"lint:editorconfig": "editorconfig-checker",
|
||||
"lint:markdown": "markdownlint \"**/*.md\" --dot --ignore-path \".gitignore\"",
|
||||
"lint:markdown": "markdownlint-cli2",
|
||||
"lint:javascript": "eslint \"**/*.{js,jsx,ts,tsx}\" -c \"eslintrc.json\"",
|
||||
"lint:prettier": "prettier \".\" --check --ignore-path \".gitignore\"",
|
||||
"lint:staged": "lint-staged",
|
||||
@ -42,29 +46,29 @@
|
||||
},
|
||||
"peerDependencies": {
|
||||
"eslint": "^8.9.0",
|
||||
"eslint-plugin-import": "^2.25.4",
|
||||
"eslint-plugin-import": "^2.26.0",
|
||||
"eslint-plugin-promise": "^6.0.0",
|
||||
"eslint-plugin-unicorn": "^41.0.0"
|
||||
"eslint-plugin-unicorn": "^45.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "16.2.3",
|
||||
"@commitlint/config-conventional": "16.2.1",
|
||||
"@types/eslint": "8.4.1",
|
||||
"@types/tap": "15.0.6",
|
||||
"@typescript-eslint/eslint-plugin": "5.15.0",
|
||||
"@typescript-eslint/parser": "5.15.0",
|
||||
"@commitlint/cli": "17.2.0",
|
||||
"@commitlint/config-conventional": "17.2.0",
|
||||
"@types/eslint": "8.4.10",
|
||||
"@types/tap": "15.0.7",
|
||||
"@typescript-eslint/eslint-plugin": "5.43.0",
|
||||
"@typescript-eslint/parser": "5.43.0",
|
||||
"editorconfig-checker": "4.0.2",
|
||||
"eslint": "8.11.0",
|
||||
"eslint-plugin-import": "2.25.4",
|
||||
"eslint-plugin-promise": "6.0.0",
|
||||
"eslint-plugin-unicorn": "41.0.1",
|
||||
"husky": "7.0.4",
|
||||
"lint-staged": "12.3.7",
|
||||
"markdownlint-cli": "0.31.1",
|
||||
"eslint": "8.28.0",
|
||||
"eslint-plugin-import": "2.26.0",
|
||||
"eslint-plugin-promise": "6.1.1",
|
||||
"eslint-plugin-unicorn": "45.0.0",
|
||||
"husky": "8.0.2",
|
||||
"lint-staged": "13.0.3",
|
||||
"markdownlint-cli2": "0.5.1",
|
||||
"pinst": "3.0.0",
|
||||
"prettier": "2.6.0",
|
||||
"semantic-release": "19.0.2",
|
||||
"tap": "16.0.0",
|
||||
"typescript": "4.6.2"
|
||||
"prettier": "2.7.1",
|
||||
"semantic-release": "19.0.5",
|
||||
"tap": "16.3.2",
|
||||
"typescript": "4.9.3"
|
||||
}
|
||||
}
|
||||
|
@ -2,13 +2,13 @@ const tap = require('tap')
|
||||
|
||||
const config = require('../index.js')
|
||||
|
||||
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))
|
||||
})
|
||||
|
||||
function isObject(object) {
|
||||
return typeof object === 'object' && object !== null
|
||||
}
|
||||
|
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)
|
||||
|
Reference in New Issue
Block a user