@component-hook/eslint-plugin 1.1.1 → 1.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.
Files changed (4) hide show
  1. package/README.md +16 -15
  2. package/dist/index.d.ts +73 -0
  3. package/dist/index.js +27 -0
  4. package/package.json +16 -15
package/README.md CHANGED
@@ -86,21 +86,21 @@ export default vuePreset;
86
86
 
87
87
  ## Configs
88
88
 
89
- | Name | Type | Reference |
90
- | ----------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
91
- | basic | `Linter.Config[]` | `eslint-recommended`, `typescript-eslint`, `eslint-plugin-eslint-comments`, `eslint-plugin-import`, `eslint-plugin-unicorn`, `eslint-plugin-regexp`, `eslint-plugin-de-morgan`, `eslint-plugin-perfectionist` |
92
- | vue | `Linter.Config[]` | `eslint-plugin-vue`, `typescript-eslint` |
93
- | react | `Linter.Config[]` | `eslint-plugin-react/recommended`, `eslint-plugin-react-hooks/recommended`, `eslint-plugin-jsx-a11y/recommended` |
94
- | markdown | `Linter.Config[]` | `eslint-plugin-markdown/recommended` |
95
- | prettier | `Linter.Config` | `eslint-plugin-prettier/recommended` |
96
- | sonarjs | `Linter.Config[]` | `eslint-plugin-sonarjs/recommended` |
97
- | security | `Linter.Config` | `eslint-plugin-security/recommended` |
98
- | playwright | `Linter.Config` | `eslint-plugin-playwright/flat/recommended` |
99
- | testing-library/dom | `Linter.Config` | `eslint-plugin-testing-library/dom` |
100
- | testing-library/vue | `Linter.Config` | `eslint-plugin-testing-library/vue` |
101
- | testing-library/react | `Linter.Config` | `eslint-plugin-testing-library/react` |
102
- | testing-library/angular | `Linter.Config` | `eslint-plugin-testing-library/angular` |
103
- | testing-library/marko | `Linter.Config` | `eslint-plugin-testing-library/marko` |
89
+ | Name | Type | Reference |
90
+ | ----------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
91
+ | basic | `Linter.Config[]` | `eslint-recommended`, `typescript-eslint`, `eslint-plugin-eslint-comments`, `eslint-plugin-import`, `eslint-plugin-unicorn`, `eslint-plugin-jsdoc`, `eslint-plugin-regexp`, `eslint-plugin-de-morgan`, `eslint-plugin-perfectionist` |
92
+ | vue | `Linter.Config[]` | `eslint-plugin-vue`, `typescript-eslint` |
93
+ | react | `Linter.Config[]` | `eslint-plugin-react/recommended`, `eslint-plugin-react-hooks/recommended`, `eslint-plugin-jsx-a11y/recommended` |
94
+ | markdown | `Linter.Config[]` | `eslint-plugin-markdown/recommended` |
95
+ | prettier | `Linter.Config` | `eslint-plugin-prettier/recommended` |
96
+ | sonarjs | `Linter.Config[]` | `eslint-plugin-sonarjs/recommended` |
97
+ | security | `Linter.Config` | `eslint-plugin-security/recommended` |
98
+ | playwright | `Linter.Config` | `eslint-plugin-playwright/flat/recommended` |
99
+ | testing-library/dom | `Linter.Config` | `eslint-plugin-testing-library/dom` |
100
+ | testing-library/vue | `Linter.Config` | `eslint-plugin-testing-library/vue` |
101
+ | testing-library/react | `Linter.Config` | `eslint-plugin-testing-library/react` |
102
+ | testing-library/angular | `Linter.Config` | `eslint-plugin-testing-library/angular` |
103
+ | testing-library/marko | `Linter.Config` | `eslint-plugin-testing-library/marko` |
104
104
 
105
105
  ## Reference eslint plugin
106
106
 
