eslint-plugin-jsdoc 63.3.3 → 64.0.0

package/dist/buildForbidRuleDefinition.cjs

@@ -1,101 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.buildForbidRuleDefinition = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("./iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * @typedef {(string|{
- *   comment: string,
- *   context: string,
- *   message?: string
- * })[]} Contexts
- */
-
-/**
- * @param {{
- *   contexts?: Contexts,
- *   description?: string,
- *   getContexts?: (
- *     ctxt: import('eslint').Rule.RuleContext,
- *     report: import('./iterateJsdoc.js').Report
- *   ) => Contexts|false,
- *   contextName?: string,
- *   modifyContext?: (context: import('eslint').Rule.RuleContext) => import('eslint').Rule.RuleContext,
- *   schema?: import('eslint').Rule.RuleMetaData['schema']
- *   url?: string,
- * }} cfg
- * @returns {import('eslint').Rule.RuleModule}
- */
-const buildForbidRuleDefinition = ({
-  contextName,
-  contexts: cntxts,
-  description,
-  getContexts,
-  modifyContext,
-  schema,
-  url
-}) => {
-  return (0, _iterateJsdoc.default)(({
-    context,
-    info: {
-      comment
-    },
-    report,
-    utils
-  }) => {
-    /** @type {Contexts|boolean|undefined} */
-    let contexts = cntxts;
-    if (getContexts) {
-      contexts = getContexts(context, report);
-      if (!contexts) {
-        return;
-      }
-    }
-    const {
-      contextStr,
-      foundContext
-    } = utils.findContext(/** @type {Contexts} */contexts, comment);
-
-    // We are not on the *particular* matching context/comment, so don't assume
-    //   we need reporting
-    if (!foundContext) {
-      return;
-    }
-    const message = /** @type {import('./iterateJsdoc.js').ContextObject} */foundContext?.message ?? 'Syntax is restricted: {{context}}' + (comment ? ' with {{comment}}' : '');
-    report(message, null, null, comment ? {
-      comment,
-      context: contextStr
-    } : {
-      context: contextStr
-    });
-  }, {
-    contextSelected: true,
-    meta: {
-      docs: {
-        description: description ?? contextName ?? 'Reports when certain comment structures are present.',
-        url: url ?? 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/advanced.md#user-content-advanced-creating-your-own-rules'
-      },
-      schema: schema ?? [],
-      type: 'suggestion'
-    },
-    modifyContext: modifyContext ?? (getContexts ? undefined : context => {
-      // Reproduce context object with our own `contexts`
-      const propertyDescriptors = Object.getOwnPropertyDescriptors(context);
-      return Object.create(Object.getPrototypeOf(context), {
-        ...propertyDescriptors,
-        options: {
-          ...propertyDescriptors.options,
-          value: [{
-            contexts: cntxts
-          }]
-        }
-      });
-    }),
-    nonGlobalSettings: true
-  });
-};
-exports.buildForbidRuleDefinition = buildForbidRuleDefinition;
-//# sourceMappingURL=buildForbidRuleDefinition.cjs.map

package/dist/buildForbidRuleDefinition.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"buildForbidRuleDefinition.cjs","names":["iterateJsdoc"],"sources":["../src/buildForbidRuleDefinition.js"],"sourcesContent":["import iterateJsdoc from './iterateJsdoc.js';\n\n/**\n * @typedef {(string|{\n *   comment: string,\n *   context: string,\n *   message?: string\n * })[]} Contexts\n */\n\n/**\n * @param {{\n *   contexts?: Contexts,\n *   description?: string,\n *   getContexts?: (\n *     ctxt: import('eslint').Rule.RuleContext,\n *     report: import('./iterateJsdoc.js').Report\n *   ) => Contexts|false,\n *   contextName?: string,\n *   modifyContext?: (context: import('eslint').Rule.RuleContext) => import('eslint').Rule.RuleContext,\n *   schema?: import('eslint').Rule.RuleMetaData['schema']\n *   url?: string,\n * }} cfg\n * @returns {import('eslint').Rule.RuleModule}\n */\nexport const buildForbidRuleDefinition = ({\n  contextName,\n  contexts: cntxts,\n  description,\n  getContexts,\n  modifyContext,\n  schema,\n  url,\n}) => {\n  return iterateJsdoc(({\n    context,\n    info: {\n      comment,\n    },\n    report,\n    utils,\n  }) => {\n    /** @type {Contexts|boolean|undefined} */\n    let contexts = cntxts;\n\n    if (getContexts) {\n      contexts = getContexts(context, report);\n      if (!contexts) {\n        return;\n      }\n    }\n\n    const {\n      contextStr,\n      foundContext,\n    } = utils.findContext(/** @type {Contexts} */ (contexts), comment);\n\n    // We are not on the *particular* matching context/comment, so don't assume\n    //   we need reporting\n    if (!foundContext) {\n      return;\n    }\n\n    const message = /** @type {import('./iterateJsdoc.js').ContextObject} */ (\n      foundContext\n    )?.message ??\n      'Syntax is restricted: {{context}}' +\n        (comment ? ' with {{comment}}' : '');\n\n    report(message, null, null, comment ? {\n      comment,\n      context: contextStr,\n    } : {\n      context: contextStr,\n    });\n  }, {\n    contextSelected: true,\n    meta: {\n      docs: {\n        description: description ?? contextName ?? 'Reports when certain comment structures are present.',\n        url: url ?? 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/advanced.md#user-content-advanced-creating-your-own-rules',\n      },\n      schema: schema ?? [],\n      type: 'suggestion',\n    },\n    modifyContext: modifyContext ?? (getContexts ? undefined : (context) => {\n      // Reproduce context object with our own `contexts`\n      const propertyDescriptors = Object.getOwnPropertyDescriptors(context);\n      return Object.create(\n        Object.getPrototypeOf(context),\n        {\n          ...propertyDescriptors,\n          options: {\n            ...propertyDescriptors.options,\n            value: [\n              {\n                contexts: cntxts,\n              },\n            ],\n          },\n        },\n      );\n    }),\n    nonGlobalSettings: true,\n  });\n};\n"],"mappings":";;;;;;AAAA;AAA6C;AAE7C;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAM,yBAAyB,GAAG,CAAC;EACxC,WAAW;EACX,QAAQ,EAAE,MAAM;EAChB,WAAW;EACX,WAAW;EACX,aAAa;EACb,MAAM;EACN;AACF,CAAC,KAAK;EACJ,OAAO,IAAAA,qBAAY,EAAC,CAAC;IACnB,OAAO;IACP,IAAI,EAAE;MACJ;IACF,CAAC;IACD,MAAM;IACN;EACF,CAAC,KAAK;IACJ;IACA,IAAI,QAAQ,GAAG,MAAM;IAErB,IAAI,WAAW,EAAE;MACf,QAAQ,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC;MACvC,IAAI,CAAC,QAAQ,EAAE;QACb;MACF;IACF;IAEA,MAAM;MACJ,UAAU;MACV;IACF,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,uBAAyB,QAAQ,EAAG,OAAO,CAAC;;IAElE;IACA;IACA,IAAI,CAAC,YAAY,EAAE;MACjB;IACF;IAEA,MAAM,OAAO,GAAG,wDACd,YAAY,EACX,OAAO,IACR,mCAAmC,IAChC,OAAO,GAAG,mBAAmB,GAAG,EAAE,CAAC;IAExC,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,GAAG;MACpC,OAAO;MACP,OAAO,EAAE;IACX,CAAC,GAAG;MACF,OAAO,EAAE;IACX,CAAC,CAAC;EACJ,CAAC,EAAE;IACD,eAAe,EAAE,IAAI;IACrB,IAAI,EAAE;MACJ,IAAI,EAAE;QACJ,WAAW,EAAE,WAAW,IAAI,WAAW,IAAI,sDAAsD;QACjG,GAAG,EAAE,GAAG,IAAI;MACd,CAAC;MACD,MAAM,EAAE,MAAM,IAAI,EAAE;MACpB,IAAI,EAAE;IACR,CAAC;IACD,aAAa,EAAE,aAAa,KAAK,WAAW,GAAG,SAAS,GAAI,OAAO,IAAK;MACtE;MACA,MAAM,mBAAmB,GAAG,MAAM,CAAC,yBAAyB,CAAC,OAAO,CAAC;MACrE,OAAO,MAAM,CAAC,MAAM,CAClB,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EAC9B;QACE,GAAG,mBAAmB;QACtB,OAAO,EAAE;UACP,GAAG,mBAAmB,CAAC,OAAO;UAC9B,KAAK,EAAE,CACL;YACE,QAAQ,EAAE;UACZ,CAAC;QAEL;MACF,CACF,CAAC;IACH,CAAC,CAAC;IACF,iBAAiB,EAAE;EACrB,CAAC,CAAC;AACJ,CAAC;AAAC","ignoreList":[]}

