eslint-plugin-tsdoc-require-2 1.2.1 → 1.2.3
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/README.md +103 -101
- package/dist/internal/require-tag-factory.cjs +40 -48
- package/dist/internal/require-tag-factory.d.ts +7 -8
- package/dist/internal/require-tag-factory.d.ts.map +1 -1
- package/dist/internal/require-tag-factory.js +41 -49
- package/dist/internal/require-tag-factory.js.map +1 -1
- package/dist/plugin.cjs +9 -2
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +9 -2
- package/dist/plugin.js.map +1 -1
- package/dist/rules/require-tag-rules.js +112 -112
- package/dist/rules/require.cjs +39 -47
- package/dist/rules/require.d.ts +3 -3
- package/dist/rules/require.d.ts.map +1 -1
- package/dist/rules/require.js +40 -48
- package/dist/rules/require.js.map +1 -1
- package/dist/rules/required-tags/require-abstract.cjs +1 -3
- package/dist/rules/required-tags/require-abstract.d.ts.map +1 -1
- package/dist/rules/required-tags/require-abstract.js +1 -3
- package/dist/rules/required-tags/require-abstract.js.map +1 -1
- package/dist/rules/required-tags/require-alpha.cjs +1 -3
- package/dist/rules/required-tags/require-alpha.d.ts.map +1 -1
- package/dist/rules/required-tags/require-alpha.js +1 -3
- package/dist/rules/required-tags/require-alpha.js.map +1 -1
- package/dist/rules/required-tags/require-author.cjs +1 -3
- package/dist/rules/required-tags/require-author.d.ts.map +1 -1
- package/dist/rules/required-tags/require-author.js +1 -3
- package/dist/rules/required-tags/require-author.js.map +1 -1
- package/dist/rules/required-tags/require-beta.cjs +1 -3
- package/dist/rules/required-tags/require-beta.d.ts.map +1 -1
- package/dist/rules/required-tags/require-beta.js +1 -3
- package/dist/rules/required-tags/require-beta.js.map +1 -1
- package/dist/rules/required-tags/require-category.cjs +1 -3
- package/dist/rules/required-tags/require-category.d.ts.map +1 -1
- package/dist/rules/required-tags/require-category.js +1 -3
- package/dist/rules/required-tags/require-category.js.map +1 -1
- package/dist/rules/required-tags/require-class.cjs +1 -3
- package/dist/rules/required-tags/require-class.d.ts.map +1 -1
- package/dist/rules/required-tags/require-class.js +1 -3
- package/dist/rules/required-tags/require-class.js.map +1 -1
- package/dist/rules/required-tags/require-decorator.cjs +1 -3
- package/dist/rules/required-tags/require-decorator.d.ts.map +1 -1
- package/dist/rules/required-tags/require-decorator.js +1 -3
- package/dist/rules/required-tags/require-decorator.js.map +1 -1
- package/dist/rules/required-tags/require-default-value.cjs +1 -3
- package/dist/rules/required-tags/require-default-value.d.ts.map +1 -1
- package/dist/rules/required-tags/require-default-value.js +1 -3
- package/dist/rules/required-tags/require-default-value.js.map +1 -1
- package/dist/rules/required-tags/require-deprecated.cjs +1 -3
- package/dist/rules/required-tags/require-deprecated.d.ts.map +1 -1
- package/dist/rules/required-tags/require-deprecated.js +1 -3
- package/dist/rules/required-tags/require-deprecated.js.map +1 -1
- package/dist/rules/required-tags/require-document.cjs +1 -3
- package/dist/rules/required-tags/require-document.d.ts.map +1 -1
- package/dist/rules/required-tags/require-document.js +1 -3
- package/dist/rules/required-tags/require-document.js.map +1 -1
- package/dist/rules/required-tags/require-enum.cjs +1 -3
- package/dist/rules/required-tags/require-enum.d.ts.map +1 -1
- package/dist/rules/required-tags/require-enum.js +1 -3
- package/dist/rules/required-tags/require-enum.js.map +1 -1
- package/dist/rules/required-tags/require-event-property.cjs +1 -3
- package/dist/rules/required-tags/require-event-property.d.ts.map +1 -1
- package/dist/rules/required-tags/require-event-property.js +1 -3
- package/dist/rules/required-tags/require-event-property.js.map +1 -1
- package/dist/rules/required-tags/require-event.cjs +1 -3
- package/dist/rules/required-tags/require-event.d.ts.map +1 -1
- package/dist/rules/required-tags/require-event.js +1 -3
- package/dist/rules/required-tags/require-event.js.map +1 -1
- package/dist/rules/required-tags/require-example.cjs +1 -3
- package/dist/rules/required-tags/require-example.d.ts.map +1 -1
- package/dist/rules/required-tags/require-example.js +1 -3
- package/dist/rules/required-tags/require-example.js.map +1 -1
- package/dist/rules/required-tags/require-expand.cjs +1 -3
- package/dist/rules/required-tags/require-expand.d.ts.map +1 -1
- package/dist/rules/required-tags/require-expand.js +1 -3
- package/dist/rules/required-tags/require-expand.js.map +1 -1
- package/dist/rules/required-tags/require-experimental.cjs +1 -3
- package/dist/rules/required-tags/require-experimental.d.ts.map +1 -1
- package/dist/rules/required-tags/require-experimental.js +1 -3
- package/dist/rules/required-tags/require-experimental.js.map +1 -1
- package/dist/rules/required-tags/require-function.cjs +1 -3
- package/dist/rules/required-tags/require-function.d.ts.map +1 -1
- package/dist/rules/required-tags/require-function.js +1 -3
- package/dist/rules/required-tags/require-function.js.map +1 -1
- package/dist/rules/required-tags/require-group.cjs +1 -3
- package/dist/rules/required-tags/require-group.d.ts.map +1 -1
- package/dist/rules/required-tags/require-group.js +1 -3
- package/dist/rules/required-tags/require-group.js.map +1 -1
- package/dist/rules/required-tags/require-hidden.cjs +1 -3
- package/dist/rules/required-tags/require-hidden.d.ts.map +1 -1
- package/dist/rules/required-tags/require-hidden.js +1 -3
- package/dist/rules/required-tags/require-hidden.js.map +1 -1
- package/dist/rules/required-tags/require-hideconstructor.cjs +1 -3
- package/dist/rules/required-tags/require-hideconstructor.d.ts.map +1 -1
- package/dist/rules/required-tags/require-hideconstructor.js +1 -3
- package/dist/rules/required-tags/require-hideconstructor.js.map +1 -1
- package/dist/rules/required-tags/require-ignore.cjs +1 -3
- package/dist/rules/required-tags/require-ignore.d.ts.map +1 -1
- package/dist/rules/required-tags/require-ignore.js +1 -3
- package/dist/rules/required-tags/require-ignore.js.map +1 -1
- package/dist/rules/required-tags/require-import.cjs +1 -3
- package/dist/rules/required-tags/require-import.d.ts.map +1 -1
- package/dist/rules/required-tags/require-import.js +1 -3
- package/dist/rules/required-tags/require-import.js.map +1 -1
- package/dist/rules/required-tags/require-include.cjs +1 -3
- package/dist/rules/required-tags/require-include.d.ts.map +1 -1
- package/dist/rules/required-tags/require-include.js +1 -3
- package/dist/rules/required-tags/require-include.js.map +1 -1
- package/dist/rules/required-tags/require-inherit-doc.cjs +1 -3
- package/dist/rules/required-tags/require-inherit-doc.d.ts.map +1 -1
- package/dist/rules/required-tags/require-inherit-doc.js +1 -3
- package/dist/rules/required-tags/require-inherit-doc.js.map +1 -1
- package/dist/rules/required-tags/require-inline.cjs +1 -3
- package/dist/rules/required-tags/require-inline.d.ts.map +1 -1
- package/dist/rules/required-tags/require-inline.js +1 -3
- package/dist/rules/required-tags/require-inline.js.map +1 -1
- package/dist/rules/required-tags/require-interface.cjs +1 -3
- package/dist/rules/required-tags/require-interface.d.ts.map +1 -1
- package/dist/rules/required-tags/require-interface.js +1 -3
- package/dist/rules/required-tags/require-interface.js.map +1 -1
- package/dist/rules/required-tags/require-internal.cjs +1 -3
- package/dist/rules/required-tags/require-internal.d.ts.map +1 -1
- package/dist/rules/required-tags/require-internal.js +1 -3
- package/dist/rules/required-tags/require-internal.js.map +1 -1
- package/dist/rules/required-tags/require-label.cjs +1 -3
- package/dist/rules/required-tags/require-label.d.ts.map +1 -1
- package/dist/rules/required-tags/require-label.js +1 -3
- package/dist/rules/required-tags/require-label.js.map +1 -1
- package/dist/rules/required-tags/require-license.cjs +1 -3
- package/dist/rules/required-tags/require-license.d.ts.map +1 -1
- package/dist/rules/required-tags/require-license.js +1 -3
- package/dist/rules/required-tags/require-license.js.map +1 -1
- package/dist/rules/required-tags/require-link.cjs +1 -3
- package/dist/rules/required-tags/require-link.d.ts.map +1 -1
- package/dist/rules/required-tags/require-link.js +1 -3
- package/dist/rules/required-tags/require-link.js.map +1 -1
- package/dist/rules/required-tags/require-merge-module-with.cjs +1 -3
- package/dist/rules/required-tags/require-merge-module-with.d.ts.map +1 -1
- package/dist/rules/required-tags/require-merge-module-with.js +1 -3
- package/dist/rules/required-tags/require-merge-module-with.js.map +1 -1
- package/dist/rules/required-tags/require-module.cjs +1 -3
- package/dist/rules/required-tags/require-module.d.ts.map +1 -1
- package/dist/rules/required-tags/require-module.js +1 -3
- package/dist/rules/required-tags/require-module.js.map +1 -1
- package/dist/rules/required-tags/require-namespace.cjs +1 -3
- package/dist/rules/required-tags/require-namespace.d.ts.map +1 -1
- package/dist/rules/required-tags/require-namespace.js +1 -3
- package/dist/rules/required-tags/require-namespace.js.map +1 -1
- package/dist/rules/required-tags/require-overload.cjs +1 -3
- package/dist/rules/required-tags/require-overload.d.ts.map +1 -1
- package/dist/rules/required-tags/require-overload.js +1 -3
- package/dist/rules/required-tags/require-overload.js.map +1 -1
- package/dist/rules/required-tags/require-override.cjs +1 -3
- package/dist/rules/required-tags/require-override.d.ts.map +1 -1
- package/dist/rules/required-tags/require-override.js +1 -3
- package/dist/rules/required-tags/require-override.js.map +1 -1
- package/dist/rules/required-tags/require-package-documentation.cjs +1 -3
- package/dist/rules/required-tags/require-package-documentation.d.ts.map +1 -1
- package/dist/rules/required-tags/require-package-documentation.js +1 -3
- package/dist/rules/required-tags/require-package-documentation.js.map +1 -1
- package/dist/rules/required-tags/require-param.cjs +1 -3
- package/dist/rules/required-tags/require-param.d.ts.map +1 -1
- package/dist/rules/required-tags/require-param.js +1 -3
- package/dist/rules/required-tags/require-param.js.map +1 -1
- package/dist/rules/required-tags/require-primary-export.cjs +1 -3
- package/dist/rules/required-tags/require-primary-export.d.ts.map +1 -1
- package/dist/rules/required-tags/require-primary-export.js +1 -3
- package/dist/rules/required-tags/require-primary-export.js.map +1 -1
- package/dist/rules/required-tags/require-private-remarks.cjs +1 -3
- package/dist/rules/required-tags/require-private-remarks.d.ts.map +1 -1
- package/dist/rules/required-tags/require-private-remarks.js +1 -3
- package/dist/rules/required-tags/require-private-remarks.js.map +1 -1
- package/dist/rules/required-tags/require-private.cjs +1 -3
- package/dist/rules/required-tags/require-private.d.ts.map +1 -1
- package/dist/rules/required-tags/require-private.js +1 -3
- package/dist/rules/required-tags/require-private.js.map +1 -1
- package/dist/rules/required-tags/require-property.cjs +1 -3
- package/dist/rules/required-tags/require-property.d.ts.map +1 -1
- package/dist/rules/required-tags/require-property.js +1 -3
- package/dist/rules/required-tags/require-property.js.map +1 -1
- package/dist/rules/required-tags/require-protected.cjs +1 -3
- package/dist/rules/required-tags/require-protected.d.ts.map +1 -1
- package/dist/rules/required-tags/require-protected.js +1 -3
- package/dist/rules/required-tags/require-protected.js.map +1 -1
- package/dist/rules/required-tags/require-public.cjs +1 -3
- package/dist/rules/required-tags/require-public.d.ts.map +1 -1
- package/dist/rules/required-tags/require-public.js +1 -3
- package/dist/rules/required-tags/require-public.js.map +1 -1
- package/dist/rules/required-tags/require-readonly.cjs +1 -3
- package/dist/rules/required-tags/require-readonly.d.ts.map +1 -1
- package/dist/rules/required-tags/require-readonly.js +1 -3
- package/dist/rules/required-tags/require-readonly.js.map +1 -1
- package/dist/rules/required-tags/require-remarks.cjs +1 -3
- package/dist/rules/required-tags/require-remarks.d.ts.map +1 -1
- package/dist/rules/required-tags/require-remarks.js +1 -3
- package/dist/rules/required-tags/require-remarks.js.map +1 -1
- package/dist/rules/required-tags/require-returns.cjs +1 -3
- package/dist/rules/required-tags/require-returns.d.ts.map +1 -1
- package/dist/rules/required-tags/require-returns.js +1 -3
- package/dist/rules/required-tags/require-returns.js.map +1 -1
- package/dist/rules/required-tags/require-sealed.cjs +1 -3
- package/dist/rules/required-tags/require-sealed.d.ts.map +1 -1
- package/dist/rules/required-tags/require-sealed.js +1 -3
- package/dist/rules/required-tags/require-sealed.js.map +1 -1
- package/dist/rules/required-tags/require-see.cjs +1 -3
- package/dist/rules/required-tags/require-see.d.ts.map +1 -1
- package/dist/rules/required-tags/require-see.js +1 -3
- package/dist/rules/required-tags/require-see.js.map +1 -1
- package/dist/rules/required-tags/require-since.cjs +1 -3
- package/dist/rules/required-tags/require-since.d.ts.map +1 -1
- package/dist/rules/required-tags/require-since.js +1 -3
- package/dist/rules/required-tags/require-since.js.map +1 -1
- package/dist/rules/required-tags/require-sort-strategy.cjs +1 -3
- package/dist/rules/required-tags/require-sort-strategy.d.ts.map +1 -1
- package/dist/rules/required-tags/require-sort-strategy.js +1 -3
- package/dist/rules/required-tags/require-sort-strategy.js.map +1 -1
- package/dist/rules/required-tags/require-summary.cjs +1 -3
- package/dist/rules/required-tags/require-summary.d.ts.map +1 -1
- package/dist/rules/required-tags/require-summary.js +1 -3
- package/dist/rules/required-tags/require-summary.js.map +1 -1
- package/dist/rules/required-tags/require-template.cjs +1 -3
- package/dist/rules/required-tags/require-template.d.ts.map +1 -1
- package/dist/rules/required-tags/require-template.js +1 -3
- package/dist/rules/required-tags/require-template.js.map +1 -1
- package/dist/rules/required-tags/require-throws.cjs +1 -3
- package/dist/rules/required-tags/require-throws.d.ts.map +1 -1
- package/dist/rules/required-tags/require-throws.js +1 -3
- package/dist/rules/required-tags/require-throws.js.map +1 -1
- package/dist/rules/required-tags/require-type-param.cjs +1 -3
- package/dist/rules/required-tags/require-type-param.d.ts.map +1 -1
- package/dist/rules/required-tags/require-type-param.js +1 -3
- package/dist/rules/required-tags/require-type-param.js.map +1 -1
- package/dist/rules/required-tags/require-use-declared-type.cjs +1 -3
- package/dist/rules/required-tags/require-use-declared-type.d.ts.map +1 -1
- package/dist/rules/required-tags/require-use-declared-type.js +1 -3
- package/dist/rules/required-tags/require-use-declared-type.js.map +1 -1
- package/dist/rules/required-tags/require-virtual.cjs +1 -3
- package/dist/rules/required-tags/require-virtual.d.ts.map +1 -1
- package/dist/rules/required-tags/require-virtual.js +1 -3
- package/dist/rules/required-tags/require-virtual.js.map +1 -1
- package/dist/rules/restrict-tags.cjs +40 -48
- package/dist/rules/restrict-tags.d.ts +3 -3
- package/dist/rules/restrict-tags.d.ts.map +1 -1
- package/dist/rules/restrict-tags.js +41 -49
- package/dist/rules/restrict-tags.js.map +1 -1
- package/docs/rules/getting-started.md +27 -27
- package/docs/rules/index.md +22 -22
- package/docs/rules/presets/all.md +1 -3
- package/docs/rules/presets/detailed.md +1 -3
- package/docs/rules/presets/index.md +75 -75
- package/docs/rules/presets/jsdoc.md +1 -3
- package/docs/rules/presets/packages.md +1 -3
- package/docs/rules/presets/recommended.md +1 -3
- package/docs/rules/presets/tsdoc.md +1 -3
- package/docs/rules/presets/typedoc-strict.md +1 -3
- package/docs/rules/presets/typedoc.md +1 -3
- package/docs/rules/require.md +53 -44
- package/docs/rules/required-tags/require-abstract.md +31 -30
- package/docs/rules/required-tags/require-alpha.md +18 -9
- package/docs/rules/required-tags/require-author.md +31 -30
- package/docs/rules/required-tags/require-beta.md +18 -9
- package/docs/rules/required-tags/require-category.md +30 -31
- package/docs/rules/required-tags/require-class.md +11 -10
- package/docs/rules/required-tags/require-decorator.md +18 -9
- package/docs/rules/required-tags/require-default-value.md +18 -9
- package/docs/rules/required-tags/require-deprecated.md +18 -9
- package/docs/rules/required-tags/require-document.md +31 -30
- package/docs/rules/required-tags/require-enum.md +13 -12
- package/docs/rules/required-tags/require-event-property.md +18 -9
- package/docs/rules/required-tags/require-event.md +31 -30
- package/docs/rules/required-tags/require-example.md +17 -10
- package/docs/rules/required-tags/require-expand.md +31 -30
- package/docs/rules/required-tags/require-experimental.md +18 -9
- package/docs/rules/required-tags/require-function.md +11 -13
- package/docs/rules/required-tags/require-group.md +31 -30
- package/docs/rules/required-tags/require-hidden.md +32 -31
- package/docs/rules/required-tags/require-hideconstructor.md +31 -30
- package/docs/rules/required-tags/require-ignore.md +31 -30
- package/docs/rules/required-tags/require-import.md +30 -31
- package/docs/rules/required-tags/require-include.md +31 -32
- package/docs/rules/required-tags/require-inherit-doc.md +18 -9
- package/docs/rules/required-tags/require-inline.md +31 -30
- package/docs/rules/required-tags/require-interface.md +14 -13
- package/docs/rules/required-tags/require-internal.md +18 -9
- package/docs/rules/required-tags/require-label.md +18 -9
- package/docs/rules/required-tags/require-license.md +31 -30
- package/docs/rules/required-tags/require-link.md +18 -9
- package/docs/rules/required-tags/require-merge-module-with.md +31 -30
- package/docs/rules/required-tags/require-module.md +14 -13
- package/docs/rules/required-tags/require-namespace.md +31 -30
- package/docs/rules/required-tags/require-overload.md +31 -30
- package/docs/rules/required-tags/require-override.md +18 -9
- package/docs/rules/required-tags/require-package-documentation.md +14 -13
- package/docs/rules/required-tags/require-param.md +14 -13
- package/docs/rules/required-tags/require-primary-export.md +31 -30
- package/docs/rules/required-tags/require-private-remarks.md +18 -11
- package/docs/rules/required-tags/require-private.md +31 -30
- package/docs/rules/required-tags/require-property.md +31 -30
- package/docs/rules/required-tags/require-protected.md +31 -30
- package/docs/rules/required-tags/require-public.md +19 -10
- package/docs/rules/required-tags/require-readonly.md +19 -10
- package/docs/rules/required-tags/require-remarks.md +12 -10
- package/docs/rules/required-tags/require-returns.md +14 -13
- package/docs/rules/required-tags/require-sealed.md +19 -10
- package/docs/rules/required-tags/require-see.md +19 -10
- package/docs/rules/required-tags/require-since.md +30 -31
- package/docs/rules/required-tags/require-sort-strategy.md +31 -30
- package/docs/rules/required-tags/require-summary.md +31 -30
- package/docs/rules/required-tags/require-template.md +31 -30
- package/docs/rules/required-tags/require-throws.md +20 -19
- package/docs/rules/required-tags/require-type-param.md +14 -13
- package/docs/rules/required-tags/require-use-declared-type.md +31 -30
- package/docs/rules/required-tags/require-virtual.md +20 -11
- package/docs/rules/required-tags.md +40 -38
- package/docs/rules/restrict-tags.md +68 -60
- package/package.json +67 -80
|
@@ -42,14 +42,14 @@ Together, these rules turn documentation from optional prose into a consistent A
|
|
|
42
42
|
* Creates a user record.
|
|
43
43
|
*/
|
|
44
44
|
export function createUser(name: string): string {
|
|
45
|
-
|
|
45
|
+
return name;
|
|
46
46
|
}
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
With:
|
|
50
50
|
|
|
51
51
|
```ts
|
|
52
|
-
["error", { enforceFor: ["function"] }]
|
|
52
|
+
["error", { enforceFor: ["function"] }];
|
|
53
53
|
```
|
|
54
54
|
|
|
55
55
|
for `tsdoc-require-2/require-param` and `tsdoc-require-2/require-returns`.
|
|
@@ -59,11 +59,13 @@ for `tsdoc-require-2/require-param` and `tsdoc-require-2/require-returns`.
|
|
|
59
59
|
```ts
|
|
60
60
|
/**
|
|
61
61
|
* Creates a user record.
|
|
62
|
+
*
|
|
62
63
|
* @param name - User display name.
|
|
64
|
+
*
|
|
63
65
|
* @returns Persisted user ID.
|
|
64
66
|
*/
|
|
65
67
|
export function createUser(name: string): string {
|
|
66
|
-
|
|
68
|
+
return name;
|
|
67
69
|
}
|
|
68
70
|
```
|
|
69
71
|
|
|
@@ -82,20 +84,20 @@ Each `require-*` rule accepts the same option shape:
|
|
|
82
84
|
|
|
83
85
|
```ts
|
|
84
86
|
type Options = [
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
87
|
+
{
|
|
88
|
+
enforceFor?: Array<
|
|
89
|
+
| "class"
|
|
90
|
+
| "enum"
|
|
91
|
+
| "function"
|
|
92
|
+
| "interface"
|
|
93
|
+
| "namespace"
|
|
94
|
+
| "object"
|
|
95
|
+
| "type"
|
|
96
|
+
| "variable"
|
|
97
|
+
>;
|
|
98
|
+
exportMode?: "all" | "exported" | "non-exported";
|
|
99
|
+
includeNonExported?: boolean;
|
|
100
|
+
},
|
|
99
101
|
];
|
|
100
102
|
```
|
|
101
103
|
|
|
@@ -103,20 +105,20 @@ Default options:
|
|
|
103
105
|
|
|
104
106
|
```ts
|
|
105
107
|
[
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
]
|
|
108
|
+
{
|
|
109
|
+
enforceFor: [
|
|
110
|
+
"class",
|
|
111
|
+
"enum",
|
|
112
|
+
"function",
|
|
113
|
+
"interface",
|
|
114
|
+
"namespace",
|
|
115
|
+
"object",
|
|
116
|
+
"type",
|
|
117
|
+
"variable",
|
|
118
|
+
],
|
|
119
|
+
exportMode: "exported",
|
|
120
|
+
},
|
|
121
|
+
];
|
|
120
122
|
```
|
|
121
123
|
|
|
122
124
|
### Rules in this family
|
|
@@ -184,14 +186,14 @@ Default options:
|
|
|
184
186
|
import tsdocRequire from "eslint-plugin-tsdoc-require-2";
|
|
185
187
|
|
|
186
188
|
export default [
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
},
|
|
189
|
+
tsdocRequire.configs.recommended,
|
|
190
|
+
{
|
|
191
|
+
rules: {
|
|
192
|
+
"tsdoc-require-2/require-param": ["error", { enforceFor: ["function"] }],
|
|
193
|
+
"tsdoc-require-2/require-returns": ["error", { enforceFor: ["function"] }],
|
|
194
|
+
"tsdoc-require-2/require-throws": ["error", { enforceFor: ["function"] }],
|
|
194
195
|
},
|
|
196
|
+
},
|
|
195
197
|
];
|
|
196
198
|
```
|
|
197
199
|
|
|
@@ -44,10 +44,11 @@ Use it with:
|
|
|
44
44
|
```ts
|
|
45
45
|
/**
|
|
46
46
|
* Calculates a value.
|
|
47
|
+
*
|
|
47
48
|
* @typedef ResultShape
|
|
48
49
|
*/
|
|
49
50
|
export function calculate(): number {
|
|
50
|
-
|
|
51
|
+
return 1;
|
|
51
52
|
}
|
|
52
53
|
```
|
|
53
54
|
|
|
@@ -58,10 +59,12 @@ With default configuration (`mode: "deny"`).
|
|
|
58
59
|
```ts
|
|
59
60
|
/**
|
|
60
61
|
* Calculates a value.
|
|
61
|
-
*
|
|
62
|
+
*
|
|
63
|
+
* @remarks
|
|
64
|
+
* Uses plain TSDoc tags.
|
|
62
65
|
*/
|
|
63
66
|
export function calculate(): number {
|
|
64
|
-
|
|
67
|
+
return 1;
|
|
65
68
|
}
|
|
66
69
|
```
|
|
67
70
|
|
|
@@ -80,22 +83,22 @@ With default configuration (`mode: "deny"`).
|
|
|
80
83
|
|
|
81
84
|
```ts
|
|
82
85
|
type Options = [
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
86
|
+
{
|
|
87
|
+
enforceFor?: Array<
|
|
88
|
+
| "class"
|
|
89
|
+
| "enum"
|
|
90
|
+
| "function"
|
|
91
|
+
| "interface"
|
|
92
|
+
| "namespace"
|
|
93
|
+
| "object"
|
|
94
|
+
| "type"
|
|
95
|
+
| "variable"
|
|
96
|
+
>;
|
|
97
|
+
exportMode?: "all" | "exported" | "non-exported";
|
|
98
|
+
includeNonExported?: boolean;
|
|
99
|
+
mode?: "allow" | "deny";
|
|
100
|
+
tags?: Array<`@${string}`>;
|
|
101
|
+
},
|
|
99
102
|
];
|
|
100
103
|
```
|
|
101
104
|
|
|
@@ -103,31 +106,31 @@ Default options:
|
|
|
103
106
|
|
|
104
107
|
```ts
|
|
105
108
|
[
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
]
|
|
109
|
+
{
|
|
110
|
+
enforceFor: [
|
|
111
|
+
"class",
|
|
112
|
+
"enum",
|
|
113
|
+
"function",
|
|
114
|
+
"interface",
|
|
115
|
+
"namespace",
|
|
116
|
+
"object",
|
|
117
|
+
"type",
|
|
118
|
+
"variable",
|
|
119
|
+
],
|
|
120
|
+
exportMode: "exported",
|
|
121
|
+
mode: "deny",
|
|
122
|
+
tags: [
|
|
123
|
+
"@augments",
|
|
124
|
+
"@callback",
|
|
125
|
+
"@extends",
|
|
126
|
+
"@jsx",
|
|
127
|
+
"@satisfies",
|
|
128
|
+
"@type",
|
|
129
|
+
"@typedef",
|
|
130
|
+
"@yields",
|
|
131
|
+
],
|
|
132
|
+
},
|
|
133
|
+
];
|
|
131
134
|
```
|
|
132
135
|
|
|
133
136
|
### Allow mode example
|
|
@@ -137,18 +140,21 @@ Default options:
|
|
|
137
140
|
```ts
|
|
138
141
|
/**
|
|
139
142
|
* Calculates a value.
|
|
140
|
-
*
|
|
143
|
+
*
|
|
144
|
+
* @remarks
|
|
145
|
+
* Useful details.
|
|
146
|
+
*
|
|
141
147
|
* @deprecated Use newCalculate instead.
|
|
142
148
|
*/
|
|
143
149
|
export function calculate(): number {
|
|
144
|
-
|
|
150
|
+
return 1;
|
|
145
151
|
}
|
|
146
152
|
```
|
|
147
153
|
|
|
148
154
|
With:
|
|
149
155
|
|
|
150
156
|
```ts
|
|
151
|
-
["error", { mode: "allow", tags: ["@remarks"] }]
|
|
157
|
+
["error", { mode: "allow", tags: ["@remarks"] }];
|
|
152
158
|
```
|
|
153
159
|
|
|
154
160
|
#### Valid in allow mode
|
|
@@ -156,17 +162,19 @@ With:
|
|
|
156
162
|
```ts
|
|
157
163
|
/**
|
|
158
164
|
* Calculates a value.
|
|
159
|
-
*
|
|
165
|
+
*
|
|
166
|
+
* @remarks
|
|
167
|
+
* Useful details.
|
|
160
168
|
*/
|
|
161
169
|
export function calculate(): number {
|
|
162
|
-
|
|
170
|
+
return 1;
|
|
163
171
|
}
|
|
164
172
|
```
|
|
165
173
|
|
|
166
174
|
With:
|
|
167
175
|
|
|
168
176
|
```ts
|
|
169
|
-
["error", { mode: "allow", tags: ["@remarks"] }]
|
|
177
|
+
["error", { mode: "allow", tags: ["@remarks"] }];
|
|
170
178
|
```
|
|
171
179
|
|
|
172
180
|
## ESLint flat config example
|
|
@@ -175,18 +183,18 @@ With:
|
|
|
175
183
|
import tsdocRequire from "eslint-plugin-tsdoc-require-2";
|
|
176
184
|
|
|
177
185
|
export default [
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
},
|
|
187
|
-
],
|
|
186
|
+
tsdocRequire.configs.tsdoc,
|
|
187
|
+
{
|
|
188
|
+
rules: {
|
|
189
|
+
"tsdoc-require-2/restrict-tags": [
|
|
190
|
+
"error",
|
|
191
|
+
{
|
|
192
|
+
mode: "deny",
|
|
193
|
+
tags: ["@typedef", "@callback"],
|
|
188
194
|
},
|
|
195
|
+
],
|
|
189
196
|
},
|
|
197
|
+
},
|
|
190
198
|
];
|
|
191
199
|
```
|
|
192
200
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://www.schemastore.org/package.json",
|
|
3
3
|
"name": "eslint-plugin-tsdoc-require-2",
|
|
4
|
-
"version": "1.2.
|
|
4
|
+
"version": "1.2.3",
|
|
5
5
|
"private": false,
|
|
6
6
|
"description": "Require TSDoc comments for exported TypeScript declarations.",
|
|
7
7
|
"keywords": [
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
"url": "git+https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2.git"
|
|
23
23
|
},
|
|
24
24
|
"license": "MIT",
|
|
25
|
-
"author": "Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com> (https://
|
|
25
|
+
"author": "Nick2bad4u <20943337+Nick2bad4u@users.noreply.github.com> (https://github.com/Nick2bad4u)",
|
|
26
26
|
"contributors": [
|
|
27
27
|
{
|
|
28
28
|
"name": "Nick2bad4u",
|
|
@@ -75,26 +75,26 @@
|
|
|
75
75
|
"build": "tsc -p tsconfig.build.json && node ./scripts/write-cjs-entry.mjs",
|
|
76
76
|
"build:cjs": "esbuild dist/plugin.js --bundle --format=cjs --platform=node --packages=external --sourcemap --outfile=dist/plugin.cjs --footer:js=\"module.exports = module.exports.default;\"",
|
|
77
77
|
"build:clean": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
|
|
78
|
-
"build:eslint-inspector": "npx -y @eslint/config-inspector@
|
|
78
|
+
"build:eslint-inspector": "npx -y @eslint/config-inspector@latest build --outDir \"docs/docusaurus/static/eslint-inspector\" --base \"/eslint-plugin-tsdoc-require-2/eslint-inspector/\"",
|
|
79
79
|
"build:eslint-inspector:local": "npx @eslint/config-inspector",
|
|
80
80
|
"build:stylelint-inspector": "npx -y stylelint-config-inspector@latest build --outDir \"docs/docusaurus/static/stylelint-inspector\" --base \"/eslint-plugin-tsdoc-require-2/stylelint-inspector/\"",
|
|
81
81
|
"build:stylelint-inspector:local": "npx stylelint-config-inspector@latest",
|
|
82
82
|
"build:types:cjs": "node -e \"require('node:fs').copyFileSync('dist/plugin.d.ts','dist/plugin.d.cts')\"",
|
|
83
83
|
"changelog:release-notes": "node ./scripts/changelog-release-notes.mjs",
|
|
84
|
-
"clean": "
|
|
85
|
-
"clean:cache": "
|
|
86
|
-
"clean:cache:coverage": "
|
|
87
|
-
"clean:cache:dist": "
|
|
88
|
-
"clean:cache:eslint": "
|
|
89
|
-
"clean:cache:ncu": "
|
|
90
|
-
"clean:cache:prettier": "
|
|
91
|
-
"clean:cache:stryker": "
|
|
92
|
-
"clean:cache:stylelint": "
|
|
93
|
-
"clean:cache:temp": "
|
|
94
|
-
"clean:cache:typescript": "
|
|
95
|
-
"clean:cache:vite": "
|
|
96
|
-
"clean:database": "
|
|
97
|
-
"clean:docs": "
|
|
84
|
+
"clean": "node scripts/clean-paths.mjs coverage dist temp .cache",
|
|
85
|
+
"clean:cache": "node scripts/clean-paths.mjs dist coverage cache .cache .vite .turbo",
|
|
86
|
+
"clean:cache:coverage": "node scripts/clean-paths.mjs coverage .coverage",
|
|
87
|
+
"clean:cache:dist": "node scripts/clean-paths.mjs dist release",
|
|
88
|
+
"clean:cache:eslint": "node scripts/clean-paths.mjs .cache/.eslintcache",
|
|
89
|
+
"clean:cache:ncu": "node scripts/clean-paths.mjs .cache/.ncu-cache.json",
|
|
90
|
+
"clean:cache:prettier": "node scripts/clean-paths.mjs .cache/.prettier-cache .prettier-cache .prettiercache",
|
|
91
|
+
"clean:cache:stryker": "node scripts/clean-paths.mjs .stryker-tmp",
|
|
92
|
+
"clean:cache:stylelint": "node scripts/clean-paths.mjs .cache/stylelintcache stylelintcache .stylelintcache",
|
|
93
|
+
"clean:cache:temp": "node scripts/clean-paths.mjs .temp",
|
|
94
|
+
"clean:cache:typescript": "node scripts/clean-paths.mjs .cache/**/*.tsbuildinfo .cache/builds",
|
|
95
|
+
"clean:cache:vite": "node scripts/clean-paths.mjs .cache/vite .cache/vitest .cache/vitest-zero-coverage .cache/vite-zero-coverage",
|
|
96
|
+
"clean:database": "node scripts/clean-paths.mjs %appdata%/uptime-watcher/uptime-watcher.sqlite",
|
|
97
|
+
"clean:docs": "node scripts/clean-paths.mjs docs/docusaurus/.docusaurus docs/docusaurus/build docs/docusaurus/site-docs/developer/api",
|
|
98
98
|
"clean:docusaurus": "npm run clean:docs && npm run --workspace docs/docusaurus clear",
|
|
99
99
|
"contrib": "all-contributors",
|
|
100
100
|
"contrib:add": "all-contributors add",
|
|
@@ -108,17 +108,17 @@
|
|
|
108
108
|
"lint": "cross-env NODE_OPTIONS=--max_old_space_size=16384 eslint --cache --cache-strategy content --cache-location .cache/.eslintcache",
|
|
109
109
|
"lint:action": "npm run lint:actions",
|
|
110
110
|
"lint:actions": "node scripts/lint-actionlint.mjs",
|
|
111
|
-
"lint:all": "npm run lint && npm run lint:css && npm run lint:prettier && npm run lint:remark && npm run lint:package && npm run lint:secretlint && npm run lint:yaml && npm run lint:actions && npm run lint:circular",
|
|
112
|
-
"lint:all:fix": "npm run lint:fix && npm run lint:css:fix && npm run lint:prettier:fix && npm run lint:remark && npm run lint:package && npm run lint:secretlint && npm run lint:yaml:fix && npm run lint:actions && npm run lint:circular",
|
|
113
|
-
"lint:all:fix:quiet": "npm run lint:fix:quiet && npm run lint:css:fix && npm run lint:prettier:fix && npm run lint:remark && npm run lint:package && npm run lint:secretlint && npm run lint:yaml:fix && npm run lint:actions && npm run lint:circular",
|
|
111
|
+
"lint:all": "npm run lint && npm run lint:css && npm run lint:prettier && npm run lint:remark && npm run lint:package && npm run lint:secretlint && npm run lint:gitleaks && npm run lint:yaml && npm run lint:yamllint && npm run lint:actions && npm run lint:circular",
|
|
112
|
+
"lint:all:fix": "npm run lint:fix && npm run lint:css:fix && npm run lint:prettier:fix && npm run lint:remark && npm run lint:package && npm run lint:secretlint && npm run lint:gitleaks && npm run lint:yaml:fix && npm run lint:yamllint && npm run lint:actions && npm run lint:circular",
|
|
113
|
+
"lint:all:fix:quiet": "npm run lint:fix:quiet && npm run lint:css:fix && npm run lint:prettier:fix && npm run lint:remark && npm run lint:package && npm run lint:secretlint && npm run lint:gitleaks && npm run lint:yaml:fix && npm run lint:yamllint && npm run lint:actions && npm run lint:circular",
|
|
114
114
|
"lint:circular": "npm run madge:circular",
|
|
115
115
|
"lint:compat:eslint": "node scripts/eslint-compat-smoke.mjs",
|
|
116
116
|
"lint:config:build": "npm run build:eslint-inspector",
|
|
117
117
|
"lint:config:inspect": "npx eslint --inspect-config",
|
|
118
118
|
"lint:css": "stylelint --cache --config stylelint.config.mjs --cache-strategy content --cache-location .cache/stylelintcache \"src/**/*.css\" \"docs/**/*.css\" --custom-formatter stylelint-formatter-pretty && echo \"Stylelint done!\"",
|
|
119
119
|
"lint:css:fix": "stylelint --cache --config stylelint.config.mjs --cache-strategy content --cache-location .cache/stylelintcache \"src/**/*.css\" \"docs/**/*.css\" --custom-formatter stylelint-formatter-pretty --fix && echo \"Stylelint done!\"",
|
|
120
|
-
"lint:depcheck": "
|
|
121
|
-
"lint:deps": "
|
|
120
|
+
"lint:depcheck": "npm run knip -- --dependencies",
|
|
121
|
+
"lint:deps": "npm run knip -- --dependencies",
|
|
122
122
|
"lint:dupes": "jscpd src/ --config jscpd.json",
|
|
123
123
|
"lint:dupes:all": "jscpd src/ --config jscpd.json --min-lines 3",
|
|
124
124
|
"lint:dupes:skiplocal": "jscpd src/ --skipLocal --config jscpd.json",
|
|
@@ -127,6 +127,7 @@
|
|
|
127
127
|
"lint:exports": "ts-unused-exports tsconfig.json src/plugin.ts --excludePathsFromReport=plugin.ts",
|
|
128
128
|
"lint:fix": "cross-env NODE_OPTIONS=--max_old_space_size=16384 eslint --cache --cache-strategy content --cache-location .cache/.eslintcache --fix",
|
|
129
129
|
"lint:fix:quiet": "cross-env ESLINT_PROGRESS=off NODE_OPTIONS=--max_old_space_size=16384 eslint --cache --cache-strategy content --cache-location .cache/.eslintcache --fix && echo \"Eslint fix done!\"",
|
|
130
|
+
"lint:gitleaks": "gitleaks detect --config .gitleaks.toml --no-banner --redact --source .",
|
|
130
131
|
"lint:grype": "grype . -c .grype.yaml --name eslint-plugin-tsdoc-require-2",
|
|
131
132
|
"lint:knip": "npm run knip",
|
|
132
133
|
"lint:knip:exports": "npm run knip -- --include exports,nsExports,classMembers,types,nsTypes,enumMembers,duplicates",
|
|
@@ -151,16 +152,17 @@
|
|
|
151
152
|
"lint:secretlint": "secretlint --secretlintrc .secretlintrc.cjs --secretlintignore .secretlintignore \"./*\" \".vscode/**\" \"assets/**\" \"src/**\" \"electron/**\" \"shared/**\" \"config/**\" \"scripts/**\" \"playwright/**\" \"storybook/**\" \".storybook\" \"tests/**\" \"benchmarks/**\" \".devin/**\" \"public/**\" \".github/**\" \"docs/Architecture/**\" \"docs/*\" \"docs/assets/**\" \"docs/Guides/**\" \"docs/Testing/**\" \"docs/TSDoc/**\" \"docs/docusaurus/src/**\" \"docs/docusaurus/static/**\" \"docs/docusaurus/blog/**\" \"docs/docusaurus/docs/**\" \"docs/docusaurus/docs/*\"",
|
|
152
153
|
"lint:secrets": "detect-secrets scan",
|
|
153
154
|
"lint:unused": "npm run knip -- --include unlisted,unresolved,duplicates",
|
|
154
|
-
"lint:unused-deps": "
|
|
155
|
+
"lint:unused-deps": "npm run knip -- --dependencies",
|
|
155
156
|
"lint:yaml": "cross-env NODE_OPTIONS=--max_old_space_size=16384 eslint --cache --cache-strategy content --cache-location .cache/.eslintcache \"**/*.{yml,yaml}\" && echo \"YAML lint done!\"",
|
|
156
157
|
"lint:yaml:fix": "cross-env NODE_OPTIONS=--max_old_space_size=16384 eslint --cache --cache-strategy content --cache-location .cache/.eslintcache --fix \"**/*.{yml,yaml}\" && echo \"YAML lint (fix) done!\"",
|
|
158
|
+
"lint:yamllint": "yamllint .",
|
|
157
159
|
"madge:circular": "madge --circular --no-spinner --ts-config tsconfig.json --extensions ts,tsx,js,jsx,mjs,cjs,cts,mts ./src --exclude \"(^|[\\/])(test|dist|node_modules|cache|.cache|coverage|build|eslint-inspector|temp|.docusaurus)($|[\\/])|\\.css$\"",
|
|
158
160
|
"madge:leaves": "madge --leaves --no-spinner --ts-config tsconfig.json --extensions ts,tsx,js,jsx,mjs,cjs,cts,mts ./src --exclude \"(^|[\\/])(test|dist|node_modules|cache|.cache|coverage|build|eslint-inspector|temp|.docusaurus)($|[\\/])|\\.css$\"",
|
|
159
161
|
"madge:orphans": "madge --orphans --no-spinner --ts-config tsconfig.json --extensions ts,tsx,js,jsx,mjs,cjs,cts,mts ./src --exclude \"(^|[\\/])(test|dist|node_modules|cache|.cache|coverage|build|eslint-inspector|temp|.docusaurus)($|[\\/])|\\.css$\"",
|
|
160
162
|
"open:coverage": "open-cli coverage/index.html",
|
|
161
163
|
"prepublishOnly": "npm run release:check",
|
|
162
|
-
"release:check": "npm run clean && npm run build && npm run typecheck && npm run lint:fix && npm run lint:prettier:fix && npm run test",
|
|
163
|
-
"release:verify": "cross-env NODE_OPTIONS= npm run build && cross-env NODE_OPTIONS= npm run lint && cross-env NODE_OPTIONS= npm run typecheck && cross-env NODE_OPTIONS= VITEST_TYPECHECK=false npm run test && cross-env NODE_OPTIONS= npm run sync:readme:rules-table && cross-env NODE_OPTIONS= npm run sync:readme:presets-matrix && cross-env NODE_OPTIONS= npm run docs:check-links && cross-env NODE_OPTIONS= npm pack --dry-run",
|
|
164
|
+
"release:check": "npm run clean && npm run build && npm run docs:api && npm run typecheck && npm run lint:fix && npm run lint:prettier:fix && npm run test",
|
|
165
|
+
"release:verify": "cross-env NODE_OPTIONS= npm run build && cross-env NODE_OPTIONS= npm run lint && cross-env NODE_OPTIONS= npm run typecheck && cross-env NODE_OPTIONS= VITEST_TYPECHECK=false npm run test && cross-env NODE_OPTIONS= npm run sync:readme:rules-table && cross-env NODE_OPTIONS= npm run sync:readme:presets-matrix && cross-env NODE_OPTIONS= npm run docs:api && cross-env NODE_OPTIONS= npm run docs:check-links && cross-env NODE_OPTIONS= npm pack --dry-run",
|
|
164
166
|
"remark:fix": "remark --rc-path .remarkrc.mjs --silently-ignore --ignore-path .remarkignore --frail --quiet --output -- \"*.{md,mdx}\" \"docs/**/*.{md,mdx}\"",
|
|
165
167
|
"remark:test-config": "remark --rc-path .remarkrc.mjs --silently-ignore --ignore-path .remarkignore --frail \"README.md\"",
|
|
166
168
|
"sync:node-version-files": "node scripts/sync-node-version-files.mjs",
|
|
@@ -194,6 +196,7 @@
|
|
|
194
196
|
"test:verbose": "vitest run --reporter=verbose",
|
|
195
197
|
"test:watch": "vitest",
|
|
196
198
|
"typecheck": "tsc -p tsconfig.json --noEmit && tsc -p tsconfig.build.json --noEmit && tsc -p tsconfig.eslint.json --noEmit && tsc -p tsconfig.js.json --noEmit",
|
|
199
|
+
"update-actions": "npx actions-up --yes --style sha",
|
|
197
200
|
"update-deps": "npx ncu -i --install never && npm update --workspaces --force && npm install --force && npm run sync:peer-eslint-range && npm run sync:node-version-files && npm run sync:rules:write"
|
|
198
201
|
},
|
|
199
202
|
"overrides": {
|
|
@@ -206,16 +209,16 @@
|
|
|
206
209
|
"yaml": "2.8.3"
|
|
207
210
|
},
|
|
208
211
|
"dependencies": {
|
|
209
|
-
"@typescript-eslint/utils": "^8.
|
|
212
|
+
"@typescript-eslint/utils": "^8.61.1",
|
|
210
213
|
"ts-extras": "^1.0.0",
|
|
211
|
-
"type-fest": "^5.
|
|
214
|
+
"type-fest": "^5.7.0"
|
|
212
215
|
},
|
|
213
216
|
"devDependencies": {
|
|
214
|
-
"@arethetypeswrong/cli": "^0.18.
|
|
217
|
+
"@arethetypeswrong/cli": "^0.18.3",
|
|
215
218
|
"@csstools/stylelint-formatter-github": "^2.0.0",
|
|
216
219
|
"@double-great/remark-lint-alt-text": "^1.1.1",
|
|
217
|
-
"@eslint/compat": "^2.0
|
|
218
|
-
"@eslint/config-inspector": "^
|
|
220
|
+
"@eslint/compat": "^2.1.0",
|
|
221
|
+
"@eslint/config-inspector": "^3.0.4",
|
|
219
222
|
"@microsoft/tsdoc-config": "^0.18.1",
|
|
220
223
|
"@stryker-ignorer/console-all": "^0.3.2",
|
|
221
224
|
"@stryker-mutator/core": "^9.6.1",
|
|
@@ -223,87 +226,71 @@
|
|
|
223
226
|
"@stryker-mutator/vitest-runner": "^9.6.1",
|
|
224
227
|
"@types/htmlhint": "^1.1.5",
|
|
225
228
|
"@types/madge": "^5.0.3",
|
|
226
|
-
"@types/node": "^25.
|
|
227
|
-
"@types/postcss-clamp": "^4.1.3",
|
|
228
|
-
"@types/postcss-flexbugs-fixes": "^5.0.3",
|
|
229
|
-
"@types/postcss-html": "^1.5.3",
|
|
230
|
-
"@types/postcss-import": "^14.0.3",
|
|
231
|
-
"@types/postcss-inline-svg": "^5.0.4",
|
|
232
|
-
"@types/postcss-normalize": "^9.0.4",
|
|
233
|
-
"@types/postcss-reporter": "^7.0.5",
|
|
229
|
+
"@types/node": "^25.9.3",
|
|
234
230
|
"@types/sloc": "^0.2.3",
|
|
235
|
-
"@typescript-eslint/parser": "^8.
|
|
236
|
-
"@typescript-eslint/rule-tester": "^8.
|
|
237
|
-
"@vitest/coverage-v8": "^4.1.
|
|
238
|
-
"@vitest/ui": "^4.1.
|
|
231
|
+
"@typescript-eslint/parser": "^8.61.1",
|
|
232
|
+
"@typescript-eslint/rule-tester": "^8.61.1",
|
|
233
|
+
"@vitest/coverage-v8": "^4.1.9",
|
|
234
|
+
"@vitest/ui": "^4.1.9",
|
|
239
235
|
"actionlint": "^2.0.6",
|
|
240
236
|
"all-contributors-cli": "^6.26.1",
|
|
241
|
-
"cognitive-complexity-ts": "^0.8.
|
|
242
|
-
"commitlint": "^
|
|
237
|
+
"cognitive-complexity-ts": "^0.8.2",
|
|
238
|
+
"commitlint": "^21.0.2",
|
|
243
239
|
"commitlint-config-gitmoji": "^2.3.1",
|
|
244
240
|
"cross-env": "^10.1.0",
|
|
245
|
-
"depcheck": "^1.4.7",
|
|
246
241
|
"detect-secrets": "^1.0.6",
|
|
247
|
-
"eslint": "^10.
|
|
248
|
-
"eslint-config-nick2bad4u": "^
|
|
242
|
+
"eslint": "^10.5.0",
|
|
243
|
+
"eslint-config-nick2bad4u": "^2.0.2",
|
|
249
244
|
"eslint-formatter-unix": "^9.0.1",
|
|
250
245
|
"eslint-rule-benchmark": "^0.8.0",
|
|
251
|
-
"fast-check": "^4.
|
|
246
|
+
"fast-check": "^4.8.0",
|
|
252
247
|
"git-cliff": "^2.13.1",
|
|
248
|
+
"gitleaks-config-nick2bad4u": "^1.0.2",
|
|
253
249
|
"gitleaks-secret-scanner": "^2.1.1",
|
|
254
250
|
"htmlhint": "^1.9.2",
|
|
255
|
-
"jscpd": "^
|
|
256
|
-
"knip": "^6.
|
|
251
|
+
"jscpd": "^5.0.10",
|
|
252
|
+
"knip": "^6.17.1",
|
|
257
253
|
"leasot": "^14.4.0",
|
|
258
254
|
"madge": "^8.0.0",
|
|
259
255
|
"markdown-link-check": "^3.14.2",
|
|
260
|
-
"npm-check-updates": "^22.
|
|
261
|
-
"npm-package-json-lint": "^10.4.
|
|
256
|
+
"npm-check-updates": "^22.2.3",
|
|
257
|
+
"npm-package-json-lint": "^10.4.1",
|
|
258
|
+
"npm-package-json-lint-config-nick2bad4u": "^1.0.3",
|
|
262
259
|
"picocolors": "^1.1.1",
|
|
263
|
-
"
|
|
264
|
-
"
|
|
265
|
-
"
|
|
266
|
-
"postcss-combine-duplicated-selectors": "^10.0.3",
|
|
267
|
-
"postcss-flexbugs-fixes": "^5.0.2",
|
|
268
|
-
"postcss-import": "^16.1.1",
|
|
269
|
-
"postcss-inline-svg": "^6.0.0",
|
|
270
|
-
"postcss-logical": "^9.0.0",
|
|
271
|
-
"postcss-normalize": "^13.0.1",
|
|
272
|
-
"postcss-reporter": "^7.1.0",
|
|
273
|
-
"postcss-round-subpixels": "^2.0.0",
|
|
274
|
-
"postcss-sort-media-queries": "^6.5.0",
|
|
275
|
-
"postcss-viewport-height-correction": "^1.1.1",
|
|
276
|
-
"prettier": "^3.8.3",
|
|
277
|
-
"prettier-config-nick2bad4u": "^1.0.9",
|
|
278
|
-
"publint": "^0.3.18",
|
|
260
|
+
"prettier": "^3.8.4",
|
|
261
|
+
"prettier-config-nick2bad4u": "^1.0.17",
|
|
262
|
+
"publint": "^0.3.21",
|
|
279
263
|
"rehype-katex": "^7.0.1",
|
|
280
264
|
"remark": "^15.0.1",
|
|
281
265
|
"remark-cli": "^12.0.1",
|
|
282
|
-
"remark-config-nick2bad4u": "^1.0.
|
|
283
|
-
"
|
|
284
|
-
"secretlint": "^
|
|
285
|
-
"secretlint-config-nick2bad4u": "^1.0.3",
|
|
266
|
+
"remark-config-nick2bad4u": "^1.0.8",
|
|
267
|
+
"secretlint": "^13.0.2",
|
|
268
|
+
"secretlint-config-nick2bad4u": "^1.1.0",
|
|
286
269
|
"sloc": "^0.3.2",
|
|
287
|
-
"sort-package-json": "^
|
|
288
|
-
"stylelint": "^17.
|
|
289
|
-
"stylelint-config-nick2bad4u": "^1.0.
|
|
270
|
+
"sort-package-json": "^4.0.0",
|
|
271
|
+
"stylelint": "^17.13.0",
|
|
272
|
+
"stylelint-config-nick2bad4u": "^1.0.19",
|
|
273
|
+
"tinyglobby": "^0.2.17",
|
|
290
274
|
"ts-unused-exports": "^11.0.1",
|
|
275
|
+
"tsdoc-config-nick2bad4u": "^1.0.5",
|
|
291
276
|
"typedoc": "^0.28.19",
|
|
277
|
+
"typedoc-config-nick2bad4u": "^2.0.0",
|
|
292
278
|
"typescript": "^6.0.3",
|
|
293
|
-
"typescript-eslint": "^8.
|
|
279
|
+
"typescript-eslint": "^8.61.1",
|
|
294
280
|
"typesync": "^0.14.3",
|
|
295
281
|
"vfile": "^6.0.3",
|
|
296
|
-
"vite": "^8.0.
|
|
282
|
+
"vite": "^8.0.16",
|
|
297
283
|
"vite-tsconfig-paths": "^6.1.1",
|
|
298
|
-
"vitest": "^4.1.
|
|
284
|
+
"vitest": "^4.1.9",
|
|
285
|
+
"yamllint-config-nick2bad4u": "^1.0.2",
|
|
299
286
|
"yamllint-js": "^0.2.4"
|
|
300
287
|
},
|
|
301
288
|
"peerDependencies": {
|
|
302
289
|
"@typescript-eslint/parser": "^8.0.0 || ^9.0.0",
|
|
303
|
-
"eslint": "^9.0.0 || ^10.
|
|
290
|
+
"eslint": "^9.0.0 || ^10.5.0",
|
|
304
291
|
"typescript": ">=5.4.0"
|
|
305
292
|
},
|
|
306
|
-
"packageManager": "npm@11.
|
|
293
|
+
"packageManager": "npm@11.17.0",
|
|
307
294
|
"engines": {
|
|
308
295
|
"node": ">=20.19.0"
|
|
309
296
|
},
|