eslint-plugin-jsdoc 57.2.1 → 58.1.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/dist/buildRejectOrPreferRuleDefinition.cjs +349 -0
- package/dist/buildRejectOrPreferRuleDefinition.cjs.map +1 -0
- package/dist/buildRejectOrPreferRuleDefinition.d.ts +9 -0
- package/dist/cjs/buildRejectOrPreferRuleDefinition.d.ts +8 -0
- package/dist/cjs/rules/checkTypes.d.ts +6 -1
- package/dist/index-cjs.cjs +33 -3
- package/dist/index-cjs.cjs.map +1 -1
- package/dist/index-esm.cjs +29 -1
- package/dist/index-esm.cjs.map +1 -1
- package/dist/index-esm.d.ts +28 -2
- package/dist/index.cjs +61 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +28 -2
- package/dist/rules/checkTypes.cjs +73 -379
- package/dist/rules/checkTypes.cjs.map +1 -1
- package/dist/rules/checkTypes.d.ts +6 -1
- package/dist/rules/requireParam.cjs +13 -0
- package/dist/rules/requireParam.cjs.map +1 -1
- package/dist/rules.d.ts +10 -3
- package/package.json +1 -1
- package/src/buildRejectOrPreferRuleDefinition.js +472 -0
- package/src/index-cjs.js +35 -3
- package/src/index-esm.js +36 -1
- package/src/index.js +68 -4
- package/src/rules/checkTypes.js +82 -511
- package/src/rules/requireParam.js +20 -0
- package/src/rules.d.ts +10 -3
package/src/rules.d.ts
CHANGED
|
@@ -410,6 +410,12 @@ export interface Rules {
|
|
|
410
410
|
}
|
|
411
411
|
];
|
|
412
412
|
|
|
413
|
+
/** Reports use of `any` or `*` type */
|
|
414
|
+
"jsdoc/reject-any-type": [];
|
|
415
|
+
|
|
416
|
+
/** Reports use of `Function` type */
|
|
417
|
+
"jsdoc/reject-function-type": [];
|
|
418
|
+
|
|
413
419
|
/** Requires that each JSDoc line starts with an `*`. */
|
|
414
420
|
"jsdoc/require-asterisk-prefix":
|
|
415
421
|
| []
|
|
@@ -557,7 +563,7 @@ export interface Rules {
|
|
|
557
563
|
}
|
|
558
564
|
];
|
|
559
565
|
|
|
560
|
-
/** Requires a type for
|
|
566
|
+
/** Requires a type for `@next` tags */
|
|
561
567
|
"jsdoc/require-next-type": [];
|
|
562
568
|
|
|
563
569
|
/** Requires that all function parameters are documented. */
|
|
@@ -585,6 +591,7 @@ export interface Rules {
|
|
|
585
591
|
enableRootFixer?: boolean;
|
|
586
592
|
exemptedBy?: string[];
|
|
587
593
|
ignoreWhenAllParamsMissing?: boolean;
|
|
594
|
+
interfaceExemptsParamsCheck?: boolean;
|
|
588
595
|
unnamedRootBase?: string[];
|
|
589
596
|
useDefaultObjectProperties?: boolean;
|
|
590
597
|
}
|
|
@@ -748,7 +755,7 @@ export interface Rules {
|
|
|
748
755
|
}
|
|
749
756
|
];
|
|
750
757
|
|
|
751
|
-
/** Requires a type for
|
|
758
|
+
/** Requires a type for `@throws` tags */
|
|
752
759
|
"jsdoc/require-throws-type": [];
|
|
753
760
|
|
|
754
761
|
/** Requires yields are documented. */
|
|
@@ -790,7 +797,7 @@ export interface Rules {
|
|
|
790
797
|
}
|
|
791
798
|
];
|
|
792
799
|
|
|
793
|
-
/** Requires a type for
|
|
800
|
+
/** Requires a type for `@yields` tags */
|
|
794
801
|
"jsdoc/require-yields-type": [];
|
|
795
802
|
|
|
796
803
|
/** Sorts tags by a specified sequence according to tag name. */
|