package/dist/buildRejectOrPreferRuleDefinition.cjs

@@ -1,352 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.buildRejectOrPreferRuleDefinition = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("./iterateJsdoc.cjs"));
-var _jsdoccomment = require("@es-joy/jsdoccomment");
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * Adjusts the parent type node `meta` for generic matches (or type node
- * `type` for `JsdocTypeAny`) and sets the type node `value`.
- * @param {string} type The actual type
- * @param {string} preferred The preferred type
- * @param {boolean} isGenericMatch
- * @param {string} typeNodeName
- * @param {import('jsdoc-type-pratt-parser').NonRootResult} node
- * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
- * @returns {void}
- */
-const adjustNames = (type, preferred, isGenericMatch, typeNodeName, node, parentNode) => {
-  let ret = preferred;
-  if (isGenericMatch) {
-    const parentMeta = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */parentNode.meta;
-    if (preferred === '[]') {
-      parentMeta.brackets = 'square';
-      parentMeta.dot = false;
-      ret = 'Array';
-    } else {
-      const dotBracketEnd = preferred.match(/\.(?:<>)?$/v);
-      if (dotBracketEnd) {
-        parentMeta.brackets = 'angle';
-        parentMeta.dot = true;
-        ret = preferred.slice(0, -dotBracketEnd[0].length);
-      } else {
-        const bracketEnd = preferred.endsWith('<>');
-        if (bracketEnd) {
-          parentMeta.brackets = 'angle';
-          parentMeta.dot = false;
-          ret = preferred.slice(0, -2);
-        } else if (parentMeta?.brackets === 'square' && (typeNodeName === '[]' || typeNodeName === 'Array')) {
-          parentMeta.brackets = 'angle';
-          parentMeta.dot = false;
-        }
-      }
-    }
-  } else if (type === 'JsdocTypeAny') {
-    node.type = 'JsdocTypeName';
-  }
-
-  /** @type {import('jsdoc-type-pratt-parser').NameResult} */
-  node.value = ret.replace(/(?:\.|<>|\.<>|\[\])$/v, '');
-
-  // For bare pseudo-types like `<>`
-  if (!ret) {
-    /** @type {import('jsdoc-type-pratt-parser').NameResult} */node.value = typeNodeName;
-  }
-};
-
-/**
- * @param {boolean} [upperCase]
- * @returns {string}
- */
-const getMessage = upperCase => {
-  return 'Use object shorthand or index signatures instead of ' + '`' + (upperCase ? 'O' : 'o') + 'bject`, e.g., `{[key: string]: string}`';
-};
-
-/**
- * @type {{
- *   message: string,
- *   replacement: false
- * }}
- */
-const info = {
-  message: getMessage(),
-  replacement: false
-};
-
-/**
- * @type {{
- *   message: string,
- *   replacement: false
- * }}
- */
-const infoUC = {
-  message: getMessage(true),
-  replacement: false
-};
-
-/**
- * @param {{
- *   checkNativeTypes?: import('./rules/checkTypes.js').CheckNativeTypes|null
- *   overrideSettings?: import('./iterateJsdoc.js').Settings['preferredTypes']|null,
- *   description?: string,
- *   schema?: import('eslint').Rule.RuleMetaData['schema'],
- *   typeName?: string,
- *   url?: string,
- * }} cfg
- * @returns {import('eslint').Rule.RuleModule}
- */
-const buildRejectOrPreferRuleDefinition = ({
-  checkNativeTypes = null,
-  typeName,
-  description = typeName ?? 'Reports types deemed invalid (customizable and with defaults, for preventing and/or recommending replacements).',
-  overrideSettings = null,
-  schema = [],
-  url = 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header'
-}) => {
-  return (0, _iterateJsdoc.default)(({
-    context,
-    jsdocNode,
-    report,
-    settings,
-    sourceCode,
-    utils
-  }) => {
-    const jsdocTagsWithPossibleType = utils.filterTags(tag => {
-      return Boolean(utils.tagMightHaveTypePosition(tag.tag));
-    });
-    const
-    /**
-     * @type {{
-     *   preferredTypes: import('./iterateJsdoc.js').PreferredTypes,
-     *   structuredTags: import('./iterateJsdoc.js').StructuredTags,
-     *   mode: import('./jsdocUtils.js').ParserMode
-     * }}
-     */
-    {
-      mode,
-      preferredTypes: preferredTypesOriginal,
-      structuredTags
-    } = overrideSettings ? {
-      mode: settings.mode,
-      preferredTypes: overrideSettings,
-      structuredTags: {}
-    } : settings;
-    const injectObjectPreferredTypes = !overrideSettings && !('Object' in preferredTypesOriginal || 'object' in preferredTypesOriginal || 'object.<>' in preferredTypesOriginal || 'Object.<>' in preferredTypesOriginal || 'object<>' in preferredTypesOriginal);
-
-    /** @type {import('./iterateJsdoc.js').PreferredTypes} */
-    const typeToInject = mode === 'typescript' ? {
-      Object: 'object',
-      'object.<>': info,
-      'Object.<>': infoUC,
-      'object<>': info,
-      'Object<>': infoUC
-    } : {
-      Object: 'object',
-      'object.<>': 'Object<>',
-      'Object.<>': 'Object<>',
-      'object<>': 'Object<>'
-    };
-
-    /** @type {import('./iterateJsdoc.js').PreferredTypes} */
-    const preferredTypes = {
-      ...(injectObjectPreferredTypes ? typeToInject : {}),
-      ...preferredTypesOriginal
-    };
-    const
-    /**
-     * @type {{
-     *   noDefaults: boolean,
-     *   unifyParentAndChildTypeChecks: boolean,
-     *   exemptTagContexts: ({
-     *     tag: string,
-     *     types: true|string[]
-     *   })[]
-     * }}
-     */
-    {
-      exemptTagContexts = [],
-      noDefaults,
-      unifyParentAndChildTypeChecks
-    } = context.options[0] || {};
-
-    /**
-     * Gets information about the preferred type: whether there is a matching
-     * preferred type, what the type is, and whether it is a match to a generic.
-     * @param {string} _type Not currently in use
-     * @param {string} typeNodeName
-     * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
-     * @param {string|undefined} property
-     * @returns {[hasMatchingPreferredType: boolean, typeName: string, isGenericMatch: boolean]}
-     */
-    const getPreferredTypeInfo = (_type, typeNodeName, parentNode, property) => {
-      let hasMatchingPreferredType = false;
-      let isGenericMatch = false;
-      let typName = typeNodeName;
-      const isNameOfGeneric = parentNode !== undefined && parentNode.type === 'JsdocTypeGeneric' && property === 'left';
-      const brackets = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */parentNode?.meta?.brackets;
-      const dot = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */parentNode?.meta?.dot;
-      if (brackets === 'angle') {
-        const checkPostFixes = dot ? ['.', '.<>'] : ['<>'];
-        isGenericMatch = checkPostFixes.some(checkPostFix => {
-          const preferredType = preferredTypes?.[typeNodeName + checkPostFix];
-
-          // Does `unifyParentAndChildTypeChecks` need to be checked here?
-          if ((unifyParentAndChildTypeChecks || isNameOfGeneric || (/* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */
-          typeof preferredType === 'object' && preferredType?.unifyParentAndChildTypeChecks)) && preferredType !== undefined) {
-            typName += checkPostFix;
-            return true;
-          }
-          return false;
-        });
-      }
-      if (!isGenericMatch && property && /** @type {import('jsdoc-type-pratt-parser').NonRootResult} */parentNode.type === 'JsdocTypeGeneric') {
-        const checkPostFixes = dot ? ['.', '.<>'] : [brackets === 'angle' ? '<>' : '[]'];
-        isGenericMatch = checkPostFixes.some(checkPostFix => {
-          const preferredType = preferredTypes?.[checkPostFix];
-          if (
-          // Does `unifyParentAndChildTypeChecks` need to be checked here?
-          (unifyParentAndChildTypeChecks || isNameOfGeneric || (/* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */
-          typeof preferredType === 'object' && preferredType?.unifyParentAndChildTypeChecks)) && preferredType !== undefined) {
-            typName = checkPostFix;
-            return true;
-          }
-          return false;
-        });
-      }
-      const prefType = preferredTypes?.[typeNodeName];
-      const directNameMatch = prefType !== undefined && !Object.values(preferredTypes).includes(typeNodeName);
-      const specificUnify = typeof prefType === 'object' && prefType?.unifyParentAndChildTypeChecks;
-      const unifiedSyntaxParentMatch = property && directNameMatch && (unifyParentAndChildTypeChecks || specificUnify);
-      isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);
-      hasMatchingPreferredType = isGenericMatch || directNameMatch && !property;
-      return [hasMatchingPreferredType, typName, isGenericMatch];
-    };
-
-    /**
-     * Collect invalid type info.
-     * @param {string} type
-     * @param {string} value
-     * @param {string} tagName
-     * @param {string} nameInTag
-     * @param {number} idx
-     * @param {string|undefined} property
-     * @param {import('jsdoc-type-pratt-parser').NonRootResult} node
-     * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode
-     * @param {(string|false|undefined)[][]} invalidTypes
-     * @returns {void}
-     */
-    const getInvalidTypes = (type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes) => {
-      let typeNodeName = type === 'JsdocTypeAny' ? '*' : value;
-      const [hasMatchingPreferredType, typName, isGenericMatch] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);
-      let preferred;
-      let types;
-      if (hasMatchingPreferredType) {
-        const preferredSetting = preferredTypes[typName];
-        typeNodeName = typName === '[]' ? typName : typeNodeName;
-        if (!preferredSetting) {
-          invalidTypes.push([typeNodeName]);
-        } else if (typeof preferredSetting === 'string') {
-          preferred = preferredSetting;
-          invalidTypes.push([typeNodeName, preferred]);
-        } else if (preferredSetting && typeof preferredSetting === 'object') {
-          const nextItem = preferredSetting.skipRootChecking && jsdocTagsWithPossibleType[idx + 1];
-          if (!nextItem || !nextItem.name.startsWith(`${nameInTag}.`)) {
-            preferred = preferredSetting.replacement;
-            invalidTypes.push([typeNodeName, preferred, preferredSetting.message]);
-          }
-        } else {
-          utils.reportSettings('Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.');
-          return;
-        }
-      } else if (Object.entries(structuredTags).some(([tag, {
-        type: typs
-      }]) => {
-        types = typs;
-        return tag === tagName && Array.isArray(types) && !types.includes(typeNodeName);
-      })) {
-        invalidTypes.push([typeNodeName, types]);
-      } else if (checkNativeTypes && !noDefaults && type === 'JsdocTypeName') {
-        preferred = checkNativeTypes(preferredTypes, typeNodeName, preferred, parentNode, invalidTypes);
-      }
-
-      // For fixer
-      if (preferred) {
-        adjustNames(type, preferred, isGenericMatch, typeNodeName, node, parentNode);
-      }
-    };
-    for (const [idx, jsdocTag] of jsdocTagsWithPossibleType.entries()) {
-      /** @type {(string|false|undefined)[][]} */
-      const invalidTypes = [];
-      let typeAst;
-      try {
-        typeAst = mode === 'permissive' ? (0, _jsdoccomment.tryParse)(jsdocTag.type) : (0, _jsdoccomment.parse)(jsdocTag.type, mode);
-      } catch {
-        continue;
-      }
-      const {
-        name: nameInTag,
-        tag: tagName
-      } = jsdocTag;
-      (0, _jsdoccomment.traverse)(typeAst, (node, parentNode, property) => {
-        const {
-          type,
-          value
-        } =
-        /**
-         * @type {import('jsdoc-type-pratt-parser').NameResult}
-         */
-        node;
-        if (!['JsdocTypeAny', 'JsdocTypeName'].includes(type)) {
-          return;
-        }
-        getInvalidTypes(type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes);
-      });
-      if (invalidTypes.length) {
-        const fixedType = (0, _jsdoccomment.stringify)(typeAst);
-
-        /**
-         * @type {import('eslint').Rule.ReportFixer}
-         */
-        const fix = fixer => {
-          return fixer.replaceText(jsdocNode, sourceCode.getText(jsdocNode).replace(`{${jsdocTag.type}}`, `{${fixedType}}`));
-        };
-        for (const [badType, preferredType = '', msg] of invalidTypes) {
-          const tagValue = jsdocTag.name ? ` "${jsdocTag.name}"` : '';
-          if (exemptTagContexts.some(({
-            tag,
-            types
-          }) => {
-            return tag === tagName && (types === true || types.includes(jsdocTag.type));
-          })) {
-            continue;
-          }
-          report(msg || `Invalid JSDoc @${tagName}${tagValue} type "${badType}"` + (preferredType ? '; ' : '.') + (preferredType ? `prefer: ${JSON.stringify(preferredType)}.` : ''), preferredType ? fix : null, jsdocTag, msg ? {
-            tagName,
-            tagValue
-          } : undefined);
-        }
-      }
-    }
-  }, {
-    iterateAllJsdocs: true,
-    meta: {
-      docs: {
-        description,
-        url
-      },
-      ...(!overrideSettings || Object.values(overrideSettings).some(os => {
-        return os && typeof os === 'object' ? /* c8 ignore next -- Ok */
-        os.replacement : typeof os === 'string';
-      }) ? {
-        fixable: 'code'
-      } : {}),
-      schema,
-      type: 'suggestion'
-    }
-  });
-};
-exports.buildRejectOrPreferRuleDefinition = buildRejectOrPreferRuleDefinition;
-//# sourceMappingURL=buildRejectOrPreferRuleDefinition.cjs.map

