eslint-plugin-jsdoc 55.1.0 → 55.1.1
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/WarnSettings.d.ts +17 -0
- package/dist/alignTransform.d.ts +34 -0
- package/dist/defaultTagOrder.d.ts +5 -0
- package/dist/exportParser.d.ts +41 -0
- package/dist/getDefaultTagStructureForMode.d.ts +11 -0
- package/dist/index-cjs.d.ts +17 -0
- package/dist/index-esm.d.ts +19 -0
- package/dist/jsdocUtils.d.ts +455 -0
- package/dist/rules/checkAccess.d.ts +3 -0
- package/dist/rules/checkAlignment.d.ts +3 -0
- package/dist/rules/checkExamples.d.ts +4 -0
- package/dist/rules/checkIndentation.d.ts +3 -0
- package/dist/rules/checkLineAlignment.d.ts +10 -0
- package/dist/rules/checkParamNames.d.ts +3 -0
- package/dist/rules/checkPropertyNames.d.ts +3 -0
- package/dist/rules/checkSyntax.d.ts +3 -0
- package/dist/rules/checkTagNames.d.ts +3 -0
- package/dist/rules/checkTemplateNames.d.ts +3 -0
- package/dist/rules/checkTypes.d.ts +3 -0
- package/dist/rules/checkValues.d.ts +3 -0
- package/dist/rules/convertToJsdocComments.d.ts +252 -0
- package/dist/rules/emptyTags.d.ts +3 -0
- package/dist/rules/implementsOnClasses.d.ts +3 -0
- package/dist/rules/importsAsDependencies.d.ts +3 -0
- package/dist/rules/informativeDocs.d.ts +3 -0
- package/dist/rules/linesBeforeBlock.d.ts +3 -0
- package/dist/rules/matchDescription.d.ts +3 -0
- package/dist/rules/matchName.d.ts +3 -0
- package/dist/rules/multilineBlocks.d.ts +3 -0
- package/dist/rules/noBadBlocks.d.ts +3 -0
- package/dist/rules/noBlankBlockDescriptions.d.ts +3 -0
- package/dist/rules/noBlankBlocks.d.ts +3 -0
- package/dist/rules/noDefaults.d.ts +3 -0
- package/dist/rules/noMissingSyntax.d.ts +10 -0
- package/dist/rules/noMultiAsterisks.d.ts +3 -0
- package/dist/rules/noRestrictedSyntax.d.ts +3 -0
- package/dist/rules/noTypes.d.ts +3 -0
- package/dist/rules/noUndefinedTypes.d.ts +3 -0
- package/dist/rules/requireAsteriskPrefix.d.ts +3 -0
- package/dist/rules/requireDescription.d.ts +3 -0
- package/dist/rules/requireDescriptionCompleteSentence.d.ts +3 -0
- package/dist/rules/requireExample.d.ts +3 -0
- package/dist/rules/requireFileOverview.d.ts +3 -0
- package/dist/rules/requireHyphenBeforeParamDescription.d.ts +3 -0
- package/dist/rules/requireJsdoc.d.ts +26 -0
- package/dist/rules/requireParam.d.ts +4 -0
- package/dist/rules/requireParamDescription.d.ts +3 -0
- package/dist/rules/requireParamName.d.ts +3 -0
- package/dist/rules/requireParamType.d.ts +3 -0
- package/dist/rules/requireProperty.d.ts +3 -0
- package/dist/rules/requirePropertyDescription.d.ts +3 -0
- package/dist/rules/requirePropertyName.d.ts +3 -0
- package/dist/rules/requirePropertyType.d.ts +3 -0
- package/dist/rules/requireReturns.d.ts +3 -0
- package/dist/rules/requireReturnsCheck.d.ts +3 -0
- package/dist/rules/requireReturnsDescription.d.ts +3 -0
- package/dist/rules/requireReturnsType.d.ts +3 -0
- package/dist/rules/requireTemplate.d.ts +3 -0
- package/dist/rules/requireThrows.d.ts +3 -0
- package/dist/rules/requireYields.d.ts +3 -0
- package/dist/rules/requireYieldsCheck.d.ts +3 -0
- package/dist/rules/sortTags.d.ts +3 -0
- package/dist/rules/tagLines.d.ts +3 -0
- package/dist/rules/textEscaping.d.ts +3 -0
- package/dist/rules/validTypes.d.ts +3 -0
- package/dist/rules.d.ts +766 -0
- package/dist/tagNames.d.ts +16 -0
- package/dist/utils/hasReturnValue.d.ts +20 -0
- package/package.json +1 -1
- package/src/rules.d.ts +766 -0
- package/typings/babel__eslint-parser.d.ts +1 -0
- package/typings/gitdown.d.ts +12 -0
- package/dist/getJsdocProcessorPlugin.d.ts.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/iterateJsdoc.d.ts.map +0 -1
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export type AliasedTags = {
|
|
2
|
+
[key: string]: string[];
|
|
3
|
+
};
|
|
4
|
+
/**
|
|
5
|
+
* @type {AliasedTags}
|
|
6
|
+
*/
|
|
7
|
+
export const closureTags: AliasedTags;
|
|
8
|
+
/**
|
|
9
|
+
* @type {AliasedTags}
|
|
10
|
+
*/
|
|
11
|
+
export const jsdocTags: AliasedTags;
|
|
12
|
+
/**
|
|
13
|
+
* @type {AliasedTags}
|
|
14
|
+
*/
|
|
15
|
+
export const typeScriptTags: AliasedTags;
|
|
16
|
+
//# sourceMappingURL=tagNames.d.ts.map
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
export type ESTreeOrTypeScriptNode = import("estree").Node | import("@typescript-eslint/types").TSESTree.Node;
|
|
2
|
+
export type PromiseFilter = (node: ESTreeOrTypeScriptNode | undefined) => boolean;
|
|
3
|
+
/**
|
|
4
|
+
* Checks if a node has a return statement. Void return does not count.
|
|
5
|
+
* @param {ESTreeOrTypeScriptNode|undefined|null} node
|
|
6
|
+
* @param {boolean} [throwOnNullReturn]
|
|
7
|
+
* @param {PromiseFilter} [promFilter]
|
|
8
|
+
* @returns {boolean|undefined}
|
|
9
|
+
*/
|
|
10
|
+
export function hasReturnValue(node: ESTreeOrTypeScriptNode | undefined | null, throwOnNullReturn?: boolean, promFilter?: PromiseFilter): boolean | undefined;
|
|
11
|
+
/**
|
|
12
|
+
* Checks if a Promise executor has no resolve value or an empty value.
|
|
13
|
+
* An `undefined` resolve does not count.
|
|
14
|
+
* @param {ESTreeOrTypeScriptNode} node
|
|
15
|
+
* @param {boolean} anyPromiseAsReturn
|
|
16
|
+
* @param {boolean} [allBranches]
|
|
17
|
+
* @returns {boolean}
|
|
18
|
+
*/
|
|
19
|
+
export function hasValueOrExecutorHasNonEmptyResolveValue(node: ESTreeOrTypeScriptNode, anyPromiseAsReturn: boolean, allBranches?: boolean): boolean;
|
|
20
|
+
//# sourceMappingURL=hasReturnValue.d.ts.map
|
package/package.json
CHANGED