@studio/eslint-config 2.3.0 β 3.0.0
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/CHANGES.md +9 -0
- package/README.md +4 -1
- package/index.js +22 -2
- package/package.json +4 -2
package/CHANGES.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changes
|
|
2
2
|
|
|
3
|
+
## 3.0.0
|
|
4
|
+
|
|
5
|
+
- π₯ [`6e2362c`](https://github.com/javascript-studio/eslint-config/commit/6e2362c41507b6b1c46f8af026db72d6845f9d87)
|
|
6
|
+
Configure JSDoc
|
|
7
|
+
- π‘ [`c62cbcf`](https://github.com/javascript-studio/eslint-config/commit/c62cbcf20738962ca3b1ba98333988fcfae12cb3)
|
|
8
|
+
Bump minimist from 1.2.5 to 1.2.6 (dependabot[bot])
|
|
9
|
+
|
|
10
|
+
_Released by [Maximilian Antoni](https://github.com/mantoni) on 2022-07-21._
|
|
11
|
+
|
|
3
12
|
## 2.3.0
|
|
4
13
|
|
|
5
14
|
- π [`bed55ec`](https://github.com/javascript-studio/eslint-config/commit/bed55ec462bab33db91990721e69201b00c598b6)
|
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ The [sharable eslint config][docs] for all JavaScript Studio projects.
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
$ npm install @studio/eslint-config eslint eslint-plugin-mocha eslint-plugin-node --save-dev
|
|
8
|
+
$ npm install @studio/eslint-config eslint eslint-plugin-mocha eslint-plugin-jsdoc eslint-plugin-node --save-dev
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
## Usage
|
|
@@ -20,6 +20,8 @@ Make sure this is in your `package.json`:
|
|
|
20
20
|
}
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
+
This configuration works great with [`@studio/tsconfig`][tsconfig].
|
|
24
|
+
|
|
23
25
|
__Pro tipβ’:__ Check out [eslint_d][] for faster editor integration.
|
|
24
26
|
|
|
25
27
|
## License
|
|
@@ -29,4 +31,5 @@ MIT
|
|
|
29
31
|
<div align="center">Made with β€οΈ on π</div>
|
|
30
32
|
|
|
31
33
|
[docs]: http://eslint.org/docs/developer-guide/shareable-configs
|
|
34
|
+
[tsconfig]: https://github.com/javascript-studio/tsconfig
|
|
32
35
|
[eslint_d]: https://www.npmjs.com/package/eslint_d
|
package/index.js
CHANGED
|
@@ -15,14 +15,25 @@ module.exports = {
|
|
|
15
15
|
},
|
|
16
16
|
|
|
17
17
|
plugins: [
|
|
18
|
-
'mocha'
|
|
18
|
+
'mocha',
|
|
19
|
+
'jsdoc'
|
|
19
20
|
],
|
|
20
21
|
|
|
21
22
|
extends: [
|
|
22
23
|
'eslint:recommended',
|
|
23
|
-
'plugin:node/recommended'
|
|
24
|
+
'plugin:node/recommended',
|
|
25
|
+
'plugin:jsdoc/recommended'
|
|
24
26
|
],
|
|
25
27
|
|
|
28
|
+
settings: {
|
|
29
|
+
jsdoc: {
|
|
30
|
+
mode: 'typescript',
|
|
31
|
+
preferredTypes: {
|
|
32
|
+
object: 'Object'
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
|
|
26
37
|
overrides: [{
|
|
27
38
|
files: [
|
|
28
39
|
'**/*.test.js',
|
|
@@ -43,6 +54,15 @@ module.exports = {
|
|
|
43
54
|
'mocha/no-return-and-callback': 2,
|
|
44
55
|
'mocha/prefer-arrow-callback': 2,
|
|
45
56
|
|
|
57
|
+
// https://github.com/gajus/eslint-plugin-jsdoc
|
|
58
|
+
'jsdoc/require-jsdoc': 'off',
|
|
59
|
+
'jsdoc/require-param-description': 'off',
|
|
60
|
+
'jsdoc/require-returns-description': 'off',
|
|
61
|
+
'jsdoc/require-property-description': 'off',
|
|
62
|
+
'jsdoc/check-indentation': 'warn',
|
|
63
|
+
'jsdoc/check-line-alignment': 'warn',
|
|
64
|
+
'jsdoc/require-hyphen-before-param-description': 'warn',
|
|
65
|
+
|
|
46
66
|
// https://github.com/mysticatea/eslint-plugin-node
|
|
47
67
|
'node/handle-callback-err': 2,
|
|
48
68
|
'node/no-callback-literal': 2,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@studio/eslint-config",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.0",
|
|
4
4
|
"description": "The JavaScript Studio sharable eslint config",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"author": "Maximilian Antoni <max@javascript.studio>",
|
|
@@ -16,8 +16,10 @@
|
|
|
16
16
|
},
|
|
17
17
|
"peerDependencies": {
|
|
18
18
|
"eslint": "^7 || ^8",
|
|
19
|
+
"eslint-plugin-jsdoc": "^39",
|
|
19
20
|
"eslint-plugin-mocha": "^8 || ^9 || ^10",
|
|
20
|
-
"eslint-plugin-node": "^11"
|
|
21
|
+
"eslint-plugin-node": "^11",
|
|
22
|
+
"jsdoc": "^3"
|
|
21
23
|
},
|
|
22
24
|
"repository": {
|
|
23
25
|
"type": "git",
|