package/dist/buildRejectOrPreferRuleDefinition.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"buildRejectOrPreferRuleDefinition.cjs","names":["iterateJsdoc","tryParse","parse","traverse","stringify"],"sources":["../src/buildRejectOrPreferRuleDefinition.js"],"sourcesContent":["import iterateJsdoc from './iterateJsdoc.js';\nimport {\n  parse,\n  stringify,\n  traverse,\n  tryParse,\n} from '@es-joy/jsdoccomment';\n\n/**\n * Adjusts the parent type node `meta` for generic matches (or type node\n * `type` for `JsdocTypeAny`) and sets the type node `value`.\n * @param {string} type The actual type\n * @param {string} preferred The preferred type\n * @param {boolean} isGenericMatch\n * @param {string} typeNodeName\n * @param {import('jsdoc-type-pratt-parser').NonRootResult} node\n * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n * @returns {void}\n */\nconst adjustNames = (type, preferred, isGenericMatch, typeNodeName, node, parentNode) => {\n  let ret = preferred;\n  if (isGenericMatch) {\n    const parentMeta = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (\n      parentNode\n    ).meta;\n    if (preferred === '[]') {\n      parentMeta.brackets = 'square';\n      parentMeta.dot = false;\n      ret = 'Array';\n    } else {\n      const dotBracketEnd = preferred.match(/\\.(?:<>)?$/v);\n      if (dotBracketEnd) {\n        parentMeta.brackets = 'angle';\n        parentMeta.dot = true;\n        ret = preferred.slice(0, -dotBracketEnd[0].length);\n      } else {\n        const bracketEnd = preferred.endsWith('<>');\n        if (bracketEnd) {\n          parentMeta.brackets = 'angle';\n          parentMeta.dot = false;\n          ret = preferred.slice(0, -2);\n        } else if (\n          parentMeta?.brackets === 'square' &&\n          (typeNodeName === '[]' || typeNodeName === 'Array')\n        ) {\n          parentMeta.brackets = 'angle';\n          parentMeta.dot = false;\n        }\n      }\n    }\n  } else if (type === 'JsdocTypeAny') {\n    node.type = 'JsdocTypeName';\n  }\n\n  /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (\n    node\n  ).value = ret.replace(/(?:\\.|<>|\\.<>|\\[\\])$/v, '');\n\n  // For bare pseudo-types like `<>`\n  if (!ret) {\n    /** @type {import('jsdoc-type-pratt-parser').NameResult} */ (\n      node\n    ).value = typeNodeName;\n  }\n};\n\n/**\n * @param {boolean} [upperCase]\n * @returns {string}\n */\nconst getMessage = (upperCase) => {\n  return 'Use object shorthand or index signatures instead of ' +\n  '`' + (upperCase ? 'O' : 'o') + 'bject`, e.g., `{[key: string]: string}`';\n};\n\n/**\n * @type {{\n *   message: string,\n *   replacement: false\n * }}\n */\nconst info = {\n  message: getMessage(),\n  replacement: false,\n};\n\n/**\n * @type {{\n *   message: string,\n *   replacement: false\n * }}\n */\nconst infoUC = {\n  message: getMessage(true),\n  replacement: false,\n};\n\n/**\n * @param {{\n *   checkNativeTypes?: import('./rules/checkTypes.js').CheckNativeTypes|null\n *   overrideSettings?: import('./iterateJsdoc.js').Settings['preferredTypes']|null,\n *   description?: string,\n *   schema?: import('eslint').Rule.RuleMetaData['schema'],\n *   typeName?: string,\n *   url?: string,\n * }} cfg\n * @returns {import('eslint').Rule.RuleModule}\n */\nexport const buildRejectOrPreferRuleDefinition = ({\n  checkNativeTypes = null,\n  typeName,\n  description = typeName ?? 'Reports types deemed invalid (customizable and with defaults, for preventing and/or recommending replacements).',\n  overrideSettings = null,\n  schema = [],\n  url = 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header',\n}) => {\n  return iterateJsdoc(\n    ({\n      context,\n      jsdocNode,\n      report,\n      settings,\n      sourceCode,\n      utils,\n    }) => {\n      const jsdocTagsWithPossibleType = utils.filterTags((tag) => {\n        return Boolean(utils.tagMightHaveTypePosition(tag.tag));\n      });\n\n      const\n        /**\n         * @type {{\n         *   preferredTypes: import('./iterateJsdoc.js').PreferredTypes,\n         *   structuredTags: import('./iterateJsdoc.js').StructuredTags,\n         *   mode: import('./jsdocUtils.js').ParserMode\n         * }}\n         */\n        {\n          mode,\n          preferredTypes: preferredTypesOriginal,\n          structuredTags,\n        } = overrideSettings ? {\n          mode: settings.mode,\n          preferredTypes: overrideSettings,\n          structuredTags: {},\n        } : settings;\n\n      const injectObjectPreferredTypes = !overrideSettings &&\n        !('Object' in preferredTypesOriginal ||\n        'object' in preferredTypesOriginal ||\n        'object.<>' in preferredTypesOriginal ||\n        'Object.<>' in preferredTypesOriginal ||\n        'object<>' in preferredTypesOriginal);\n\n      /** @type {import('./iterateJsdoc.js').PreferredTypes} */\n      const typeToInject = mode === 'typescript' ?\n        {\n          Object: 'object',\n          'object.<>': info,\n          'Object.<>': infoUC,\n          'object<>': info,\n          'Object<>': infoUC,\n        } :\n        {\n          Object: 'object',\n          'object.<>': 'Object<>',\n          'Object.<>': 'Object<>',\n          'object<>': 'Object<>',\n        };\n\n      /** @type {import('./iterateJsdoc.js').PreferredTypes} */\n      const preferredTypes = {\n        ...injectObjectPreferredTypes ?\n          typeToInject :\n          {},\n        ...preferredTypesOriginal,\n      };\n\n      const\n        /**\n         * @type {{\n         *   noDefaults: boolean,\n         *   unifyParentAndChildTypeChecks: boolean,\n         *   exemptTagContexts: ({\n         *     tag: string,\n         *     types: true|string[]\n         *   })[]\n         * }}\n         */ {\n          exemptTagContexts = [],\n          noDefaults,\n          unifyParentAndChildTypeChecks,\n        } = context.options[0] || {};\n\n      /**\n       * Gets information about the preferred type: whether there is a matching\n       * preferred type, what the type is, and whether it is a match to a generic.\n       * @param {string} _type Not currently in use\n       * @param {string} typeNodeName\n       * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n       * @param {string|undefined} property\n       * @returns {[hasMatchingPreferredType: boolean, typeName: string, isGenericMatch: boolean]}\n       */\n      const getPreferredTypeInfo = (_type, typeNodeName, parentNode, property) => {\n        let hasMatchingPreferredType = false;\n        let isGenericMatch = false;\n        let typName = typeNodeName;\n\n        const isNameOfGeneric = parentNode !== undefined && parentNode.type === 'JsdocTypeGeneric' && property === 'left';\n\n        const brackets = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (\n          parentNode\n        )?.meta?.brackets;\n        const dot = /** @type {import('jsdoc-type-pratt-parser').GenericResult} */ (\n          parentNode\n        )?.meta?.dot;\n\n        if (brackets === 'angle') {\n          const checkPostFixes = dot ? [\n            '.', '.<>',\n          ] : [\n            '<>',\n          ];\n          isGenericMatch = checkPostFixes.some((checkPostFix) => {\n            const preferredType = preferredTypes?.[typeNodeName + checkPostFix];\n\n            // Does `unifyParentAndChildTypeChecks` need to be checked here?\n            if (\n              (unifyParentAndChildTypeChecks || isNameOfGeneric ||\n                /* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */\n                (typeof preferredType === 'object' &&\n                  preferredType?.unifyParentAndChildTypeChecks)\n              ) &&\n              preferredType !== undefined\n            ) {\n              typName += checkPostFix;\n\n              return true;\n            }\n\n            return false;\n          });\n        }\n\n        if (\n          !isGenericMatch && property &&\n          /** @type {import('jsdoc-type-pratt-parser').NonRootResult} */ (\n            parentNode\n          ).type === 'JsdocTypeGeneric'\n        ) {\n          const checkPostFixes = dot ? [\n            '.', '.<>',\n          ] : [\n            brackets === 'angle' ? '<>' : '[]',\n          ];\n\n          isGenericMatch = checkPostFixes.some((checkPostFix) => {\n            const preferredType = preferredTypes?.[checkPostFix];\n            if (\n              // Does `unifyParentAndChildTypeChecks` need to be checked here?\n              (unifyParentAndChildTypeChecks || isNameOfGeneric ||\n                /* c8 ignore next 2 -- If checking `unifyParentAndChildTypeChecks` */\n                (typeof preferredType === 'object' &&\n                preferredType?.unifyParentAndChildTypeChecks)) &&\n                preferredType !== undefined\n            ) {\n              typName = checkPostFix;\n\n              return true;\n            }\n\n            return false;\n          });\n        }\n\n        const prefType = preferredTypes?.[typeNodeName];\n        const directNameMatch = prefType !== undefined &&\n          !Object.values(preferredTypes).includes(typeNodeName);\n        const specificUnify = typeof prefType === 'object' &&\n          prefType?.unifyParentAndChildTypeChecks;\n        const unifiedSyntaxParentMatch = property && directNameMatch && (unifyParentAndChildTypeChecks || specificUnify);\n        isGenericMatch = isGenericMatch || Boolean(unifiedSyntaxParentMatch);\n\n        hasMatchingPreferredType = isGenericMatch ||\n          directNameMatch && !property;\n\n        return [\n          hasMatchingPreferredType, typName, isGenericMatch,\n        ];\n      };\n\n      /**\n       * Collect invalid type info.\n       * @param {string} type\n       * @param {string} value\n       * @param {string} tagName\n       * @param {string} nameInTag\n       * @param {number} idx\n       * @param {string|undefined} property\n       * @param {import('jsdoc-type-pratt-parser').NonRootResult} node\n       * @param {import('jsdoc-type-pratt-parser').NonRootResult|undefined} parentNode\n       * @param {(string|false|undefined)[][]} invalidTypes\n       * @returns {void}\n       */\n      const getInvalidTypes = (type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes) => {\n        let typeNodeName = type === 'JsdocTypeAny' ? '*' : value;\n\n        const [\n          hasMatchingPreferredType,\n          typName,\n          isGenericMatch,\n        ] = getPreferredTypeInfo(type, typeNodeName, parentNode, property);\n\n        let preferred;\n        let types;\n        if (hasMatchingPreferredType) {\n          const preferredSetting = preferredTypes[typName];\n          typeNodeName = typName === '[]' ? typName : typeNodeName;\n\n          if (!preferredSetting) {\n            invalidTypes.push([\n              typeNodeName,\n            ]);\n          } else if (typeof preferredSetting === 'string') {\n            preferred = preferredSetting;\n            invalidTypes.push([\n              typeNodeName, preferred,\n            ]);\n          } else if (preferredSetting && typeof preferredSetting === 'object') {\n            const nextItem = preferredSetting.skipRootChecking && jsdocTagsWithPossibleType[idx + 1];\n\n            if (!nextItem || !nextItem.name.startsWith(`${nameInTag}.`)) {\n              preferred = preferredSetting.replacement;\n              invalidTypes.push([\n                typeNodeName,\n                preferred,\n                preferredSetting.message,\n              ]);\n            }\n          } else {\n            utils.reportSettings(\n              'Invalid `settings.jsdoc.preferredTypes`. Values must be falsy, a string, or an object.',\n            );\n\n            return;\n          }\n        } else if (Object.entries(structuredTags).some(([\n          tag,\n          {\n            type: typs,\n          },\n        ]) => {\n          types = typs;\n\n          return tag === tagName &&\n            Array.isArray(types) &&\n            !types.includes(typeNodeName);\n        })) {\n          invalidTypes.push([\n            typeNodeName, types,\n          ]);\n        } else if (checkNativeTypes && !noDefaults && type === 'JsdocTypeName') {\n          preferred = checkNativeTypes(\n            preferredTypes, typeNodeName, preferred, parentNode, invalidTypes,\n          );\n        }\n\n        // For fixer\n        if (preferred) {\n          adjustNames(type, preferred, isGenericMatch, typeNodeName, node, parentNode);\n        }\n      };\n\n      for (const [\n        idx,\n        jsdocTag,\n      ] of jsdocTagsWithPossibleType.entries()) {\n        /** @type {(string|false|undefined)[][]} */\n        const invalidTypes = [];\n        let typeAst;\n\n        try {\n          typeAst = mode === 'permissive' ? tryParse(jsdocTag.type) : parse(jsdocTag.type, mode);\n        } catch {\n          continue;\n        }\n\n        const {\n          name: nameInTag,\n          tag: tagName,\n        } = jsdocTag;\n\n        traverse(typeAst, (node, parentNode, property) => {\n          const {\n            type,\n            value,\n          } =\n            /**\n             * @type {import('jsdoc-type-pratt-parser').NameResult}\n             */ (node);\n          if (![\n            'JsdocTypeAny', 'JsdocTypeName',\n          ].includes(type)) {\n            return;\n          }\n\n          getInvalidTypes(type, value, tagName, nameInTag, idx, property, node, parentNode, invalidTypes);\n        });\n\n        if (invalidTypes.length) {\n          const fixedType = stringify(typeAst);\n\n          /**\n           * @type {import('eslint').Rule.ReportFixer}\n           */\n          const fix = (fixer) => {\n            return fixer.replaceText(\n              jsdocNode,\n              sourceCode.getText(jsdocNode).replace(\n                `{${jsdocTag.type}}`,\n                `{${fixedType}}`,\n              ),\n            );\n          };\n\n          for (const [\n            badType,\n            preferredType = '',\n            msg,\n          ] of invalidTypes) {\n            const tagValue = jsdocTag.name ? ` \"${jsdocTag.name}\"` : '';\n            if (exemptTagContexts.some(({\n              tag,\n              types,\n            }) => {\n              return tag === tagName &&\n                (types === true || types.includes(jsdocTag.type));\n            })) {\n              continue;\n            }\n\n            report(\n              msg ||\n                `Invalid JSDoc @${tagName}${tagValue} type \"${badType}\"` +\n                (preferredType ? '; ' : '.') +\n                (preferredType ? `prefer: ${JSON.stringify(preferredType)}.` : ''),\n              preferredType ? fix : null,\n              jsdocTag,\n              msg ? {\n                tagName,\n                tagValue,\n              } : undefined,\n            );\n          }\n        }\n      }\n    },\n    {\n      iterateAllJsdocs: true,\n      meta: {\n        docs: {\n          description,\n          url,\n        },\n        ...(!overrideSettings || (Object.values(overrideSettings).some((os) => {\n          return os && typeof os === 'object' ?\n            /* c8 ignore next -- Ok */\n            os.replacement :\n            typeof os === 'string';\n        })) ?\n          {\n            fixable: 'code',\n          } :\n          {}\n        ),\n        schema,\n        type: 'suggestion',\n      },\n    },\n  );\n};\n"],"mappings":";;;;;;AAAA;AACA;AAK8B;AAE9B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,WAAW,GAAG,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,KAAK;EACvF,IAAI,GAAG,GAAG,SAAS;EACnB,IAAI,cAAc,EAAE;IAClB,MAAM,UAAU,GAAG,8DACjB,UAAU,CACV,IAAI;IACN,IAAI,SAAS,KAAK,IAAI,EAAE;MACtB,UAAU,CAAC,QAAQ,GAAG,QAAQ;MAC9B,UAAU,CAAC,GAAG,GAAG,KAAK;MACtB,GAAG,GAAG,OAAO;IACf,CAAC,MAAM;MACL,MAAM,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC,aAAa,CAAC;MACpD,IAAI,aAAa,EAAE;QACjB,UAAU,CAAC,QAAQ,GAAG,OAAO;QAC7B,UAAU,CAAC,GAAG,GAAG,IAAI;QACrB,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;MACpD,CAAC,MAAM;QACL,MAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC;QAC3C,IAAI,UAAU,EAAE;UACd,UAAU,CAAC,QAAQ,GAAG,OAAO;UAC7B,UAAU,CAAC,GAAG,GAAG,KAAK;UACtB,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;QAC9B,CAAC,MAAM,IACL,UAAU,EAAE,QAAQ,KAAK,QAAQ,KAChC,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,OAAO,CAAC,EACnD;UACA,UAAU,CAAC,QAAQ,GAAG,OAAO;UAC7B,UAAU,CAAC,GAAG,GAAG,KAAK;QACxB;MACF;IACF;EACF,CAAC,MAAM,IAAI,IAAI,KAAK,cAAc,EAAE;IAClC,IAAI,CAAC,IAAI,GAAG,eAAe;EAC7B;;EAEA;EACE,IAAI,CACJ,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC;;EAElD;EACA,IAAI,CAAC,GAAG,EAAE;IACR,2DACE,IAAI,CACJ,KAAK,GAAG,YAAY;EACxB;AACF,CAAC;;AAED;AACA;AACA;AACA;AACA,MAAM,UAAU,GAAI,SAAS,IAAK;EAChC,OAAO,sDAAsD,GAC7D,GAAG,IAAI,SAAS,GAAG,GAAG,GAAG,GAAG,CAAC,GAAG,yCAAyC;AAC3E,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,IAAI,GAAG;EACX,OAAO,EAAE,UAAU,CAAC,CAAC;EACrB,WAAW,EAAE;AACf,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA,MAAM,MAAM,GAAG;EACb,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;EACzB,WAAW,EAAE;AACf,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAM,iCAAiC,GAAG,CAAC;EAChD,gBAAgB,GAAG,IAAI;EACvB,QAAQ;EACR,WAAW,GAAG,QAAQ,IAAI,iHAAiH;EAC3I,gBAAgB,GAAG,IAAI;EACvB,MAAM,GAAG,EAAE;EACX,GAAG,GAAG;AACR,CAAC,KAAK;EACJ,OAAO,IAAAA,qBAAY,EACjB,CAAC;IACC,OAAO;IACP,SAAS;IACT,MAAM;IACN,QAAQ;IACR,UAAU;IACV;EACF,CAAC,KAAK;IACJ,MAAM,yBAAyB,GAAG,KAAK,CAAC,UAAU,CAAE,GAAG,IAAK;MAC1D,OAAO,OAAO,CAAC,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzD,CAAC,CAAC;IAEF;IACE;AACR;AACA;AACA;AACA;AACA;AACA;IACQ;MACE,IAAI;MACJ,cAAc,EAAE,sBAAsB;MACtC;IACF,CAAC,GAAG,gBAAgB,GAAG;MACrB,IAAI,EAAE,QAAQ,CAAC,IAAI;MACnB,cAAc,EAAE,gBAAgB;MAChC,cAAc,EAAE,CAAC;IACnB,CAAC,GAAG,QAAQ;IAEd,MAAM,0BAA0B,GAAG,CAAC,gBAAgB,IAClD,EAAE,QAAQ,IAAI,sBAAsB,IACpC,QAAQ,IAAI,sBAAsB,IAClC,WAAW,IAAI,sBAAsB,IACrC,WAAW,IAAI,sBAAsB,IACrC,UAAU,IAAI,sBAAsB,CAAC;;IAEvC;IACA,MAAM,YAAY,GAAG,IAAI,KAAK,YAAY,GACxC;MACE,MAAM,EAAE,QAAQ;MAChB,WAAW,EAAE,IAAI;MACjB,WAAW,EAAE,MAAM;MACnB,UAAU,EAAE,IAAI;MAChB,UAAU,EAAE;IACd,CAAC,GACD;MACE,MAAM,EAAE,QAAQ;MAChB,WAAW,EAAE,UAAU;MACvB,WAAW,EAAE,UAAU;MACvB,UAAU,EAAE;IACd,CAAC;;IAEH;IACA,MAAM,cAAc,GAAG;MACrB,IAAG,0BAA0B,GAC3B,YAAY,GACZ,CAAC,CAAC;MACJ,GAAG;IACL,CAAC;IAED;IACE;AACR;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IAAY;MACF,iBAAiB,GAAG,EAAE;MACtB,UAAU;MACV;IACF,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;;IAE9B;AACN;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACM,MAAM,oBAAoB,GAAG,CAAC,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,KAAK;MAC1E,IAAI,wBAAwB,GAAG,KAAK;MACpC,IAAI,cAAc,GAAG,KAAK;MAC1B,IAAI,OAAO,GAAG,YAAY;MAE1B,MAAM,eAAe,GAAG,UAAU,KAAK,SAAS,IAAI,UAAU,CAAC,IAAI,KAAK,kBAAkB,IAAI,QAAQ,KAAK,MAAM;MAEjH,MAAM,QAAQ,GAAG,8DACf,UAAU,EACT,IAAI,EAAE,QAAQ;MACjB,MAAM,GAAG,GAAG,8DACV,UAAU,EACT,IAAI,EAAE,GAAG;MAEZ,IAAI,QAAQ,KAAK,OAAO,EAAE;QACxB,MAAM,cAAc,GAAG,GAAG,GAAG,CAC3B,GAAG,EAAE,KAAK,CACX,GAAG,CACF,IAAI,CACL;QACD,cAAc,GAAG,cAAc,CAAC,IAAI,CAAE,YAAY,IAAK;UACrD,MAAM,aAAa,GAAG,cAAc,GAAG,YAAY,GAAG,YAAY,CAAC;;UAEnE;UACA,IACE,CAAC,6BAA6B,IAAI,eAAe,KAC/C;UACC,OAAO,aAAa,KAAK,QAAQ,IAChC,aAAa,EAAE,6BAA6B,CAAC,KAEjD,aAAa,KAAK,SAAS,EAC3B;YACA,OAAO,IAAI,YAAY;YAEvB,OAAO,IAAI;UACb;UAEA,OAAO,KAAK;QACd,CAAC,CAAC;MACJ;MAEA,IACE,CAAC,cAAc,IAAI,QAAQ,IAC3B,8DACE,UAAU,CACV,IAAI,KAAK,kBAAkB,EAC7B;QACA,MAAM,cAAc,GAAG,GAAG,GAAG,CAC3B,GAAG,EAAE,KAAK,CACX,GAAG,CACF,QAAQ,KAAK,OAAO,GAAG,IAAI,GAAG,IAAI,CACnC;QAED,cAAc,GAAG,cAAc,CAAC,IAAI,CAAE,YAAY,IAAK;UACrD,MAAM,aAAa,GAAG,cAAc,GAAG,YAAY,CAAC;UACpD;UACE;UACA,CAAC,6BAA6B,IAAI,eAAe,KAC/C;UACC,OAAO,aAAa,KAAK,QAAQ,IAClC,aAAa,EAAE,6BAA6B,CAAC,KAC7C,aAAa,KAAK,SAAS,EAC7B;YACA,OAAO,GAAG,YAAY;YAEtB,OAAO,IAAI;UACb;UAEA,OAAO,KAAK;QACd,CAAC,CAAC;MACJ;MAEA,MAAM,QAAQ,GAAG,cAAc,GAAG,YAAY,CAAC;MAC/C,MAAM,eAAe,GAAG,QAAQ,KAAK,SAAS,IAC5C,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;MACvD,MAAM,aAAa,GAAG,OAAO,QAAQ,KAAK,QAAQ,IAChD,QAAQ,EAAE,6BAA6B;MACzC,MAAM,wBAAwB,GAAG,QAAQ,IAAI,eAAe,KAAK,6BAA6B,IAAI,aAAa,CAAC;MAChH,cAAc,GAAG,cAAc,IAAI,OAAO,CAAC,wBAAwB,CAAC;MAEpE,wBAAwB,GAAG,cAAc,IACvC,eAAe,IAAI,CAAC,QAAQ;MAE9B,OAAO,CACL,wBAAwB,EAAE,OAAO,EAAE,cAAc,CAClD;IACH,CAAC;;IAED;AACN;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;IACM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,KAAK;MAC1G,IAAI,YAAY,GAAG,IAAI,KAAK,cAAc,GAAG,GAAG,GAAG,KAAK;MAExD,MAAM,CACJ,wBAAwB,EACxB,OAAO,EACP,cAAc,CACf,GAAG,oBAAoB,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,QAAQ,CAAC;MAElE,IAAI,SAAS;MACb,IAAI,KAAK;MACT,IAAI,wBAAwB,EAAE;QAC5B,MAAM,gBAAgB,GAAG,cAAc,CAAC,OAAO,CAAC;QAChD,YAAY,GAAG,OAAO,KAAK,IAAI,GAAG,OAAO,GAAG,YAAY;QAExD,IAAI,CAAC,gBAAgB,EAAE;UACrB,YAAY,CAAC,IAAI,CAAC,CAChB,YAAY,CACb,CAAC;QACJ,CAAC,MAAM,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;UAC/C,SAAS,GAAG,gBAAgB;UAC5B,YAAY,CAAC,IAAI,CAAC,CAChB,YAAY,EAAE,SAAS,CACxB,CAAC;QACJ,CAAC,MAAM,IAAI,gBAAgB,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;UACnE,MAAM,QAAQ,GAAG,gBAAgB,CAAC,gBAAgB,IAAI,yBAAyB,CAAC,GAAG,GAAG,CAAC,CAAC;UAExF,IAAI,CAAC,QAAQ,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,SAAS,GAAG,CAAC,EAAE;YAC3D,SAAS,GAAG,gBAAgB,CAAC,WAAW;YACxC,YAAY,CAAC,IAAI,CAAC,CAChB,YAAY,EACZ,SAAS,EACT,gBAAgB,CAAC,OAAO,CACzB,CAAC;UACJ;QACF,CAAC,MAAM;UACL,KAAK,CAAC,cAAc,CAClB,wFACF,CAAC;UAED;QACF;MACF,CAAC,MAAM,IAAI,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAC9C,GAAG,EACH;QACE,IAAI,EAAE;MACR,CAAC,CACF,KAAK;QACJ,KAAK,GAAG,IAAI;QAEZ,OAAO,GAAG,KAAK,OAAO,IACpB,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IACpB,CAAC,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC;MACjC,CAAC,CAAC,EAAE;QACF,YAAY,CAAC,IAAI,CAAC,CAChB,YAAY,EAAE,KAAK,CACpB,CAAC;MACJ,CAAC,MAAM,IAAI,gBAAgB,IAAI,CAAC,UAAU,IAAI,IAAI,KAAK,eAAe,EAAE;QACtE,SAAS,GAAG,gBAAgB,CAC1B,cAAc,EAAE,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,YACvD,CAAC;MACH;;MAEA;MACA,IAAI,SAAS,EAAE;QACb,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,cAAc,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC;MAC9E;IACF,CAAC;IAED,KAAK,MAAM,CACT,GAAG,EACH,QAAQ,CACT,IAAI,yBAAyB,CAAC,OAAO,CAAC,CAAC,EAAE;MACxC;MACA,MAAM,YAAY,GAAG,EAAE;MACvB,IAAI,OAAO;MAEX,IAAI;QACF,OAAO,GAAG,IAAI,KAAK,YAAY,GAAG,IAAAC,cAAA,QAAQ,EAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAAC,cAAA,KAAK,EAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;MACxF,CAAC,CAAC,MAAM;QACN;MACF;MAEA,MAAM;QACJ,IAAI,EAAE,SAAS;QACf,GAAG,EAAE;MACP,CAAC,GAAG,QAAQ;MAEZ,IAAAC,cAAA,QAAQ,EAAC,OAAO,EAAE,CAAC,IAAI,EAAE,UAAU,EAAE,QAAQ,KAAK;QAChD,MAAM;UACJ,IAAI;UACJ;QACF,CAAC;QACC;AACZ;AACA;QAAiB,IAAK;QACZ,IAAI,CAAC,CACH,cAAc,EAAE,eAAe,CAChC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;UAChB;QACF;QAEA,eAAe,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,CAAC;MACjG,CAAC,CAAC;MAEF,IAAI,YAAY,CAAC,MAAM,EAAE;QACvB,MAAM,SAAS,GAAG,IAAAC,cAAA,SAAS,EAAC,OAAO,CAAC;;QAEpC;AACV;AACA;QACU,MAAM,GAAG,GAAI,KAAK,IAAK;UACrB,OAAO,KAAK,CAAC,WAAW,CACtB,SAAS,EACT,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAO,CACnC,IAAI,QAAQ,CAAC,IAAI,GAAG,EACpB,IAAI,SAAS,GACf,CACF,CAAC;QACH,CAAC;QAED,KAAK,MAAM,CACT,OAAO,EACP,aAAa,GAAG,EAAE,EAClB,GAAG,CACJ,IAAI,YAAY,EAAE;UACjB,MAAM,QAAQ,GAAG,QAAQ,CAAC,IAAI,GAAG,KAAK,QAAQ,CAAC,IAAI,GAAG,GAAG,EAAE;UAC3D,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAC;YAC1B,GAAG;YACH;UACF,CAAC,KAAK;YACJ,OAAO,GAAG,KAAK,OAAO,KACnB,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;UACrD,CAAC,CAAC,EAAE;YACF;UACF;UAEA,MAAM,CACJ,GAAG,IACD,kBAAkB,OAAO,GAAG,QAAQ,UAAU,OAAO,GAAG,IACvD,aAAa,GAAG,IAAI,GAAG,GAAG,CAAC,IAC3B,aAAa,GAAG,WAAW,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,GAAG,GAAG,EAAE,CAAC,EACpE,aAAa,GAAG,GAAG,GAAG,IAAI,EAC1B,QAAQ,EACR,GAAG,GAAG;YACJ,OAAO;YACP;UACF,CAAC,GAAG,SACN,CAAC;QACH;MACF;IACF;EACF,CAAC,EACD;IACE,gBAAgB,EAAE,IAAI;IACtB,IAAI,EAAE;MACJ,IAAI,EAAE;QACJ,WAAW;QACX;MACF,CAAC;MACD,IAAI,CAAC,gBAAgB,IAAK,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAE,EAAE,IAAK;QACrE,OAAO,EAAE,IAAI,OAAO,EAAE,KAAK,QAAQ,GACjC;QACA,EAAE,CAAC,WAAW,GACd,OAAO,EAAE,KAAK,QAAQ;MAC1B,CAAC,CAAE,GACD;QACE,OAAO,EAAE;MACX,CAAC,GACD,CAAC,CAAC,CACH;MACD,MAAM;MACN,IAAI,EAAE;IACR;EACF,CACF,CAAC;AACH,CAAC;AAAC","ignoreList":[]}

