@nfq/eslint-config 3.1.0 → 3.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/README.md +99 -0
- package/package.json +11 -11
- package/rules/best-practices.js +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,20 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
### [3.1.2](https://github.com/nfqde/eslint-config-nfq/compare/v3.1.1...v3.1.2) (2023-12-17)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Bug Fixes
|
|
9
|
+
|
|
10
|
+
* **Package:** Update package ([#56](https://github.com/nfqde/eslint-config-nfq/issues/56)) ([1314b91](https://github.com/nfqde/eslint-config-nfq/commit/1314b9195b1006d40870b7161d86133f98c05385))
|
|
11
|
+
|
|
12
|
+
### [3.1.1](https://github.com/nfqde/eslint-config-nfq/compare/v3.1.0...v3.1.1) (2023-10-09)
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
### Bug Fixes
|
|
16
|
+
|
|
17
|
+
* **Grid:** add grid color functions to no magic numbers exceptions ([#54](https://github.com/nfqde/eslint-config-nfq/issues/54)) ([9ab7276](https://github.com/nfqde/eslint-config-nfq/commit/9ab7276a9ad844fee3f65993ff81382ece3984bb))
|
|
18
|
+
|
|
5
19
|
## [3.1.0](https://github.com/nfqde/eslint-config-nfq/compare/v3.0.3...v3.1.0) (2023-10-05)
|
|
6
20
|
|
|
7
21
|
|
package/README.md
ADDED
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
<div id="top"></div>
|
|
2
|
+
|
|
3
|
+
# eslint-config-nfq
|
|
4
|
+
|
|
5
|
+
[](https://github.com/nfqde/eslint-config-nfq/actions/workflows/eslint.yml)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
1. [Description](#description)
|
|
10
|
+
2. [Getting started](#getting-started)
|
|
11
|
+
1. [Installation](#installation)
|
|
12
|
+
2. [PeerDependencies](#peerdependencies)
|
|
13
|
+
3. [Usage](#usage)
|
|
14
|
+
4. [Props](#props)
|
|
15
|
+
5. [Support](#support)
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Description: [](https://opensource.org/licenses/MIT)
|
|
20
|
+
|
|
21
|
+
This is a comprehensive ESLint configuration used by .NFQ. It includes a wide range of rules for JavaScript, TypeScript, React, and more.
|
|
22
|
+
|
|
23
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Getting started
|
|
28
|
+
|
|
29
|
+
To setup the project locally follow the next steps:
|
|
30
|
+
|
|
31
|
+
### Installation
|
|
32
|
+
|
|
33
|
+
To install the package run
|
|
34
|
+
```sh
|
|
35
|
+
npm install <Project name>
|
|
36
|
+
```
|
|
37
|
+
if you are on yarn
|
|
38
|
+
```sh
|
|
39
|
+
yarn add <Project name>
|
|
40
|
+
```
|
|
41
|
+
or on pnpm
|
|
42
|
+
```sh
|
|
43
|
+
pnpm install <Project name>
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### PeerDependencies:
|
|
47
|
+
|
|
48
|
+
The following PeerDependencies are needed so the component does work:
|
|
49
|
+
|
|
50
|
+
- eslint-import-resolver-alias >= 1
|
|
51
|
+
- eslint-plugin-array-func >= 3
|
|
52
|
+
- eslint-plugin-better-styled-components >= 1
|
|
53
|
+
- eslint-plugin-import >= 2
|
|
54
|
+
- eslint-plugin-jsdoc >= 43
|
|
55
|
+
- eslint-plugin-jsx-a11y >= 6
|
|
56
|
+
- eslint-plugin-no-unsanitized >= 4
|
|
57
|
+
- eslint-plugin-node >= 11
|
|
58
|
+
- eslint-plugin-perf-standard >= 1
|
|
59
|
+
- eslint-plugin-promise >= 6
|
|
60
|
+
- eslint-plugin-react >= 7
|
|
61
|
+
- eslint-plugin-react-hooks >= 4
|
|
62
|
+
- eslint-plugin-react-hooks-ssr >= 0.1.5
|
|
63
|
+
- eslint-plugin-redos >= 4
|
|
64
|
+
- eslint-plugin-security >= 1
|
|
65
|
+
- eslint-plugin-sort-destructure-keys >= 1
|
|
66
|
+
|
|
67
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
## Usage
|
|
72
|
+
|
|
73
|
+
After installing the package and its peer dependencies, you can use it in your ESLint configuration file:
|
|
74
|
+
|
|
75
|
+
```json
|
|
76
|
+
{
|
|
77
|
+
"extends": [
|
|
78
|
+
"@nfq"
|
|
79
|
+
]
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Rules
|
|
88
|
+
|
|
89
|
+
This configuration includes a wide range of rules for JavaScript, TypeScript, React, and more. You can find the specific rules in the rules directory.
|
|
90
|
+
|
|
91
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## Support
|
|
96
|
+
|
|
97
|
+
Christoph Kruppe - [https://github.com/ckruppe] - c.kruppe@nfq.de
|
|
98
|
+
|
|
99
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nfq/eslint-config",
|
|
3
|
-
"version": "3.1.
|
|
3
|
+
"version": "3.1.2",
|
|
4
4
|
"engines": {
|
|
5
5
|
"node": ">= 12.0.0"
|
|
6
6
|
},
|
|
@@ -49,18 +49,18 @@
|
|
|
49
49
|
"confusing-browser-globals": "^1.0.11"
|
|
50
50
|
},
|
|
51
51
|
"devDependencies": {
|
|
52
|
-
"@babel/core": "^7.
|
|
53
|
-
"@babel/eslint-parser": "^7.
|
|
52
|
+
"@babel/core": "^7.23.6",
|
|
53
|
+
"@babel/eslint-parser": "^7.23.3",
|
|
54
54
|
"@nfq/eslint-plugin": "^0.7.1",
|
|
55
|
-
"@typescript-eslint/eslint-plugin": "^6.
|
|
56
|
-
"@typescript-eslint/parser": "^6.
|
|
57
|
-
"eslint": "^8.
|
|
55
|
+
"@typescript-eslint/eslint-plugin": "^6.14.0",
|
|
56
|
+
"@typescript-eslint/parser": "^6.14.0",
|
|
57
|
+
"eslint": "^8.56.0",
|
|
58
58
|
"eslint-import-resolver-alias": "^1.1.2",
|
|
59
|
-
"eslint-plugin-array-func": "^
|
|
59
|
+
"eslint-plugin-array-func": "^4.0.0",
|
|
60
60
|
"eslint-plugin-better-styled-components": "^1.1.2",
|
|
61
|
-
"eslint-plugin-import": "^2.
|
|
62
|
-
"eslint-plugin-jsdoc": "^46.
|
|
63
|
-
"eslint-plugin-jsx-a11y": "^6.
|
|
61
|
+
"eslint-plugin-import": "^2.29.1",
|
|
62
|
+
"eslint-plugin-jsdoc": "^46.9.1",
|
|
63
|
+
"eslint-plugin-jsx-a11y": "^6.8.0",
|
|
64
64
|
"eslint-plugin-no-unsanitized": "^4.0.2",
|
|
65
65
|
"eslint-plugin-node": "^11.1.0",
|
|
66
66
|
"eslint-plugin-perf-standard": "^1.0.3",
|
|
@@ -69,7 +69,7 @@
|
|
|
69
69
|
"eslint-plugin-react-hooks": "^4.6.0",
|
|
70
70
|
"eslint-plugin-react-hooks-ssr": "^0.1.5",
|
|
71
71
|
"eslint-plugin-redos": "4.4.5",
|
|
72
|
-
"eslint-plugin-security": "^1.
|
|
72
|
+
"eslint-plugin-security": "^2.1.0",
|
|
73
73
|
"eslint-plugin-sort-destructure-keys": "^1.5.0",
|
|
74
74
|
"standard-version": "^9.5.0"
|
|
75
75
|
},
|
package/rules/best-practices.js
CHANGED
|
@@ -10,7 +10,7 @@ module.exports = {
|
|
|
10
10
|
ignore: [0, 1],
|
|
11
11
|
ignoreArrayIndexes: true,
|
|
12
12
|
ignoreArrays: true,
|
|
13
|
-
ignoreFunctions: ['setTimeout', 'setInterval', 'spacing', 'wait']
|
|
13
|
+
ignoreFunctions: ['darken', 'lighten', 'setTimeout', 'setInterval', 'spacing', 'translucify', 'wait']
|
|
14
14
|
}
|
|
15
15
|
], // disallow magic numbers http://eslint.org/docs/rules/no-magic-numbers
|
|
16
16
|
'accessor-pairs': [
|