@@ -111,6 +111,7 @@ export default vuePreset;
111
111
  - [eslint-plugin-unicorn](https://github.com/sindresorhus/eslint-plugin-unicorn)
112
112
  - [eslint-plugin-regexp/flat/recommended](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/configs/flat/recommended.ts)
113
113
  - [eslint-plugin-de-morgan](https://github.com/azat-io/eslint-plugin-de-morgan/blob/main/index.ts)
114
+ - [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc)
114
115
  - [eslint-plugin-perfectionist](https://github.com/azat-io/eslint-plugin-perfectionist)
115
116
  - [eslint-plugin-prettier/recommended](https://github.com/prettier/eslint-plugin-prettier/blob/master/recommended.js)
116
117
  - [eslint-plugin-react/recommended](https://github.com/jsx-eslint/eslint-plugin-react/blob/master/configs/recommended.js)
package/dist/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  import * as eslint_plugin_security from 'eslint-plugin-security';
2
+ import * as eslint_plugin_jsdoc from 'eslint-plugin-jsdoc';
2
3
  import * as eslint from 'eslint';
3
4
 
4
5
  declare const _default: {
@@ -102,6 +103,30 @@ declare const _default: {
102
103
  'unicorn/prefer-type-error': string;
103
104
  'unicorn/throw-new-error': string;
104
105
  };
106
+ } | {
107
+ name: string;
108
+ plugins: {
109
+ jsdoc: eslint.ESLint.Plugin & {
110
+ configs: Record<`flat/${eslint_plugin_jsdoc.ConfigGroups}${eslint_plugin_jsdoc.ConfigVariants}${eslint_plugin_jsdoc.ErrorLevelVariants}`, eslint.Linter.Config>;
111
+ };
112
+ };
113
+ rules: {
114
+ 'jsdoc/check-access': string;
115
+ 'jsdoc/check-param-names': string;
116
+ 'jsdoc/check-property-names': string;
117
+ 'jsdoc/check-types': string;
118
+ 'jsdoc/empty-tags': string;
119
+ 'jsdoc/implements-on-classes': string;
120
+ 'jsdoc/no-defaults': string;
121
+ 'jsdoc/no-multi-asterisks': string;
122
+ 'jsdoc/require-param-name': string;
123
+ 'jsdoc/require-property': string;
124
+ 'jsdoc/require-property-description': string;
125
+ 'jsdoc/require-property-name': string;
126
+ 'jsdoc/require-returns-check': string;
127
+ 'jsdoc/require-returns-description': string;
128
+ 'jsdoc/require-yields-check': string;
129
+ };
105
130
  } | {
106
131
  name: string;
107
132
  ignores: string[];
@@ -1404,6 +1429,30 @@ declare const reactPreset: ({
1404
1429
  'unicorn/prefer-type-error': string;
1405
1430
  'unicorn/throw-new-error': string;
1406
1431
  };
1432
+ } | {
1433
+ name: string;
1434
+ plugins: {
1435
+ jsdoc: eslint.ESLint.Plugin & {
1436
+ configs: Record<`flat/${eslint_plugin_jsdoc.ConfigGroups}${eslint_plugin_jsdoc.ConfigVariants}${eslint_plugin_jsdoc.ErrorLevelVariants}`, eslint.Linter.Config>;
1437
+ };
1438
+ };
1439
+ rules: {
1440
+ 'jsdoc/check-access': string;
1441
+ 'jsdoc/check-param-names': string;
1442
+ 'jsdoc/check-property-names': string;
1443
+ 'jsdoc/check-types': string;
1444
+ 'jsdoc/empty-tags': string;
1445
+ 'jsdoc/implements-on-classes': string;
1446
+ 'jsdoc/no-defaults': string;
1447
+ 'jsdoc/no-multi-asterisks': string;
1448
+ 'jsdoc/require-param-name': string;
1449
+ 'jsdoc/require-property': string;
1450
+ 'jsdoc/require-property-description': string;
1451
+ 'jsdoc/require-property-name': string;
1452
+ 'jsdoc/require-returns-check': string;
1453
+ 'jsdoc/require-returns-description': string;
1454
+ 'jsdoc/require-yields-check': string;
1455
+ };
1407
1456
  } | {
1408
1457
  name: string;
1409
1458
  ignores: string[];
@@ -2680,6 +2729,30 @@ declare const vuePreset: ({
2680
2729
  'unicorn/prefer-type-error': string;
2681
2730
  'unicorn/throw-new-error': string;
2682
2731
  };
2732
+ } | {
2733
+ name: string;
2734
+ plugins: {
2735
+ jsdoc: eslint.ESLint.Plugin & {
2736
+ configs: Record<`flat/${eslint_plugin_jsdoc.ConfigGroups}${eslint_plugin_jsdoc.ConfigVariants}${eslint_plugin_jsdoc.ErrorLevelVariants}`, eslint.Linter.Config>;
2737
+ };
2738
+ };
2739
+ rules: {
2740
+ 'jsdoc/check-access': string;
2741
+ 'jsdoc/check-param-names': string;
2742
+ 'jsdoc/check-property-names': string;
2743
+ 'jsdoc/check-types': string;
2744
+ 'jsdoc/empty-tags': string;
2745
+ 'jsdoc/implements-on-classes': string;
2746
+ 'jsdoc/no-defaults': string;
2747
+ 'jsdoc/no-multi-asterisks': string;
2748
+ 'jsdoc/require-param-name': string;
2749
+ 'jsdoc/require-property': string;
2750
+ 'jsdoc/require-property-description': string;
2751
+ 'jsdoc/require-property-name': string;
2752
+ 'jsdoc/require-returns-check': string;
2753
+ 'jsdoc/require-returns-description': string;
2754
+ 'jsdoc/require-yields-check': string;
2755
+ };
2683
2756
  } | {
2684
2757
  name: string;
2685
2758
  ignores: string[];
package/dist/index.js CHANGED
@@ -21,6 +21,7 @@ import { default as default19 } from "@eslint-community/eslint-plugin-eslint-com
21
21
  import { default as default20 } from "eslint-plugin-unicorn";
22
22
  import { default as default21 } from "eslint-plugin-de-morgan";
23
23
  import { default as default22 } from "eslint-plugin-perfectionist";
24
+ import { default as default23 } from "eslint-plugin-jsdoc";
24
25
 
25
26
  // configs/comments.ts
26
27
  var commentsConfigs = [
@@ -151,6 +152,31 @@ var jsConfigs = [
151
152
  }
152
153
  ];
153
154
 
155
+ // configs/jsdoc.ts
156
+ var jsdocConfig = {
157
+ name: "component-hook/jsdoc",
158
+ plugins: {
159
+ jsdoc: default23
160
+ },
161
+ rules: {
162
+ "jsdoc/check-access": "warn",
163
+ "jsdoc/check-param-names": "warn",
164
+ "jsdoc/check-property-names": "warn",
165
+ "jsdoc/check-types": "warn",
166
+ "jsdoc/empty-tags": "warn",
167
+ "jsdoc/implements-on-classes": "warn",
168
+ "jsdoc/no-defaults": "warn",
169
+ "jsdoc/no-multi-asterisks": "warn",
170
+ "jsdoc/require-param-name": "warn",
171
+ "jsdoc/require-property": "warn",
172
+ "jsdoc/require-property-description": "warn",
173
+ "jsdoc/require-property-name": "warn",
174
+ "jsdoc/require-returns-check": "warn",
175
+ "jsdoc/require-returns-description": "warn",
176
+ "jsdoc/require-yields-check": "warn"
177
+ }
178
+ };
179
+
154
180
  // configs/markdown.ts
155
181
  var markdownConfigs = default18.configs.recommended.map((config) => {
156
182
  const { name, rules: rules5 } = config;
@@ -560,6 +586,7 @@ var basicConfigs = [
560
586
  ...commentsConfigs,
561
587
  ...importConfigs,
562
588
  unicornConfig,
589
+ jsdocConfig,
563
590
  regexpConfig,
564
591
  deMorganConfig,
565
592
  perfectionistConfig,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@component-hook/eslint-plugin",
3
- "version": "1.1.1",
3
+ "version": "1.1.2",
4
4
  "description": "ESLint config for component hook",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -34,30 +34,31 @@
34
34
  },
35
35
  "dependencies": {
36
36
  "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
37
- "@eslint/compat": "^1.2.9",
38
- "@eslint/js": "^9.26.0",
37
+ "@eslint/compat": "^1.3.1",
38
+ "@eslint/js": "^9.29.0",
39
39
  "eslint-config-prettier": "^10.1.5",
40
- "eslint-plugin-de-morgan": "^1.2.1",
41
- "eslint-plugin-import": "^2.31.0",
40
+ "eslint-plugin-de-morgan": "^1.3.0",
41
+ "eslint-plugin-import": "^2.32.0",
42
+ "eslint-plugin-jsdoc": "^51.2.3",
42
43
  "eslint-plugin-jsx-a11y": "^6.10.2",
43
44
  "eslint-plugin-markdown": "^5.1.0",
44
- "eslint-plugin-perfectionist": "^4.12.3",
45
+ "eslint-plugin-perfectionist": "^4.15.0",
45
46
  "eslint-plugin-playwright": "^2.2.0",
46
- "eslint-plugin-prettier": "^5.4.0",
47
+ "eslint-plugin-prettier": "^5.5.1",
47
48
  "eslint-plugin-react": "^7.37.5",
48
49
  "eslint-plugin-react-hooks": "^5.2.0",
49
- "eslint-plugin-regexp": "^2.7.0",
50
+ "eslint-plugin-regexp": "^2.9.0",
50
51
  "eslint-plugin-security": "^3.0.1",
51
- "eslint-plugin-sonarjs": "^3.0.2",
52
- "eslint-plugin-testing-library": "^7.1.1",
52
+ "eslint-plugin-sonarjs": "^3.0.4",
53
+ "eslint-plugin-testing-library": "^7.5.3",
53
54
  "eslint-plugin-unicorn": "^59.0.1",
54
- "eslint-plugin-vue": "^10.1.0",
55
- "globals": "^16.1.0",
56
- "typescript-eslint": "^8.32.1",
57
- "vue-eslint-parser": "^10.1.3"
55
+ "eslint-plugin-vue": "^10.2.0",
56
+ "globals": "^16.2.0",
57
+ "typescript-eslint": "^8.35.0",
58
+ "vue-eslint-parser": "^10.1.4"
58
59
  },
59
60
  "devDependencies": {
60
- "@eslint/config-inspector": "^1.0.2",
61
+ "@eslint/config-inspector": "^1.1.0",
61
62
  "@types/eslint": "^9.6.1",
62
63
  "@types/eslint-plugin-security": "^3.0.0",
63
64
  "@types/eslint__js": "^9.14.0"