package/dist/cjs/WarnSettings.d.ts

@@ -1,16 +0,0 @@
-export default WarnSettings;
-declare function WarnSettings(): {
-    /**
-     * Warn only once for each context and setting
-     * @param {import('eslint').Rule.RuleContext} context
-     * @param {string} setting
-     * @returns {boolean}
-     */
-    hasBeenWarned(context: import("eslint").Rule.RuleContext, setting: string): boolean;
-    /**
-     * @param {import('eslint').Rule.RuleContext} context
-     * @param {string} setting
-     * @returns {void}
-     */
-    markSettingAsWarned(context: import("eslint").Rule.RuleContext, setting: string): void;
-};

package/dist/cjs/alignTransform.d.ts

@@ -1,33 +0,0 @@
-export default alignTransform;
-export type TypelessInfo = {
-    hasNoTypes: boolean;
-    maxNamedTagLength: import("./iterateJsdoc.js").Integer;
-    maxUnnamedTagLength: import("./iterateJsdoc.js").Integer;
-};
-export type Width = {
-    name: import("./iterateJsdoc.js").Integer;
-    start: import("./iterateJsdoc.js").Integer;
-    tag: import("./iterateJsdoc.js").Integer;
-    type: import("./iterateJsdoc.js").Integer;
-};
-/**
- * @param {{
- *   customSpacings: import('../src/rules/checkLineAlignment.js').CustomSpacings,
- *   tags: string[],
- *   indent: string,
- *   preserveMainDescriptionPostDelimiter: boolean,
- *   wrapIndent: string,
- *   disableWrapIndent: boolean,
- * }} cfg
- * @returns {(
- *   block: import('comment-parser').Block
- * ) => import('comment-parser').Block}
- */
-declare function alignTransform({ customSpacings, disableWrapIndent, indent, preserveMainDescriptionPostDelimiter, tags, wrapIndent, }: {
-    customSpacings: import("../src/rules/checkLineAlignment.js").CustomSpacings;
-    tags: string[];
-    indent: string;
-    preserveMainDescriptionPostDelimiter: boolean;
-    wrapIndent: string;
-    disableWrapIndent: boolean;
-}): (block: import("comment-parser").Block) => import("comment-parser").Block;

