@davidsneighbour/eslint-config 5.6.0 → 5.7.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.
Files changed (3) hide show
  1. package/LICENSE.md +1 -1
  2. package/index.js +54 -1
  3. package/package.json +11 -10
package/LICENSE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2023 Patrick Kollitsch / David's Neighbour
3
+ Copyright (c) 2024 Patrick Kollitsch / David's Neighbour
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
6
 
package/index.js CHANGED
@@ -25,6 +25,7 @@ export default [
25
25
  'sonarjs',
26
26
  // https://github.com/sindresorhus/eslint-plugin-unicorn
27
27
  "unicorn",
28
+ "jsdoc",
28
29
  "plugin:perfectionist/recommended-natural"
29
30
  ],
30
31
  ignorePatterns: [
@@ -53,7 +54,8 @@ export default [
53
54
  'plugin:@typescript-eslint/recommended',
54
55
  'plugin:sonarjs/recommended',
55
56
  'plugin:package-json/recommended',
56
- 'plugin:toml/standard'
57
+ 'plugin:toml/standard',
58
+ "plugin:jsdoc/recommended-error"
57
59
  ],
58
60
  rules: {
59
61
  "indent": ["error", "tab"],
@@ -64,6 +66,57 @@ export default [
64
66
  '@typescript-eslint/ban-ts-comment': 0,
65
67
  'import/no-unresolved': 'off',
66
68
  '@typescript-eslint/no-var-requires': 'off',
69
+
70
+ //////////////////////////////////////////////
71
+ // "jsdoc/check-access": 1, // Recommended
72
+ // "jsdoc/check-alignment": 1, // Recommended
73
+ // "jsdoc/check-examples": 1,
74
+ // "jsdoc/check-indentation": 1,
75
+ // "jsdoc/check-line-alignment": 1,
76
+ // "jsdoc/check-param-names": 1, // Recommended
77
+ // "jsdoc/check-property-names": 1, // Recommended
78
+ // "jsdoc/check-syntax": 1,
79
+ // "jsdoc/check-tag-names": 1, // Recommended
80
+ // "jsdoc/check-types": 1, // Recommended
81
+ // "jsdoc/check-values": 1, // Recommended
82
+ // "jsdoc/empty-tags": 1, // Recommended
83
+ // "jsdoc/implements-on-classes": 1, // Recommended
84
+ // "jsdoc/informative-docs": 1,
85
+ // "jsdoc/match-description": 1,
86
+ // "jsdoc/multiline-blocks": 1, // Recommended
87
+ // "jsdoc/no-bad-blocks": 1,
88
+ // "jsdoc/no-blank-block-descriptions": 1,
89
+ // "jsdoc/no-defaults": 1,
90
+ // "jsdoc/no-missing-syntax": 1,
91
+ // "jsdoc/no-multi-asterisks": 1, // Recommended
92
+ // "jsdoc/no-restricted-syntax": 1,
93
+ // "jsdoc/no-types": 1,
94
+ // "jsdoc/no-undefined-types": 1, // Recommended
95
+ // "jsdoc/require-asterisk-prefix": 1,
96
+ // "jsdoc/require-description": 1,
97
+ // "jsdoc/require-description-complete-sentence": 1,
98
+ // "jsdoc/require-example": 1,
99
+ // "jsdoc/require-file-overview": 1,
100
+ // "jsdoc/require-hyphen-before-param-description": 1,
101
+ // "jsdoc/require-jsdoc": 1, // Recommended
102
+ // "jsdoc/require-param": 1, // Recommended
103
+ // "jsdoc/require-param-description": 1, // Recommended
104
+ // "jsdoc/require-param-name": 1, // Recommended
105
+ // "jsdoc/require-param-type": 1, // Recommended
106
+ // "jsdoc/require-property": 1, // Recommended
107
+ // "jsdoc/require-property-description": 1, // Recommended
108
+ // "jsdoc/require-property-name": 1, // Recommended
109
+ // "jsdoc/require-property-type": 1, // Recommended
110
+ // "jsdoc/require-returns": 1, // Recommended
111
+ // "jsdoc/require-returns-check": 1, // Recommended
112
+ // "jsdoc/require-returns-description": 1, // Recommended
113
+ // "jsdoc/require-returns-type": 1, // Recommended
114
+ // "jsdoc/require-throws": 1,
115
+ // "jsdoc/require-yields": 1, // Recommended
116
+ // "jsdoc/require-yields-check": 1, // Recommended
117
+ // "jsdoc/sort-tags": 1,
118
+ // "jsdoc/tag-lines": 1, // Recommended
119
+ // "jsdoc/valid-types": 1 // Recommended
67
120
  },
68
121
  overrides: [
69
122
  {
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "@davidsneighbour/eslint-config",
3
3
  "description": "ESlint configuration for use in davidsneighbour projects.",
4
- "version": "5.6.0",
4
+ "version": "5.7.0",
5
5
  "license": "MIT",
6
6
  "repository": "davidsneighbour/configurations",
7
7
  "author": "Patrick Kollitsch <patrick@davids-neighbour.com> (https://davids-neighbour.com)",
8
8
  "bugs": "https://github.com/davidsneighbour/configurations/issues",
9
9
  "homepage": "https://github.com/davidsneighbour/configurations/tree/main/packages/eslint-config",
10
10
  "dependencies": {
11
- "@typescript-eslint/eslint-plugin": "6.17.0",
12
- "@typescript-eslint/parser": "6.17.0",
11
+ "@typescript-eslint/eslint-plugin": "6.18.1",
12
+ "@typescript-eslint/parser": "6.18.1",
13
13
  "eslint": "8.56.0",
14
- "eslint-config-airbnb": ">=19.0.4",
14
+ "eslint-config-airbnb": "19.0.4",
15
15
  "eslint-config-airbnb-base": "15.0.0",
16
16
  "eslint-config-prettier": "9.1.0",
17
17
  "eslint-plugin-anti-trojan-source": "1.1.1",
@@ -19,16 +19,17 @@
19
19
  "eslint-plugin-cypress": "2.15.1",
20
20
  "eslint-plugin-html": "7.1.0",
21
21
  "eslint-plugin-import": "2.29.1",
22
- "eslint-plugin-jsx-a11y": ">=6.8.0",
22
+ "eslint-plugin-jsdoc": "48.0.2",
23
+ "eslint-plugin-jsx-a11y": "6.8.0",
23
24
  "eslint-plugin-markdown": "3.0.1",
24
- "eslint-plugin-mdx": "3.1.2",
25
+ "eslint-plugin-mdx": "3.1.3",
25
26
  "eslint-plugin-no-loops": "0.3.0",
26
27
  "eslint-plugin-package-json": "0.3.2",
27
28
  "eslint-plugin-prettier": "5.1.2",
28
- "eslint-plugin-react": ">=7.33.2",
29
- "eslint-plugin-react-hooks": ">=4.6.0",
29
+ "eslint-plugin-react": "7.33.2",
30
+ "eslint-plugin-react-hooks": "4.6.0",
30
31
  "eslint-plugin-sonarjs": "0.23.0",
31
- "eslint-plugin-unicorn": "49.0.0"
32
+ "eslint-plugin-unicorn": "50.0.1"
32
33
  },
33
34
  "scripts": {
34
35
  "fixpack": "fixpack",
@@ -39,7 +40,7 @@
39
40
  "node": ">=20.9.0",
40
41
  "npm": ">=10.1.0"
41
42
  },
42
- "gitHead": "4df9fd35af6c06fb4081457af3b89499e4a6a46e",
43
+ "gitHead": "b1d4374381d25e060d2f3d48eb5446a7d3f306df",
43
44
  "devDependencies": {
44
45
  "eslint": "^8.56.0",
45
46
  "eslint-plugin-toml": "^0.8.0"