eslint-plugin-tsdoc-require-2 1.0.7 → 1.0.9
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 +111 -36
- package/dist/internal/require-tag-factory.cjs +58 -9
- package/dist/internal/require-tag-factory.d.ts +5 -2
- package/dist/internal/require-tag-factory.d.ts.map +1 -1
- package/dist/internal/require-tag-factory.js +58 -9
- package/dist/internal/require-tag-factory.js.map +1 -1
- package/dist/plugin.cjs +146 -17
- package/dist/plugin.d.ts +2 -0
- package/dist/plugin.d.ts.map +1 -1
- package/dist/plugin.js +142 -16
- package/dist/plugin.js.map +1 -1
- package/dist/rules/require-tag-rules.cjs +121 -25
- package/dist/rules/require-tag-rules.d.ts +5 -30
- package/dist/rules/require-tag-rules.d.ts.map +1 -1
- package/dist/rules/require-tag-rules.js +93 -0
- package/dist/rules/require-tag-rules.js.map +1 -1
- package/dist/rules/require.cjs +59 -16
- package/dist/rules/require.d.ts +3 -1
- package/dist/rules/require.d.ts.map +1 -1
- package/dist/rules/require.js +59 -16
- package/dist/rules/require.js.map +1 -1
- package/dist/rules/required-tags/require-abstract.cjs +32 -0
- package/dist/rules/required-tags/require-abstract.d.ts +5 -0
- package/dist/rules/required-tags/require-abstract.d.ts.map +1 -0
- package/dist/rules/required-tags/require-abstract.js +30 -0
- package/dist/rules/required-tags/require-abstract.js.map +1 -0
- package/dist/rules/required-tags/require-alpha.cjs +0 -1
- package/dist/rules/required-tags/require-alpha.d.ts.map +1 -1
- package/dist/rules/required-tags/require-alpha.js +1 -2
- package/dist/rules/required-tags/require-alpha.js.map +1 -1
- package/dist/rules/required-tags/require-author.cjs +32 -0
- package/dist/rules/required-tags/require-author.d.ts +5 -0
- package/dist/rules/required-tags/require-author.d.ts.map +1 -0
- package/dist/rules/required-tags/require-author.js +30 -0
- package/dist/rules/required-tags/require-author.js.map +1 -0
- package/dist/rules/required-tags/require-beta.cjs +0 -1
- package/dist/rules/required-tags/require-beta.d.ts.map +1 -1
- package/dist/rules/required-tags/require-beta.js +1 -2
- package/dist/rules/required-tags/require-beta.js.map +1 -1
- package/dist/rules/required-tags/require-category.cjs +32 -0
- package/dist/rules/required-tags/require-category.d.ts +5 -0
- package/dist/rules/required-tags/require-category.d.ts.map +1 -0
- package/dist/rules/required-tags/require-category.js +30 -0
- package/dist/rules/required-tags/require-category.js.map +1 -0
- package/dist/rules/required-tags/require-class.cjs +32 -0
- package/dist/rules/required-tags/require-class.d.ts +5 -0
- package/dist/rules/required-tags/require-class.d.ts.map +1 -0
- package/dist/rules/required-tags/require-class.js +30 -0
- package/dist/rules/required-tags/require-class.js.map +1 -0
- package/dist/rules/required-tags/require-decorator.cjs +0 -1
- package/dist/rules/required-tags/require-decorator.d.ts.map +1 -1
- package/dist/rules/required-tags/require-decorator.js +1 -2
- package/dist/rules/required-tags/require-decorator.js.map +1 -1
- package/dist/rules/required-tags/require-default-value.cjs +0 -1
- package/dist/rules/required-tags/require-default-value.d.ts.map +1 -1
- package/dist/rules/required-tags/require-default-value.js +1 -2
- package/dist/rules/required-tags/require-default-value.js.map +1 -1
- package/dist/rules/required-tags/require-deprecated.cjs +0 -1
- package/dist/rules/required-tags/require-deprecated.d.ts.map +1 -1
- package/dist/rules/required-tags/require-deprecated.js +1 -2
- package/dist/rules/required-tags/require-deprecated.js.map +1 -1
- package/dist/rules/required-tags/require-document.cjs +32 -0
- package/dist/rules/required-tags/require-document.d.ts +5 -0
- package/dist/rules/required-tags/require-document.d.ts.map +1 -0
- package/dist/rules/required-tags/require-document.js +30 -0
- package/dist/rules/required-tags/require-document.js.map +1 -0
- package/dist/rules/required-tags/require-enum.cjs +32 -0
- package/dist/rules/required-tags/require-enum.d.ts +5 -0
- package/dist/rules/required-tags/require-enum.d.ts.map +1 -0
- package/dist/rules/required-tags/require-enum.js +30 -0
- package/dist/rules/required-tags/require-enum.js.map +1 -0
- package/dist/rules/required-tags/require-event-property.cjs +0 -1
- package/dist/rules/required-tags/require-event-property.d.ts.map +1 -1
- package/dist/rules/required-tags/require-event-property.js +1 -2
- package/dist/rules/required-tags/require-event-property.js.map +1 -1
- package/dist/rules/required-tags/require-event.cjs +32 -0
- package/dist/rules/required-tags/require-event.d.ts +5 -0
- package/dist/rules/required-tags/require-event.d.ts.map +1 -0
- package/dist/rules/required-tags/require-event.js +30 -0
- package/dist/rules/required-tags/require-event.js.map +1 -0
- package/dist/rules/required-tags/require-example.cjs +0 -1
- package/dist/rules/required-tags/require-example.d.ts.map +1 -1
- package/dist/rules/required-tags/require-example.js +1 -2
- package/dist/rules/required-tags/require-example.js.map +1 -1
- package/dist/rules/required-tags/require-expand.cjs +32 -0
- package/dist/rules/required-tags/require-expand.d.ts +5 -0
- package/dist/rules/required-tags/require-expand.d.ts.map +1 -0
- package/dist/rules/required-tags/require-expand.js +30 -0
- package/dist/rules/required-tags/require-expand.js.map +1 -0
- package/dist/rules/required-tags/require-experimental.cjs +0 -1
- package/dist/rules/required-tags/require-experimental.d.ts.map +1 -1
- package/dist/rules/required-tags/require-experimental.js +1 -2
- package/dist/rules/required-tags/require-experimental.js.map +1 -1
- package/dist/rules/required-tags/require-function.cjs +32 -0
- package/dist/rules/required-tags/require-function.d.ts +5 -0
- package/dist/rules/required-tags/require-function.d.ts.map +1 -0
- package/dist/rules/required-tags/require-function.js +30 -0
- package/dist/rules/required-tags/require-function.js.map +1 -0
- package/dist/rules/required-tags/require-group.cjs +32 -0
- package/dist/rules/required-tags/require-group.d.ts +5 -0
- package/dist/rules/required-tags/require-group.d.ts.map +1 -0
- package/dist/rules/required-tags/require-group.js +30 -0
- package/dist/rules/required-tags/require-group.js.map +1 -0
- package/dist/rules/required-tags/require-hidden.cjs +32 -0
- package/dist/rules/required-tags/require-hidden.d.ts +5 -0
- package/dist/rules/required-tags/require-hidden.d.ts.map +1 -0
- package/dist/rules/required-tags/require-hidden.js +30 -0
- package/dist/rules/required-tags/require-hidden.js.map +1 -0
- package/dist/rules/required-tags/require-hideconstructor.cjs +32 -0
- package/dist/rules/required-tags/require-hideconstructor.d.ts +5 -0
- package/dist/rules/required-tags/require-hideconstructor.d.ts.map +1 -0
- package/dist/rules/required-tags/require-hideconstructor.js +30 -0
- package/dist/rules/required-tags/require-hideconstructor.js.map +1 -0
- package/dist/rules/required-tags/require-ignore.cjs +32 -0
- package/dist/rules/required-tags/require-ignore.d.ts +5 -0
- package/dist/rules/required-tags/require-ignore.d.ts.map +1 -0
- package/dist/rules/required-tags/require-ignore.js +30 -0
- package/dist/rules/required-tags/require-ignore.js.map +1 -0
- package/dist/rules/required-tags/require-import.cjs +32 -0
- package/dist/rules/required-tags/require-import.d.ts +5 -0
- package/dist/rules/required-tags/require-import.d.ts.map +1 -0
- package/dist/rules/required-tags/require-import.js +30 -0
- package/dist/rules/required-tags/require-import.js.map +1 -0
- package/dist/rules/required-tags/require-include.cjs +32 -0
- package/dist/rules/required-tags/require-include.d.ts +5 -0
- package/dist/rules/required-tags/require-include.d.ts.map +1 -0
- package/dist/rules/required-tags/require-include.js +30 -0
- package/dist/rules/required-tags/require-include.js.map +1 -0
- package/dist/rules/required-tags/require-inherit-doc.cjs +0 -1
- package/dist/rules/required-tags/require-inherit-doc.d.ts.map +1 -1
- package/dist/rules/required-tags/require-inherit-doc.js +1 -2
- package/dist/rules/required-tags/require-inherit-doc.js.map +1 -1
- package/dist/rules/required-tags/require-inline.cjs +32 -0
- package/dist/rules/required-tags/require-inline.d.ts +5 -0
- package/dist/rules/required-tags/require-inline.d.ts.map +1 -0
- package/dist/rules/required-tags/require-inline.js +30 -0
- package/dist/rules/required-tags/require-inline.js.map +1 -0
- package/dist/rules/required-tags/require-interface.cjs +32 -0
- package/dist/rules/required-tags/require-interface.d.ts +5 -0
- package/dist/rules/required-tags/require-interface.d.ts.map +1 -0
- package/dist/rules/required-tags/require-interface.js +30 -0
- package/dist/rules/required-tags/require-interface.js.map +1 -0
- package/dist/rules/required-tags/require-internal.cjs +0 -1
- package/dist/rules/required-tags/require-internal.d.ts.map +1 -1
- package/dist/rules/required-tags/require-internal.js +1 -2
- package/dist/rules/required-tags/require-internal.js.map +1 -1
- package/dist/rules/required-tags/require-label.cjs +0 -1
- package/dist/rules/required-tags/require-label.d.ts.map +1 -1
- package/dist/rules/required-tags/require-label.js +1 -2
- package/dist/rules/required-tags/require-label.js.map +1 -1
- package/dist/rules/required-tags/require-license.cjs +32 -0
- package/dist/rules/required-tags/require-license.d.ts +5 -0
- package/dist/rules/required-tags/require-license.d.ts.map +1 -0
- package/dist/rules/required-tags/require-license.js +30 -0
- package/dist/rules/required-tags/require-license.js.map +1 -0
- package/dist/rules/required-tags/require-link.cjs +0 -1
- package/dist/rules/required-tags/require-link.d.ts.map +1 -1
- package/dist/rules/required-tags/require-link.js +1 -2
- package/dist/rules/required-tags/require-link.js.map +1 -1
- package/dist/rules/required-tags/require-merge-module-with.cjs +32 -0
- package/dist/rules/required-tags/require-merge-module-with.d.ts +5 -0
- package/dist/rules/required-tags/require-merge-module-with.d.ts.map +1 -0
- package/dist/rules/required-tags/require-merge-module-with.js +30 -0
- package/dist/rules/required-tags/require-merge-module-with.js.map +1 -0
- package/dist/rules/required-tags/require-module.cjs +32 -0
- package/dist/rules/required-tags/require-module.d.ts +5 -0
- package/dist/rules/required-tags/require-module.d.ts.map +1 -0
- package/dist/rules/required-tags/require-module.js +30 -0
- package/dist/rules/required-tags/require-module.js.map +1 -0
- package/dist/rules/required-tags/require-namespace.cjs +32 -0
- package/dist/rules/required-tags/require-namespace.d.ts +5 -0
- package/dist/rules/required-tags/require-namespace.d.ts.map +1 -0
- package/dist/rules/required-tags/require-namespace.js +30 -0
- package/dist/rules/required-tags/require-namespace.js.map +1 -0
- package/dist/rules/required-tags/require-overload.cjs +32 -0
- package/dist/rules/required-tags/require-overload.d.ts +5 -0
- package/dist/rules/required-tags/require-overload.d.ts.map +1 -0
- package/dist/rules/required-tags/require-overload.js +30 -0
- package/dist/rules/required-tags/require-overload.js.map +1 -0
- package/dist/rules/required-tags/require-override.cjs +0 -1
- package/dist/rules/required-tags/require-override.d.ts.map +1 -1
- package/dist/rules/required-tags/require-override.js +1 -2
- package/dist/rules/required-tags/require-override.js.map +1 -1
- package/dist/rules/required-tags/require-package-documentation.cjs +0 -1
- package/dist/rules/required-tags/require-package-documentation.d.ts.map +1 -1
- package/dist/rules/required-tags/require-package-documentation.js +1 -2
- package/dist/rules/required-tags/require-package-documentation.js.map +1 -1
- package/dist/rules/required-tags/require-param.cjs +0 -1
- package/dist/rules/required-tags/require-param.d.ts.map +1 -1
- package/dist/rules/required-tags/require-param.js +1 -2
- package/dist/rules/required-tags/require-param.js.map +1 -1
- package/dist/rules/required-tags/require-primary-export.cjs +32 -0
- package/dist/rules/required-tags/require-primary-export.d.ts +5 -0
- package/dist/rules/required-tags/require-primary-export.d.ts.map +1 -0
- package/dist/rules/required-tags/require-primary-export.js +30 -0
- package/dist/rules/required-tags/require-primary-export.js.map +1 -0
- package/dist/rules/required-tags/require-private-remarks.cjs +0 -1
- package/dist/rules/required-tags/require-private-remarks.d.ts.map +1 -1
- package/dist/rules/required-tags/require-private-remarks.js +1 -2
- package/dist/rules/required-tags/require-private-remarks.js.map +1 -1
- package/dist/rules/required-tags/require-private.cjs +32 -0
- package/dist/rules/required-tags/require-private.d.ts +5 -0
- package/dist/rules/required-tags/require-private.d.ts.map +1 -0
- package/dist/rules/required-tags/require-private.js +30 -0
- package/dist/rules/required-tags/require-private.js.map +1 -0
- package/dist/rules/required-tags/require-property.cjs +32 -0
- package/dist/rules/required-tags/require-property.d.ts +5 -0
- package/dist/rules/required-tags/require-property.d.ts.map +1 -0
- package/dist/rules/required-tags/require-property.js +30 -0
- package/dist/rules/required-tags/require-property.js.map +1 -0
- package/dist/rules/required-tags/require-protected.cjs +32 -0
- package/dist/rules/required-tags/require-protected.d.ts +5 -0
- package/dist/rules/required-tags/require-protected.d.ts.map +1 -0
- package/dist/rules/required-tags/require-protected.js +30 -0
- package/dist/rules/required-tags/require-protected.js.map +1 -0
- package/dist/rules/required-tags/require-public.cjs +0 -1
- package/dist/rules/required-tags/require-public.d.ts.map +1 -1
- package/dist/rules/required-tags/require-public.js +1 -2
- package/dist/rules/required-tags/require-public.js.map +1 -1
- package/dist/rules/required-tags/require-readonly.cjs +0 -1
- package/dist/rules/required-tags/require-readonly.d.ts.map +1 -1
- package/dist/rules/required-tags/require-readonly.js +1 -2
- package/dist/rules/required-tags/require-readonly.js.map +1 -1
- package/dist/rules/required-tags/require-remarks.cjs +0 -1
- package/dist/rules/required-tags/require-remarks.d.ts.map +1 -1
- package/dist/rules/required-tags/require-remarks.js +1 -2
- package/dist/rules/required-tags/require-remarks.js.map +1 -1
- package/dist/rules/required-tags/require-returns.cjs +0 -1
- package/dist/rules/required-tags/require-returns.d.ts.map +1 -1
- package/dist/rules/required-tags/require-returns.js +1 -2
- package/dist/rules/required-tags/require-returns.js.map +1 -1
- package/dist/rules/required-tags/require-sealed.cjs +0 -1
- package/dist/rules/required-tags/require-sealed.d.ts.map +1 -1
- package/dist/rules/required-tags/require-sealed.js +1 -2
- package/dist/rules/required-tags/require-sealed.js.map +1 -1
- package/dist/rules/required-tags/require-see.cjs +0 -1
- package/dist/rules/required-tags/require-see.d.ts.map +1 -1
- package/dist/rules/required-tags/require-see.js +1 -2
- package/dist/rules/required-tags/require-see.js.map +1 -1
- package/dist/rules/required-tags/require-since.cjs +32 -0
- package/dist/rules/required-tags/require-since.d.ts +5 -0
- package/dist/rules/required-tags/require-since.d.ts.map +1 -0
- package/dist/rules/required-tags/require-since.js +30 -0
- package/dist/rules/required-tags/require-since.js.map +1 -0
- package/dist/rules/required-tags/require-sort-strategy.cjs +32 -0
- package/dist/rules/required-tags/require-sort-strategy.d.ts +5 -0
- package/dist/rules/required-tags/require-sort-strategy.d.ts.map +1 -0
- package/dist/rules/required-tags/require-sort-strategy.js +30 -0
- package/dist/rules/required-tags/require-sort-strategy.js.map +1 -0
- package/dist/rules/required-tags/require-summary.cjs +32 -0
- package/dist/rules/required-tags/require-summary.d.ts +5 -0
- package/dist/rules/required-tags/require-summary.d.ts.map +1 -0
- package/dist/rules/required-tags/require-summary.js +30 -0
- package/dist/rules/required-tags/require-summary.js.map +1 -0
- package/dist/rules/required-tags/require-template.cjs +32 -0
- package/dist/rules/required-tags/require-template.d.ts +5 -0
- package/dist/rules/required-tags/require-template.d.ts.map +1 -0
- package/dist/rules/required-tags/require-template.js +30 -0
- package/dist/rules/required-tags/require-template.js.map +1 -0
- package/dist/rules/required-tags/require-throws.cjs +0 -1
- package/dist/rules/required-tags/require-throws.d.ts.map +1 -1
- package/dist/rules/required-tags/require-throws.js +1 -2
- package/dist/rules/required-tags/require-throws.js.map +1 -1
- package/dist/rules/required-tags/require-type-param.cjs +0 -1
- package/dist/rules/required-tags/require-type-param.d.ts.map +1 -1
- package/dist/rules/required-tags/require-type-param.js +1 -2
- package/dist/rules/required-tags/require-type-param.js.map +1 -1
- package/dist/rules/required-tags/require-use-declared-type.cjs +32 -0
- package/dist/rules/required-tags/require-use-declared-type.d.ts +5 -0
- package/dist/rules/required-tags/require-use-declared-type.d.ts.map +1 -0
- package/dist/rules/required-tags/require-use-declared-type.js +30 -0
- package/dist/rules/required-tags/require-use-declared-type.js.map +1 -0
- package/dist/rules/required-tags/require-virtual.cjs +0 -1
- package/dist/rules/required-tags/require-virtual.d.ts.map +1 -1
- package/dist/rules/required-tags/require-virtual.js +1 -2
- package/dist/rules/required-tags/require-virtual.js.map +1 -1
- package/dist/rules/restrict-tags.cjs +416 -0
- package/dist/rules/restrict-tags.d.ts +17 -0
- package/dist/rules/restrict-tags.d.ts.map +1 -0
- package/dist/rules/restrict-tags.js +414 -0
- package/dist/rules/restrict-tags.js.map +1 -0
- package/docs/rules/getting-started.md +97 -0
- package/docs/rules/index.md +61 -0
- package/docs/rules/presets/all.md +100 -0
- package/docs/rules/presets/detailed.md +41 -0
- package/docs/rules/presets/index.md +156 -0
- package/docs/rules/presets/jsdoc.md +43 -0
- package/docs/rules/presets/packages.md +41 -0
- package/docs/rules/presets/recommended.md +37 -0
- package/docs/rules/presets/tsdoc.md +45 -0
- package/docs/rules/presets/typedoc-strict.md +50 -0
- package/docs/rules/presets/typedoc.md +44 -0
- package/docs/rules/require.md +92 -56
- package/docs/rules/required-tags/require-abstract.md +87 -0
- package/docs/rules/required-tags/require-alpha.md +1 -1
- package/docs/rules/required-tags/require-author.md +87 -0
- package/docs/rules/required-tags/require-beta.md +1 -1
- package/docs/rules/required-tags/require-category.md +87 -0
- package/docs/rules/required-tags/require-class.md +71 -0
- package/docs/rules/required-tags/require-decorator.md +1 -1
- package/docs/rules/required-tags/require-default-value.md +1 -1
- package/docs/rules/required-tags/require-deprecated.md +1 -1
- package/docs/rules/required-tags/require-document.md +87 -0
- package/docs/rules/required-tags/require-enum.md +73 -0
- package/docs/rules/required-tags/require-event-property.md +1 -1
- package/docs/rules/required-tags/require-event.md +87 -0
- package/docs/rules/required-tags/require-example.md +1 -1
- package/docs/rules/required-tags/require-expand.md +87 -0
- package/docs/rules/required-tags/require-experimental.md +1 -1
- package/docs/rules/required-tags/require-function.md +74 -0
- package/docs/rules/required-tags/require-group.md +87 -0
- package/docs/rules/required-tags/require-hidden.md +87 -0
- package/docs/rules/required-tags/require-hideconstructor.md +87 -0
- package/docs/rules/required-tags/require-ignore.md +87 -0
- package/docs/rules/required-tags/require-import.md +87 -0
- package/docs/rules/required-tags/require-include.md +87 -0
- package/docs/rules/required-tags/require-inherit-doc.md +1 -1
- package/docs/rules/required-tags/require-inline.md +87 -0
- package/docs/rules/required-tags/require-interface.md +74 -0
- package/docs/rules/required-tags/require-internal.md +1 -1
- package/docs/rules/required-tags/require-label.md +1 -1
- package/docs/rules/required-tags/require-license.md +87 -0
- package/docs/rules/required-tags/require-link.md +1 -1
- package/docs/rules/required-tags/require-merge-module-with.md +87 -0
- package/docs/rules/required-tags/require-module.md +78 -0
- package/docs/rules/required-tags/require-namespace.md +87 -0
- package/docs/rules/required-tags/require-overload.md +87 -0
- package/docs/rules/required-tags/require-override.md +1 -1
- package/docs/rules/required-tags/require-package-documentation.md +44 -24
- package/docs/rules/required-tags/require-param.md +45 -25
- package/docs/rules/required-tags/require-primary-export.md +87 -0
- package/docs/rules/required-tags/require-private.md +87 -0
- package/docs/rules/required-tags/require-property.md +87 -0
- package/docs/rules/required-tags/require-protected.md +87 -0
- package/docs/rules/required-tags/require-remarks.md +40 -25
- package/docs/rules/required-tags/require-returns.md +45 -25
- package/docs/rules/required-tags/require-since.md +87 -0
- package/docs/rules/required-tags/require-sort-strategy.md +87 -0
- package/docs/rules/required-tags/require-summary.md +87 -0
- package/docs/rules/required-tags/require-template.md +87 -0
- package/docs/rules/required-tags/require-throws.md +53 -25
- package/docs/rules/required-tags/require-type-param.md +45 -25
- package/docs/rules/required-tags/require-use-declared-type.md +87 -0
- package/docs/rules/required-tags.md +171 -39
- package/docs/rules/restrict-tags.md +203 -0
- package/package.json +394 -45
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-license.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-license.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,yDAAyD;AACzD,MAAM,kBAAkB,GAAkB,aAAa,CAGrD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC7D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,iGAAiG;YACrG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,mHAAmH;SAC3H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,gEAAgE;SACvE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,iBAAiB;CAC1B,CAAC,CAAC;AAEH,eAAe,kBAAkB,CAAC"}
|
|
@@ -6,7 +6,6 @@ const RequireLinkRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
|
6
6
|
create(context) {
|
|
7
7
|
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@link");
|
|
8
8
|
},
|
|
9
|
-
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
10
9
|
meta: {
|
|
11
10
|
defaultOptions: [
|
|
12
11
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-link.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-link.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"require-link.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-link.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,sDAAsD;AACtD,QAAA,MAAM,eAAe,EAAE,aA8BrB,CAAC;AAEH,eAAe,eAAe,CAAC"}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import { createRequireTagRuleListener, createTagRule,
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
2
|
/** Rule module for `tsdoc-require-2/require-link`. */
|
|
3
3
|
const RequireLinkRule = createTagRule({
|
|
4
4
|
create(context) {
|
|
5
5
|
return createRequireTagRuleListener(context, "@link");
|
|
6
6
|
},
|
|
7
|
-
defaultOptions: defaultRuleOptions,
|
|
8
7
|
meta: {
|
|
9
8
|
defaultOptions: [
|
|
10
9
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-link.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-link.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,
|
|
1
|
+
{"version":3,"file":"require-link.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-link.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,sDAAsD;AACtD,MAAM,eAAe,GAAkB,aAAa,CAGlD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,oFAAoF;YACxF,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,gHAAgH;SACxH;QACD,QAAQ,EAAE;YACN,UAAU,EACN,6DAA6D;SACpE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,cAAc;CACvB,CAAC,CAAC;AAEH,eAAe,eAAe,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
/** Rule module for `tsdoc-require-2/require-merge-module-with`. */
|
|
5
|
+
const RequireMergeModuleWithRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
6
|
+
create(context) {
|
|
7
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@mergeModuleWith");
|
|
8
|
+
},
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @mergeModuleWith tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-merge-module-with.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @mergeModuleWith.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-merge-module-with",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireMergeModuleWithRule;
|
|
32
|
+
//# sourceMappingURL=require-merge-module-with.js.map
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { type TagRuleModule } from "../../internal/require-tag-factory.js";
|
|
2
|
+
/** Rule module for `tsdoc-require-2/require-merge-module-with`. */
|
|
3
|
+
declare const RequireMergeModuleWithRule: TagRuleModule;
|
|
4
|
+
export default RequireMergeModuleWithRule;
|
|
5
|
+
//# sourceMappingURL=require-merge-module-with.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-merge-module-with.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-merge-module-with.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,mEAAmE;AACnE,QAAA,MAAM,0BAA0B,EAAE,aA8BhC,CAAC;AAEH,eAAe,0BAA0B,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
/** Rule module for `tsdoc-require-2/require-merge-module-with`. */
|
|
3
|
+
const RequireMergeModuleWithRule = createTagRule({
|
|
4
|
+
create(context) {
|
|
5
|
+
return createRequireTagRuleListener(context, "@mergeModuleWith");
|
|
6
|
+
},
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @mergeModuleWith tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-merge-module-with.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @mergeModuleWith.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-merge-module-with",
|
|
28
|
+
});
|
|
29
|
+
export default RequireMergeModuleWithRule;
|
|
30
|
+
//# sourceMappingURL=require-merge-module-with.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-merge-module-with.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-merge-module-with.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,mEAAmE;AACnE,MAAM,0BAA0B,GAAkB,aAAa,CAG7D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,yGAAyG;YAC7G,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,6HAA6H;SACrI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,wEAAwE;SAC/E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,2BAA2B;CACpC,CAAC,CAAC;AAEH,eAAe,0BAA0B,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
/** Rule module for `tsdoc-require-2/require-module`. */
|
|
5
|
+
const RequireModuleRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
6
|
+
create(context) {
|
|
7
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@module");
|
|
8
|
+
},
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @module tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-module.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @module.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-module",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireModuleRule;
|
|
32
|
+
//# sourceMappingURL=require-module.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-module.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-module.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,wDAAwD;AACxD,QAAA,MAAM,iBAAiB,EAAE,aA8BvB,CAAC;AAEH,eAAe,iBAAiB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
/** Rule module for `tsdoc-require-2/require-module`. */
|
|
3
|
+
const RequireModuleRule = createTagRule({
|
|
4
|
+
create(context) {
|
|
5
|
+
return createRequireTagRuleListener(context, "@module");
|
|
6
|
+
},
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @module tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-module.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @module.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-module",
|
|
28
|
+
});
|
|
29
|
+
export default RequireModuleRule;
|
|
30
|
+
//# sourceMappingURL=require-module.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-module.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-module.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,wDAAwD;AACxD,MAAM,iBAAiB,GAAkB,aAAa,CAGpD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,gGAAgG;YACpG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,kHAAkH;SAC1H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,+DAA+D;SACtE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,gBAAgB;CACzB,CAAC,CAAC;AAEH,eAAe,iBAAiB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
/** Rule module for `tsdoc-require-2/require-namespace`. */
|
|
5
|
+
const RequireNamespaceRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
6
|
+
create(context) {
|
|
7
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@namespace");
|
|
8
|
+
},
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @namespace tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-namespace.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @namespace.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-namespace",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireNamespaceRule;
|
|
32
|
+
//# sourceMappingURL=require-namespace.js.map
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { type TagRuleModule } from "../../internal/require-tag-factory.js";
|
|
2
|
+
/** Rule module for `tsdoc-require-2/require-namespace`. */
|
|
3
|
+
declare const RequireNamespaceRule: TagRuleModule;
|
|
4
|
+
export default RequireNamespaceRule;
|
|
5
|
+
//# sourceMappingURL=require-namespace.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-namespace.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-namespace.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,2DAA2D;AAC3D,QAAA,MAAM,oBAAoB,EAAE,aA8B1B,CAAC;AAEH,eAAe,oBAAoB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
/** Rule module for `tsdoc-require-2/require-namespace`. */
|
|
3
|
+
const RequireNamespaceRule = createTagRule({
|
|
4
|
+
create(context) {
|
|
5
|
+
return createRequireTagRuleListener(context, "@namespace");
|
|
6
|
+
},
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @namespace tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-namespace.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @namespace.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-namespace",
|
|
28
|
+
});
|
|
29
|
+
export default RequireNamespaceRule;
|
|
30
|
+
//# sourceMappingURL=require-namespace.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-namespace.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-namespace.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,2DAA2D;AAC3D,MAAM,oBAAoB,GAAkB,aAAa,CAGvD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,mGAAmG;YACvG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,qHAAqH;SAC7H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,kEAAkE;SACzE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,mBAAmB;CAC5B,CAAC,CAAC;AAEH,eAAe,oBAAoB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
/** Rule module for `tsdoc-require-2/require-overload`. */
|
|
5
|
+
const RequireOverloadRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
6
|
+
create(context) {
|
|
7
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@overload");
|
|
8
|
+
},
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @overload tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-overload.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @overload.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-overload",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequireOverloadRule;
|
|
32
|
+
//# sourceMappingURL=require-overload.js.map
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { type TagRuleModule } from "../../internal/require-tag-factory.js";
|
|
2
|
+
/** Rule module for `tsdoc-require-2/require-overload`. */
|
|
3
|
+
declare const RequireOverloadRule: TagRuleModule;
|
|
4
|
+
export default RequireOverloadRule;
|
|
5
|
+
//# sourceMappingURL=require-overload.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-overload.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-overload.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,0DAA0D;AAC1D,QAAA,MAAM,mBAAmB,EAAE,aA8BzB,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
/** Rule module for `tsdoc-require-2/require-overload`. */
|
|
3
|
+
const RequireOverloadRule = createTagRule({
|
|
4
|
+
create(context) {
|
|
5
|
+
return createRequireTagRuleListener(context, "@overload");
|
|
6
|
+
},
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @overload tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-overload.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @overload.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-overload",
|
|
28
|
+
});
|
|
29
|
+
export default RequireOverloadRule;
|
|
30
|
+
//# sourceMappingURL=require-overload.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-overload.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-overload.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,0DAA0D;AAC1D,MAAM,mBAAmB,GAAkB,aAAa,CAGtD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,kGAAkG;YACtG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,oHAAoH;SAC5H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,iEAAiE;SACxE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,kBAAkB;CAC3B,CAAC,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
|
|
@@ -6,7 +6,6 @@ const RequireOverrideRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
|
6
6
|
create(context) {
|
|
7
7
|
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@override");
|
|
8
8
|
},
|
|
9
|
-
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
10
9
|
meta: {
|
|
11
10
|
defaultOptions: [
|
|
12
11
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-override.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-override.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"require-override.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-override.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,0DAA0D;AAC1D,QAAA,MAAM,mBAAmB,EAAE,aA8BzB,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import { createRequireTagRuleListener, createTagRule,
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
2
|
/** Rule module for `tsdoc-require-2/require-override`. */
|
|
3
3
|
const RequireOverrideRule = createTagRule({
|
|
4
4
|
create(context) {
|
|
5
5
|
return createRequireTagRuleListener(context, "@override");
|
|
6
6
|
},
|
|
7
|
-
defaultOptions: defaultRuleOptions,
|
|
8
7
|
meta: {
|
|
9
8
|
defaultOptions: [
|
|
10
9
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-override.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-override.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,
|
|
1
|
+
{"version":3,"file":"require-override.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-override.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,0DAA0D;AAC1D,MAAM,mBAAmB,GAAkB,aAAa,CAGtD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAC9D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,wFAAwF;YAC5F,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,oHAAoH;SAC5H;QACD,QAAQ,EAAE;YACN,UAAU,EACN,iEAAiE;SACxE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,kBAAkB;CAC3B,CAAC,CAAC;AAEH,eAAe,mBAAmB,CAAC"}
|
|
@@ -6,7 +6,6 @@ const RequirePackageDocumentationRule = (0, require_tag_factory_js_1.createTagRu
|
|
|
6
6
|
create(context) {
|
|
7
7
|
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@packageDocumentation");
|
|
8
8
|
},
|
|
9
|
-
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
10
9
|
meta: {
|
|
11
10
|
defaultOptions: [
|
|
12
11
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-package-documentation.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-package-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"require-package-documentation.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-package-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,uEAAuE;AACvE,QAAA,MAAM,+BAA+B,EAAE,aA8BrC,CAAC;AAEH,eAAe,+BAA+B,CAAC"}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import { createRequireTagRuleListener, createTagRule,
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
2
|
/** Rule module for `tsdoc-require-2/require-package-documentation`. */
|
|
3
3
|
const RequirePackageDocumentationRule = createTagRule({
|
|
4
4
|
create(context) {
|
|
5
5
|
return createRequireTagRuleListener(context, "@packageDocumentation");
|
|
6
6
|
},
|
|
7
|
-
defaultOptions: defaultRuleOptions,
|
|
8
7
|
meta: {
|
|
9
8
|
defaultOptions: [
|
|
10
9
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-package-documentation.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-package-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,
|
|
1
|
+
{"version":3,"file":"require-package-documentation.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-package-documentation.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,uEAAuE;AACvE,MAAM,+BAA+B,GAAkB,aAAa,CAGlE;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,oGAAoG;YACxG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,iIAAiI;SACzI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,6EAA6E;SACpF;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,+BAA+B;CACxC,CAAC,CAAC;AAEH,eAAe,+BAA+B,CAAC"}
|
|
@@ -6,7 +6,6 @@ const RequireParamRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
|
6
6
|
create(context) {
|
|
7
7
|
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@param");
|
|
8
8
|
},
|
|
9
|
-
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
10
9
|
meta: {
|
|
11
10
|
defaultOptions: [
|
|
12
11
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-param.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-param.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"require-param.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-param.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,uDAAuD;AACvD,QAAA,MAAM,gBAAgB,EAAE,aA8BtB,CAAC;AAEH,eAAe,gBAAgB,CAAC"}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import { createRequireTagRuleListener, createTagRule,
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
2
|
/** Rule module for `tsdoc-require-2/require-param`. */
|
|
3
3
|
const RequireParamRule = createTagRule({
|
|
4
4
|
create(context) {
|
|
5
5
|
return createRequireTagRuleListener(context, "@param");
|
|
6
6
|
},
|
|
7
|
-
defaultOptions: defaultRuleOptions,
|
|
8
7
|
meta: {
|
|
9
8
|
defaultOptions: [
|
|
10
9
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-param.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-param.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,
|
|
1
|
+
{"version":3,"file":"require-param.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-param.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,uDAAuD;AACvD,MAAM,gBAAgB,GAAkB,aAAa,CAGnD;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3D,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,qFAAqF;YACzF,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,iHAAiH;SACzH;QACD,QAAQ,EAAE;YACN,UAAU,EACN,8DAA8D;SACrE;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,eAAe;CACxB,CAAC,CAAC;AAEH,eAAe,gBAAgB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
/** Rule module for `tsdoc-require-2/require-primary-export`. */
|
|
5
|
+
const RequirePrimaryExportRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
6
|
+
create(context) {
|
|
7
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@primaryExport");
|
|
8
|
+
},
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @primaryExport tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-primary-export.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @primaryExport.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-primary-export",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequirePrimaryExportRule;
|
|
32
|
+
//# sourceMappingURL=require-primary-export.js.map
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import { type TagRuleModule } from "../../internal/require-tag-factory.js";
|
|
2
|
+
/** Rule module for `tsdoc-require-2/require-primary-export`. */
|
|
3
|
+
declare const RequirePrimaryExportRule: TagRuleModule;
|
|
4
|
+
export default RequirePrimaryExportRule;
|
|
5
|
+
//# sourceMappingURL=require-primary-export.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-primary-export.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-primary-export.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,gEAAgE;AAChE,QAAA,MAAM,wBAAwB,EAAE,aA8B9B,CAAC;AAEH,eAAe,wBAAwB,CAAC"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
|
+
/** Rule module for `tsdoc-require-2/require-primary-export`. */
|
|
3
|
+
const RequirePrimaryExportRule = createTagRule({
|
|
4
|
+
create(context) {
|
|
5
|
+
return createRequireTagRuleListener(context, "@primaryExport");
|
|
6
|
+
},
|
|
7
|
+
meta: {
|
|
8
|
+
defaultOptions: [
|
|
9
|
+
{
|
|
10
|
+
enforceFor: [...enforceableEntityKinds],
|
|
11
|
+
includeNonExported: false,
|
|
12
|
+
},
|
|
13
|
+
],
|
|
14
|
+
deprecated: false,
|
|
15
|
+
docs: {
|
|
16
|
+
description: "require @primaryExport tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
17
|
+
frozen: false,
|
|
18
|
+
recommended: false,
|
|
19
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-primary-export.md",
|
|
20
|
+
},
|
|
21
|
+
messages: {
|
|
22
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @primaryExport.",
|
|
23
|
+
},
|
|
24
|
+
schema: [optionSchema],
|
|
25
|
+
type: "problem",
|
|
26
|
+
},
|
|
27
|
+
name: "require-primary-export",
|
|
28
|
+
});
|
|
29
|
+
export default RequirePrimaryExportRule;
|
|
30
|
+
//# sourceMappingURL=require-primary-export.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-primary-export.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-primary-export.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,gEAAgE;AAChE,MAAM,wBAAwB,GAAkB,aAAa,CAG3D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;IACnE,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,uGAAuG;YAC3G,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,0HAA0H;SAClI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,sEAAsE;SAC7E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,wBAAwB;CACjC,CAAC,CAAC;AAEH,eAAe,wBAAwB,CAAC"}
|
|
@@ -6,7 +6,6 @@ const RequirePrivateRemarksRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
|
6
6
|
create(context) {
|
|
7
7
|
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@privateRemarks");
|
|
8
8
|
},
|
|
9
|
-
defaultOptions: require_tag_factory_js_1.defaultRuleOptions,
|
|
10
9
|
meta: {
|
|
11
10
|
defaultOptions: [
|
|
12
11
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-private-remarks.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-private-remarks.ts"],"names":[],"mappings":"AAAA,OAAO,
|
|
1
|
+
{"version":3,"file":"require-private-remarks.d.ts","sourceRoot":"","sources":["../../../src/rules/required-tags/require-private-remarks.ts"],"names":[],"mappings":"AAAA,OAAO,EAOH,KAAK,aAAa,EAErB,MAAM,uCAAuC,CAAC;AAE/C,iEAAiE;AACjE,QAAA,MAAM,yBAAyB,EAAE,aA8B/B,CAAC;AAEH,eAAe,yBAAyB,CAAC"}
|
|
@@ -1,10 +1,9 @@
|
|
|
1
|
-
import { createRequireTagRuleListener, createTagRule,
|
|
1
|
+
import { createRequireTagRuleListener, createTagRule, enforceableEntityKinds, optionSchema, } from "../../internal/require-tag-factory.js";
|
|
2
2
|
/** Rule module for `tsdoc-require-2/require-private-remarks`. */
|
|
3
3
|
const RequirePrivateRemarksRule = createTagRule({
|
|
4
4
|
create(context) {
|
|
5
5
|
return createRequireTagRuleListener(context, "@privateRemarks");
|
|
6
6
|
},
|
|
7
|
-
defaultOptions: defaultRuleOptions,
|
|
8
7
|
meta: {
|
|
9
8
|
defaultOptions: [
|
|
10
9
|
{
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"require-private-remarks.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-private-remarks.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,
|
|
1
|
+
{"version":3,"file":"require-private-remarks.js","sourceRoot":"","sources":["../../../src/rules/required-tags/require-private-remarks.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,4BAA4B,EAC5B,aAAa,EACb,sBAAsB,EACtB,YAAY,GAKf,MAAM,uCAAuC,CAAC;AAE/C,iEAAiE;AACjE,MAAM,yBAAyB,GAAkB,aAAa,CAG5D;IACE,MAAM,CAAC,OAAuB;QAC1B,OAAO,4BAA4B,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;IACpE,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE;YACZ;gBACI,UAAU,EAAE,CAAC,GAAG,sBAAsB,CAAC;gBACvC,kBAAkB,EAAE,KAAK;aAC5B;SACJ;QACD,UAAU,EAAE,KAAK;QACjB,IAAI,EAAE;YACF,WAAW,EACP,8FAA8F;YAClG,MAAM,EAAE,KAAK;YACb,WAAW,EAAE,KAAK;YAClB,GAAG,EAAE,2HAA2H;SACnI;QACD,QAAQ,EAAE;YACN,UAAU,EACN,uEAAuE;SAC9E;QACD,MAAM,EAAE,CAAC,YAAY,CAAC;QACtB,IAAI,EAAE,SAAS;KAClB;IACD,IAAI,EAAE,yBAAyB;CAClC,CAAC,CAAC;AAEH,eAAe,yBAAyB,CAAC"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const require_tag_factory_js_1 = require("../../internal/require-tag-factory.cjs");
|
|
4
|
+
/** Rule module for `tsdoc-require-2/require-private`. */
|
|
5
|
+
const RequirePrivateRule = (0, require_tag_factory_js_1.createTagRule)({
|
|
6
|
+
create(context) {
|
|
7
|
+
return (0, require_tag_factory_js_1.createRequireTagRuleListener)(context, "@private");
|
|
8
|
+
},
|
|
9
|
+
meta: {
|
|
10
|
+
defaultOptions: [
|
|
11
|
+
{
|
|
12
|
+
enforceFor: [...require_tag_factory_js_1.enforceableEntityKinds],
|
|
13
|
+
includeNonExported: false,
|
|
14
|
+
},
|
|
15
|
+
],
|
|
16
|
+
deprecated: false,
|
|
17
|
+
docs: {
|
|
18
|
+
description: "require @private tag in TSDoc blocks for supported TypeScript declarations and default exports.",
|
|
19
|
+
frozen: false,
|
|
20
|
+
recommended: false,
|
|
21
|
+
url: "https://github.com/Nick2bad4u/eslint-plugin-tsdoc-require-2/blob/main/docs/rules/required-tags/require-private.md",
|
|
22
|
+
},
|
|
23
|
+
messages: {
|
|
24
|
+
missingTag: "TSDoc for {{entityKind}} {{entityName}} must include @private.",
|
|
25
|
+
},
|
|
26
|
+
schema: [require_tag_factory_js_1.optionSchema],
|
|
27
|
+
type: "problem",
|
|
28
|
+
},
|
|
29
|
+
name: "require-private",
|
|
30
|
+
});
|
|
31
|
+
exports.default = RequirePrivateRule;
|
|
32
|
+
//# sourceMappingURL=require-private.js.map
|