package/dist/cjs/buildForbidRuleDefinition.d.ts

@@ -1,14 +0,0 @@
-export function buildForbidRuleDefinition({ contextName, contexts: cntxts, description, getContexts, modifyContext, schema, url, }: {
-    contexts?: Contexts;
-    description?: string;
-    getContexts?: (ctxt: import("eslint").Rule.RuleContext, report: import("./iterateJsdoc.js").Report) => Contexts | false;
-    contextName?: string;
-    modifyContext?: (context: import("eslint").Rule.RuleContext) => import("eslint").Rule.RuleContext;
-    schema?: import("eslint").Rule.RuleMetaData["schema"];
-    url?: string;
-}): import("eslint").Rule.RuleModule;
-export type Contexts = (string | {
-    comment: string;
-    context: string;
-    message?: string;
-})[];

package/dist/cjs/buildRejectOrPreferRuleDefinition.d.ts

@@ -1,8 +0,0 @@
-export function buildRejectOrPreferRuleDefinition({ checkNativeTypes, typeName, description, overrideSettings, schema, url, }: {
-    checkNativeTypes?: import("./rules/checkTypes.js").CheckNativeTypes | null;
-    overrideSettings?: import("./iterateJsdoc.js").Settings["preferredTypes"] | null;
-    description?: string;
-    schema?: import("eslint").Rule.RuleMetaData["schema"];
-    typeName?: string;
-    url?: string;
-}): import("eslint").Rule.RuleModule;

package/dist/cjs/defaultTagOrder.d.ts

@@ -1,4 +0,0 @@
-export default defaultTagOrder;
-declare const defaultTagOrder: {
-    tags: string[];
-}[];

package/dist/cjs/exportParser.d.ts

@@ -1,40 +0,0 @@
-declare namespace _default {
-    export { isUncommentedExport };
-    export { parse };
-}
-export default _default;
-export type ValueObject = {
-    value: string;
-};
-export type CreatedNode = {
-    type?: string;
-    value?: ValueObject | import("eslint").Rule.Node | import("@typescript-eslint/types").TSESTree.Node;
-    props: {
-        [key: string]: CreatedNode | null;
-    };
-    special?: true;
-    globalVars?: CreatedNode;
-    exported?: boolean;
-    ANONYMOUS_DEFAULT?: import("eslint").Rule.Node;
-};
-export type CreateSymbol = (node: import("eslint").Rule.Node | null, globals: CreatedNode, value: import("eslint").Rule.Node | import("@typescript-eslint/types").TSESTree.Node | null, scope?: CreatedNode | undefined, isGlobal?: boolean | SymbolOptions | undefined) => CreatedNode | null;
-export type SymbolOptions = {
-    simpleIdentifier?: boolean;
-};
-/**
- *
- * @param {import('eslint').Rule.Node} node
- * @param {import('eslint').SourceCode} sourceCode
- * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
- * @param {import('./iterateJsdoc.js').Settings} settings
- * @returns {boolean}
- */
-declare function isUncommentedExport(node: import("eslint").Rule.Node, sourceCode: import("eslint").SourceCode, opt: import("./rules/requireJsdoc.js").RequireJsdocOpts, settings: import("./iterateJsdoc.js").Settings): boolean;
-/**
- *
- * @param {import('eslint').Rule.Node} ast
- * @param {import('eslint').Rule.Node} node
- * @param {import('./rules/requireJsdoc.js').RequireJsdocOpts} opt
- * @returns {CreatedNode}
- */
-declare function parse(ast: import("eslint").Rule.Node, node: import("eslint").Rule.Node, opt: import("./rules/requireJsdoc.js").RequireJsdocOpts): CreatedNode;

package/dist/cjs/getDefaultTagStructureForMode.d.ts

@@ -1,10 +0,0 @@
-export default getDefaultTagStructureForMode;
-export type TagStructure = Map<string, Map<string, (string | boolean)>>;
-/**
- * @typedef {Map<string, Map<string, (string|boolean)>>} TagStructure
- */
-/**
- * @param {import('./jsdocUtils.js').ParserMode} mode
- * @returns {TagStructure}
- */
-declare function getDefaultTagStructureForMode(mode: import("./jsdocUtils.js").ParserMode): TagStructure;

package/dist/cjs/getJsdocProcessorPlugin.d.cts

@@ -1,5 +0,0 @@
-import { getJsdocProcessorPlugin } from './getJsdocProcessorPlugin.js';
-declare const _default: {
-    getJsdocProcessorPlugin: typeof getJsdocProcessorPlugin;
-};
-export = _default;