eslint-plugin-jsdoc 52.0.4 → 53.0.0

package/dist/rules/checkPropertyNames.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"checkPropertyNames.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","validatePropertyNames","targetTagName","enableFixer","jsdoc","utils","propertyTags","Object","entries","tags","filter","tag","some","index","tagsIndex","dupeTagInfo","find","tgsIndex","tg","idx","Number","name","reportJSDoc","removeTag","validatePropertyNamesDeep","jsdocPropertyNames","report","lastRealProperty","jsdocPropertyName","isPropertyPath","includes","pathRootNodeName","slice","indexOf","endsWith","_default","exports","iterateJsdoc","context","options","jsdocPropertyNamesDeep","getJsdocTagsDeep","length","getPreferredTagName","tagName","isError","iterateAllJsdocs","meta","docs","description","url","fixable","schema","additionalProperties","properties","type","module"],"sources":["../../src/rules/checkPropertyNames.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} targetTagName\n * @param {boolean} enableFixer\n * @param {import('comment-parser').Block} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @returns {boolean}\n */\nconst validatePropertyNames = (\n  targetTagName,\n  enableFixer,\n  jsdoc, utils,\n) => {\n  const propertyTags = Object.entries(jsdoc.tags).filter(([\n    , tag,\n  ]) => {\n    return tag.tag === targetTagName;\n  });\n\n  return propertyTags.some(([\n    , tag,\n  ], index) => {\n    /** @type {import('../iterateJsdoc.js').Integer} */\n    let tagsIndex;\n    const dupeTagInfo = propertyTags.find(([\n      tgsIndex,\n      tg,\n    ], idx) => {\n      tagsIndex = Number(tgsIndex);\n\n      return tg.name === tag.name && idx !== index;\n    });\n    if (dupeTagInfo) {\n      utils.reportJSDoc(`Duplicate @${targetTagName} \"${tag.name}\"`, dupeTagInfo[1], enableFixer ? () => {\n        utils.removeTag(tagsIndex);\n      } : null);\n\n      return true;\n    }\n\n    return false;\n  });\n};\n\n/**\n * @param {string} targetTagName\n * @param {{\n *   idx: number;\n *   name: string;\n *   type: string;\n * }[]} jsdocPropertyNames\n * @param {import('comment-parser').Block} jsdoc\n * @param {Function} report\n */\nconst validatePropertyNamesDeep = (\n  targetTagName,\n  jsdocPropertyNames, jsdoc, report,\n) => {\n  /** @type {string} */\n  let lastRealProperty;\n\n  return jsdocPropertyNames.some(({\n    idx,\n    name: jsdocPropertyName,\n  }) => {\n    const isPropertyPath = jsdocPropertyName.includes('.');\n\n    if (isPropertyPath) {\n      if (!lastRealProperty) {\n        report(`@${targetTagName} path declaration (\"${jsdocPropertyName}\") appears before any real property.`, null, jsdoc.tags[idx]);\n\n        return true;\n      }\n\n      let pathRootNodeName = jsdocPropertyName.slice(0, jsdocPropertyName.indexOf('.'));\n\n      if (pathRootNodeName.endsWith('[]')) {\n        pathRootNodeName = pathRootNodeName.slice(0, -2);\n      }\n\n      if (pathRootNodeName !== lastRealProperty) {\n        report(\n          `@${targetTagName} path declaration (\"${jsdocPropertyName}\") root node name (\"${pathRootNodeName}\") ` +\n          `does not match previous real property name (\"${lastRealProperty}\").`,\n          null,\n          jsdoc.tags[idx],\n        );\n\n        return true;\n      }\n    } else {\n      lastRealProperty = jsdocPropertyName;\n    }\n\n    return false;\n  });\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  const {\n    enableFixer = false,\n  } = context.options[0] || {};\n  const jsdocPropertyNamesDeep = utils.getJsdocTagsDeep('property');\n  if (!jsdocPropertyNamesDeep || !jsdocPropertyNamesDeep.length) {\n    return;\n  }\n\n  const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'property',\n  }));\n  const isError = validatePropertyNames(\n    targetTagName,\n    enableFixer,\n    jsdoc,\n    utils,\n  );\n\n  if (isError) {\n    return;\n  }\n\n  validatePropertyNamesDeep(\n    targetTagName, jsdocPropertyNamesDeep, jsdoc, report,\n  );\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          enableFixer: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAE9C;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMG,qBAAqB,GAAGA,CAC5BC,aAAa,EACbC,WAAW,EACXC,KAAK,EAAEC,KAAK,KACT;EACH,MAAMC,YAAY,GAAGC,MAAM,CAACC,OAAO,CAACJ,KAAK,CAACK,IAAI,CAAC,CAACC,MAAM,CAAC,CAAC,GACpDC,GAAG,CACN,KAAK;IACJ,OAAOA,GAAG,CAACA,GAAG,KAAKT,aAAa;EAClC,CAAC,CAAC;EAEF,OAAOI,YAAY,CAACM,IAAI,CAAC,CAAC,GACtBD,GAAG,CACN,EAAEE,KAAK,KAAK;IACX;IACA,IAAIC,SAAS;IACb,MAAMC,WAAW,GAAGT,YAAY,CAACU,IAAI,CAAC,CAAC,CACrCC,QAAQ,EACRC,EAAE,CACH,EAAEC,GAAG,KAAK;MACTL,SAAS,GAAGM,MAAM,CAACH,QAAQ,CAAC;MAE5B,OAAOC,EAAE,CAACG,IAAI,KAAKV,GAAG,CAACU,IAAI,IAAIF,GAAG,KAAKN,KAAK;IAC9C,CAAC,CAAC;IACF,IAAIE,WAAW,EAAE;MACfV,KAAK,CAACiB,WAAW,CAAC,cAAcpB,aAAa,KAAKS,GAAG,CAACU,IAAI,GAAG,EAAEN,WAAW,CAAC,CAAC,CAAC,EAAEZ,WAAW,GAAG,MAAM;QACjGE,KAAK,CAACkB,SAAS,CAACT,SAAS,CAAC;MAC5B,CAAC,GAAG,IAAI,CAAC;MAET,OAAO,IAAI;IACb;IAEA,OAAO,KAAK;EACd,CAAC,CAAC;AACJ,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMU,yBAAyB,GAAGA,CAChCtB,aAAa,EACbuB,kBAAkB,EAAErB,KAAK,EAAEsB,MAAM,KAC9B;EACH;EACA,IAAIC,gBAAgB;EAEpB,OAAOF,kBAAkB,CAACb,IAAI,CAAC,CAAC;IAC9BO,GAAG;IACHE,IAAI,EAAEO;EACR,CAAC,KAAK;IACJ,MAAMC,cAAc,GAAGD,iBAAiB,CAACE,QAAQ,CAAC,GAAG,CAAC;IAEtD,IAAID,cAAc,EAAE;MAClB,IAAI,CAACF,gBAAgB,EAAE;QACrBD,MAAM,CAAC,IAAIxB,aAAa,uBAAuB0B,iBAAiB,sCAAsC,EAAE,IAAI,EAAExB,KAAK,CAACK,IAAI,CAACU,GAAG,CAAC,CAAC;QAE9H,OAAO,IAAI;MACb;MAEA,IAAIY,gBAAgB,GAAGH,iBAAiB,CAACI,KAAK,CAAC,CAAC,EAAEJ,iBAAiB,CAACK,OAAO,CAAC,GAAG,CAAC,CAAC;MAEjF,IAAIF,gBAAgB,CAACG,QAAQ,CAAC,IAAI,CAAC,EAAE;QACnCH,gBAAgB,GAAGA,gBAAgB,CAACC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;MAClD;MAEA,IAAID,gBAAgB,KAAKJ,gBAAgB,EAAE;QACzCD,MAAM,CACJ,IAAIxB,aAAa,uBAAuB0B,iBAAiB,uBAAuBG,gBAAgB,KAAK,GACrG,gDAAgDJ,gBAAgB,KAAK,EACrE,IAAI,EACJvB,KAAK,CAACK,IAAI,CAACU,GAAG,CAChB,CAAC;QAED,OAAO,IAAI;MACb;IACF,CAAC,MAAM;MACLQ,gBAAgB,GAAGC,iBAAiB;IACtC;IAEA,OAAO,KAAK;EACd,CAAC,CAAC;AACJ,CAAC;AAAC,IAAAO,QAAA,GAAAC,OAAA,CAAApC,OAAA,GAEa,IAAAqC,qBAAY,EAAC,CAAC;EAC3BC,OAAO;EACPlC,KAAK;EACLsB,MAAM;EACNrB;AACF,CAAC,KAAK;EACJ,MAAM;IACJF,WAAW,GAAG;EAChB,CAAC,GAAGmC,OAAO,CAACC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;EAC5B,MAAMC,sBAAsB,GAAGnC,KAAK,CAACoC,gBAAgB,CAAC,UAAU,CAAC;EACjE,IAAI,CAACD,sBAAsB,IAAI,CAACA,sBAAsB,CAACE,MAAM,EAAE;IAC7D;EACF;EAEA,MAAMxC,aAAa,GAAG,qBAAuBG,KAAK,CAACsC,mBAAmB,CAAC;IACrEC,OAAO,EAAE;EACX,CAAC,CAAE;EACH,MAAMC,OAAO,GAAG5C,qBAAqB,CACnCC,aAAa,EACbC,WAAW,EACXC,KAAK,EACLC,KACF,CAAC;EAED,IAAIwC,OAAO,EAAE;IACX;EACF;EAEArB,yBAAyB,CACvBtB,aAAa,EAAEsC,sBAAsB,EAAEpC,KAAK,EAAEsB,MAChD,CAAC;AACH,CAAC,EAAE;EACDoB,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,0HAA0H;MACvIC,GAAG,EAAE;IACP,CAAC;IACDC,OAAO,EAAE,MAAM;IACfC,MAAM,EAAE,CACN;MACEC,oBAAoB,EAAE,KAAK;MAC3BC,UAAU,EAAE;QACVnD,WAAW,EAAE;UACXoD,IAAI,EAAE;QACR;MACF,CAAC;MACDA,IAAI,EAAE;IACR,CAAC,CACF;IACDA,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAC,MAAA,CAAApB,OAAA,GAAAA,OAAA,CAAApC,OAAA","ignoreList":[]}
+{"version":3,"file":"checkPropertyNames.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/checkPropertyNames.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} targetTagName\n * @param {boolean} enableFixer\n * @param {import('comment-parser').Block} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @returns {boolean}\n */\nconst validatePropertyNames = (\n  targetTagName,\n  enableFixer,\n  jsdoc, utils,\n) => {\n  const propertyTags = Object.entries(jsdoc.tags).filter(([\n    , tag,\n  ]) => {\n    return tag.tag === targetTagName;\n  });\n\n  return propertyTags.some(([\n    , tag,\n  ], index) => {\n    /** @type {import('../iterateJsdoc.js').Integer} */\n    let tagsIndex;\n    const dupeTagInfo = propertyTags.find(([\n      tgsIndex,\n      tg,\n    ], idx) => {\n      tagsIndex = Number(tgsIndex);\n\n      return tg.name === tag.name && idx !== index;\n    });\n    if (dupeTagInfo) {\n      utils.reportJSDoc(`Duplicate @${targetTagName} \"${tag.name}\"`, dupeTagInfo[1], enableFixer ? () => {\n        utils.removeTag(tagsIndex);\n      } : null);\n\n      return true;\n    }\n\n    return false;\n  });\n};\n\n/**\n * @param {string} targetTagName\n * @param {{\n *   idx: number;\n *   name: string;\n *   type: string;\n * }[]} jsdocPropertyNames\n * @param {import('comment-parser').Block} jsdoc\n * @param {Function} report\n */\nconst validatePropertyNamesDeep = (\n  targetTagName,\n  jsdocPropertyNames, jsdoc, report,\n) => {\n  /** @type {string} */\n  let lastRealProperty;\n\n  return jsdocPropertyNames.some(({\n    idx,\n    name: jsdocPropertyName,\n  }) => {\n    const isPropertyPath = jsdocPropertyName.includes('.');\n\n    if (isPropertyPath) {\n      if (!lastRealProperty) {\n        report(`@${targetTagName} path declaration (\"${jsdocPropertyName}\") appears before any real property.`, null, jsdoc.tags[idx]);\n\n        return true;\n      }\n\n      let pathRootNodeName = jsdocPropertyName.slice(0, jsdocPropertyName.indexOf('.'));\n\n      if (pathRootNodeName.endsWith('[]')) {\n        pathRootNodeName = pathRootNodeName.slice(0, -2);\n      }\n\n      if (pathRootNodeName !== lastRealProperty) {\n        report(\n          `@${targetTagName} path declaration (\"${jsdocPropertyName}\") root node name (\"${pathRootNodeName}\") ` +\n          `does not match previous real property name (\"${lastRealProperty}\").`,\n          null,\n          jsdoc.tags[idx],\n        );\n\n        return true;\n      }\n    } else {\n      lastRealProperty = jsdocPropertyName;\n    }\n\n    return false;\n  });\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  const {\n    enableFixer = false,\n  } = context.options[0] || {};\n  const jsdocPropertyNamesDeep = utils.getJsdocTagsDeep('property');\n  if (!jsdocPropertyNamesDeep || !jsdocPropertyNamesDeep.length) {\n    return;\n  }\n\n  const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'property',\n  }));\n  const isError = validatePropertyNames(\n    targetTagName,\n    enableFixer,\n    jsdoc,\n    utils,\n  );\n\n  if (isError) {\n    return;\n  }\n\n  validatePropertyNamesDeep(\n    targetTagName, jsdocPropertyNamesDeep, jsdoc, report,\n  );\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          enableFixer: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;AASA,MAAM,wBAAwB,CAC5B,eACA,aACA,OAAO,UACJ;CACH,MAAM,eAAe,OAAO,QAAQ,MAAM,KAAK,CAAC,OAAO,CAAC,GACpD,IACH,KAAK;AACJ,SAAO,IAAI,QAAQ;CACpB,EAAC;AAEF,QAAO,aAAa,KAAK,CAAC,GACtB,IACH,EAAE,UAAU;;EAEX,IAAI;EACJ,MAAM,cAAc,aAAa,KAAK,CAAC,CACrC,UACA,GACD,EAAE,QAAQ;GACT,YAAY,OAAO,SAAS;AAE5B,UAAO,GAAG,SAAS,IAAI,QAAQ,QAAQ;EACxC,EAAC;AACF,MAAI,aAAa;GACf,MAAM,YAAY,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE,IAAI,KAAK,CAAC,CAAC,EAAE,YAAY,IAAI,cAAc,MAAM;IACjG,MAAM,UAAU,UAAU;GAC3B,IAAG,KAAK;AAET,UAAO;EACR;AAED,SAAO;CACR,EAAC;AACH;;;;;;;;;;;AAYD,MAAM,4BAA4B,CAChC,eACA,oBAAoB,OAAO,WACxB;;CAEH,IAAI;AAEJ,QAAO,mBAAmB,KAAK,CAAC,EAC9B,KACA,MAAM,mBACP,KAAK;EACJ,MAAM,iBAAiB,kBAAkB,SAAS,IAAI;AAEtD,MAAI,gBAAgB;AAClB,OAAI,CAAC,kBAAkB;IACrB,OAAO,CAAC,CAAC,EAAE,cAAc,oBAAoB,EAAE,kBAAkB,oCAAoC,CAAC,EAAE,MAAM,MAAM,KAAK,KAAK;AAE9H,WAAO;GACR;GAED,IAAI,mBAAmB,kBAAkB,MAAM,GAAG,kBAAkB,QAAQ,IAAI,CAAC;AAEjF,OAAI,iBAAiB,SAAS,KAAK,EACjC,mBAAmB,iBAAiB,MAAM,GAAG,GAAG;AAGlD,OAAI,qBAAqB,kBAAkB;IACzC,OACE,CAAC,CAAC,EAAE,cAAc,oBAAoB,EAAE,kBAAkB,oBAAoB,EAAE,iBAAiB,gDAAG,EACpD,iBAAiB,GAAG,CAAC,EACrE,MACA,MAAM,KAAK,KACZ;AAED,WAAO;GACR;EACF,OACC,mBAAmB;AAGrB,SAAO;CACR,EAAC;AACH;AAED,iCAAeA,6BAAa,CAAC,EAC3B,SACA,OACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,cAAc,OACf,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,yBAAyB,MAAM,iBAAiB,WAAW;AACjE,KAAI,CAAC,0BAA0B,CAAC,uBAAuB,OACrD;CAGF,MAAM,gBAAuC,MAAM,oBAAoB,EACrE,SAAS,WACV,EAAC;CACF,MAAM,UAAU,sBACd,eACA,aACA,OACA,MACD;AAED,KAAI,QACF;CAGF,0BACE,eAAe,wBAAwB,OAAO,OAC/C;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,aAAa,EACX,MAAM,UACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkPropertyNames.js

@@ -0,0 +1,88 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/checkPropertyNames.js
+/**
+* @param {string} targetTagName
+* @param {boolean} enableFixer
+* @param {import('comment-parser').Block} jsdoc
+* @param {import('../iterateJsdoc.js').Utils} utils
+* @returns {boolean}
+*/
+const validatePropertyNames = (targetTagName, enableFixer, jsdoc, utils) => {
+	const propertyTags = Object.entries(jsdoc.tags).filter(([, tag]) => {
+		return tag.tag === targetTagName;
+	});
+	return propertyTags.some(([, tag], index) => {
+		/** @type {import('../iterateJsdoc.js').Integer} */
+		let tagsIndex;
+		const dupeTagInfo = propertyTags.find(([tgsIndex, tg], idx) => {
+			tagsIndex = Number(tgsIndex);
+			return tg.name === tag.name && idx !== index;
+		});
+		if (dupeTagInfo) {
+			utils.reportJSDoc(`Duplicate @${targetTagName} "${tag.name}"`, dupeTagInfo[1], enableFixer ? () => {
+				utils.removeTag(tagsIndex);
+			} : null);
+			return true;
+		}
+		return false;
+	});
+};
+/**
+* @param {string} targetTagName
+* @param {{
+*   idx: number;
+*   name: string;
+*   type: string;
+* }[]} jsdocPropertyNames
+* @param {import('comment-parser').Block} jsdoc
+* @param {Function} report
+*/
+const validatePropertyNamesDeep = (targetTagName, jsdocPropertyNames, jsdoc, report) => {
+	/** @type {string} */
+	let lastRealProperty;
+	return jsdocPropertyNames.some(({ idx, name: jsdocPropertyName }) => {
+		const isPropertyPath = jsdocPropertyName.includes(".");
+		if (isPropertyPath) {
+			if (!lastRealProperty) {
+				report(`@${targetTagName} path declaration ("${jsdocPropertyName}") appears before any real property.`, null, jsdoc.tags[idx]);
+				return true;
+			}
+			let pathRootNodeName = jsdocPropertyName.slice(0, jsdocPropertyName.indexOf("."));
+			if (pathRootNodeName.endsWith("[]")) pathRootNodeName = pathRootNodeName.slice(0, -2);
+			if (pathRootNodeName !== lastRealProperty) {
+				report(`@${targetTagName} path declaration ("${jsdocPropertyName}") root node name ("${pathRootNodeName}") does not match previous real property name ("${lastRealProperty}").`, null, jsdoc.tags[idx]);
+				return true;
+			}
+		} else lastRealProperty = jsdocPropertyName;
+		return false;
+	});
+};
+var checkPropertyNames_default = iterateJsdoc(({ context, jsdoc, report, utils }) => {
+	const { enableFixer = false } = context.options[0] || {};
+	const jsdocPropertyNamesDeep = utils.getJsdocTagsDeep("property");
+	if (!jsdocPropertyNamesDeep || !jsdocPropertyNamesDeep.length) return;
+	const targetTagName = utils.getPreferredTagName({ tagName: "property" });
+	const isError = validatePropertyNames(targetTagName, enableFixer, jsdoc, utils);
+	if (isError) return;
+	validatePropertyNamesDeep(targetTagName, jsdocPropertyNamesDeep, jsdoc, report);
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header"
+		},
+		fixable: "code",
+		schema: [{
+			additionalProperties: false,
+			properties: { enableFixer: { type: "boolean" } },
+			type: "object"
+		}],
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { checkPropertyNames_default as default };
+//# sourceMappingURL=checkPropertyNames.js.map

package/dist/rules/checkPropertyNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkPropertyNames.js","names":[],"sources":["../../src/rules/checkPropertyNames.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} targetTagName\n * @param {boolean} enableFixer\n * @param {import('comment-parser').Block} jsdoc\n * @param {import('../iterateJsdoc.js').Utils} utils\n * @returns {boolean}\n */\nconst validatePropertyNames = (\n  targetTagName,\n  enableFixer,\n  jsdoc, utils,\n) => {\n  const propertyTags = Object.entries(jsdoc.tags).filter(([\n    , tag,\n  ]) => {\n    return tag.tag === targetTagName;\n  });\n\n  return propertyTags.some(([\n    , tag,\n  ], index) => {\n    /** @type {import('../iterateJsdoc.js').Integer} */\n    let tagsIndex;\n    const dupeTagInfo = propertyTags.find(([\n      tgsIndex,\n      tg,\n    ], idx) => {\n      tagsIndex = Number(tgsIndex);\n\n      return tg.name === tag.name && idx !== index;\n    });\n    if (dupeTagInfo) {\n      utils.reportJSDoc(`Duplicate @${targetTagName} \"${tag.name}\"`, dupeTagInfo[1], enableFixer ? () => {\n        utils.removeTag(tagsIndex);\n      } : null);\n\n      return true;\n    }\n\n    return false;\n  });\n};\n\n/**\n * @param {string} targetTagName\n * @param {{\n *   idx: number;\n *   name: string;\n *   type: string;\n * }[]} jsdocPropertyNames\n * @param {import('comment-parser').Block} jsdoc\n * @param {Function} report\n */\nconst validatePropertyNamesDeep = (\n  targetTagName,\n  jsdocPropertyNames, jsdoc, report,\n) => {\n  /** @type {string} */\n  let lastRealProperty;\n\n  return jsdocPropertyNames.some(({\n    idx,\n    name: jsdocPropertyName,\n  }) => {\n    const isPropertyPath = jsdocPropertyName.includes('.');\n\n    if (isPropertyPath) {\n      if (!lastRealProperty) {\n        report(`@${targetTagName} path declaration (\"${jsdocPropertyName}\") appears before any real property.`, null, jsdoc.tags[idx]);\n\n        return true;\n      }\n\n      let pathRootNodeName = jsdocPropertyName.slice(0, jsdocPropertyName.indexOf('.'));\n\n      if (pathRootNodeName.endsWith('[]')) {\n        pathRootNodeName = pathRootNodeName.slice(0, -2);\n      }\n\n      if (pathRootNodeName !== lastRealProperty) {\n        report(\n          `@${targetTagName} path declaration (\"${jsdocPropertyName}\") root node name (\"${pathRootNodeName}\") ` +\n          `does not match previous real property name (\"${lastRealProperty}\").`,\n          null,\n          jsdoc.tags[idx],\n        );\n\n        return true;\n      }\n    } else {\n      lastRealProperty = jsdocPropertyName;\n    }\n\n    return false;\n  });\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdoc,\n  report,\n  utils,\n}) => {\n  const {\n    enableFixer = false,\n  } = context.options[0] || {};\n  const jsdocPropertyNamesDeep = utils.getJsdocTagsDeep('property');\n  if (!jsdocPropertyNamesDeep || !jsdocPropertyNamesDeep.length) {\n    return;\n  }\n\n  const targetTagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'property',\n  }));\n  const isError = validatePropertyNames(\n    targetTagName,\n    enableFixer,\n    jsdoc,\n    utils,\n  );\n\n  if (isError) {\n    return;\n  }\n\n  validatePropertyNamesDeep(\n    targetTagName, jsdocPropertyNamesDeep, jsdoc, report,\n  );\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          enableFixer: {\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;;;;;AASA,MAAM,wBAAwB,CAC5B,eACA,aACA,OAAO,UACJ;CACH,MAAM,eAAe,OAAO,QAAQ,MAAM,KAAK,CAAC,OAAO,CAAC,GACpD,IACH,KAAK;AACJ,SAAO,IAAI,QAAQ;CACpB,EAAC;AAEF,QAAO,aAAa,KAAK,CAAC,GACtB,IACH,EAAE,UAAU;;EAEX,IAAI;EACJ,MAAM,cAAc,aAAa,KAAK,CAAC,CACrC,UACA,GACD,EAAE,QAAQ;GACT,YAAY,OAAO,SAAS;AAE5B,UAAO,GAAG,SAAS,IAAI,QAAQ,QAAQ;EACxC,EAAC;AACF,MAAI,aAAa;GACf,MAAM,YAAY,CAAC,WAAW,EAAE,cAAc,EAAE,EAAE,IAAI,KAAK,CAAC,CAAC,EAAE,YAAY,IAAI,cAAc,MAAM;IACjG,MAAM,UAAU,UAAU;GAC3B,IAAG,KAAK;AAET,UAAO;EACR;AAED,SAAO;CACR,EAAC;AACH;;;;;;;;;;;AAYD,MAAM,4BAA4B,CAChC,eACA,oBAAoB,OAAO,WACxB;;CAEH,IAAI;AAEJ,QAAO,mBAAmB,KAAK,CAAC,EAC9B,KACA,MAAM,mBACP,KAAK;EACJ,MAAM,iBAAiB,kBAAkB,SAAS,IAAI;AAEtD,MAAI,gBAAgB;AAClB,OAAI,CAAC,kBAAkB;IACrB,OAAO,CAAC,CAAC,EAAE,cAAc,oBAAoB,EAAE,kBAAkB,oCAAoC,CAAC,EAAE,MAAM,MAAM,KAAK,KAAK;AAE9H,WAAO;GACR;GAED,IAAI,mBAAmB,kBAAkB,MAAM,GAAG,kBAAkB,QAAQ,IAAI,CAAC;AAEjF,OAAI,iBAAiB,SAAS,KAAK,EACjC,mBAAmB,iBAAiB,MAAM,GAAG,GAAG;AAGlD,OAAI,qBAAqB,kBAAkB;IACzC,OACE,CAAC,CAAC,EAAE,cAAc,oBAAoB,EAAE,kBAAkB,oBAAoB,EAAE,iBAAiB,gDAAG,EACpD,iBAAiB,GAAG,CAAC,EACrE,MACA,MAAM,KAAK,KACZ;AAED,WAAO;GACR;EACF,OACC,mBAAmB;AAGrB,SAAO;CACR,EAAC;AACH;AAED,iCAAe,aAAa,CAAC,EAC3B,SACA,OACA,QACA,OACD,KAAK;CACJ,MAAM,EACJ,cAAc,OACf,GAAG,QAAQ,QAAQ,MAAM,CAAE;CAC5B,MAAM,yBAAyB,MAAM,iBAAiB,WAAW;AACjE,KAAI,CAAC,0BAA0B,CAAC,uBAAuB,OACrD;CAGF,MAAM,gBAAuC,MAAM,oBAAoB,EACrE,SAAS,WACV,EAAC;CACF,MAAM,UAAU,sBACd,eACA,aACA,OACA,MACD;AAED,KAAI,QACF;CAGF,0BACE,eAAe,wBAAwB,OAAO,OAC/C;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,aAAa,EACX,MAAM,UACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkSyntax.cjs

@@ -1,38 +1,25 @@
-"use strict";
+const require_iterateJsdoc = require('../iterateJsdoc.cjs');
 
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _iterateJsdoc = _interopRequireDefault(require("../iterateJsdoc.cjs"));
-function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-var _default = exports.default = (0, _iterateJsdoc.default)(({
-  jsdoc,
-  report,
-  settings
-}) => {
-  const {
-    mode
-  } = settings;
-
-  // Don't check for "permissive" and "closure"
-  if (mode === 'jsdoc' || mode === 'typescript') {
-    for (const tag of jsdoc.tags) {
-      if (tag.type.slice(-1) === '=') {
-        report('Syntax should not be Google Closure Compiler style.', null, tag);
-        break;
-      }
-    }
-  }
+//#region src/rules/checkSyntax.js
+var checkSyntax_default = require_iterateJsdoc.default(({ jsdoc, report, settings }) => {
+	const { mode } = settings;
+	if (mode === "jsdoc" || mode === "typescript") {
+		for (const tag of jsdoc.tags) if (tag.type.slice(-1) === "=") {
+			report("Syntax should not be Google Closure Compiler style.", null, tag);
+			break;
+		}
+	}
 }, {
-  iterateAllJsdocs: true,
-  meta: {
-    docs: {
-      description: 'Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).',
-      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header'
-    },
-    type: 'suggestion'
-  }
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header"
+		},
+		type: "suggestion"
+	}
 });
-module.exports = exports.default;
+
+//#endregion
+exports.default = checkSyntax_default;
 //# sourceMappingURL=checkSyntax.cjs.map

package/dist/rules/checkSyntax.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"checkSyntax.cjs","names":["_iterateJsdoc","_interopRequireDefault","require","e","__esModule","default","_default","exports","iterateJsdoc","jsdoc","report","settings","mode","tag","tags","type","slice","iterateAllJsdocs","meta","docs","description","url","module"],"sources":["../../src/rules/checkSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  jsdoc,\n  report,\n  settings,\n}) => {\n  const {\n    mode,\n  } = settings;\n\n  // Don't check for \"permissive\" and \"closure\"\n  if (mode === 'jsdoc' || mode === 'typescript') {\n    for (const tag of jsdoc.tags) {\n      if (tag.type.slice(-1) === '=') {\n        report('Syntax should not be Google Closure Compiler style.', null, tag);\n        break;\n      }\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;;AAAA,IAAAA,aAAA,GAAAC,sBAAA,CAAAC,OAAA;AAA8C,SAAAD,uBAAAE,CAAA,WAAAA,CAAA,IAAAA,CAAA,CAAAC,UAAA,GAAAD,CAAA,KAAAE,OAAA,EAAAF,CAAA;AAAA,IAAAG,QAAA,GAAAC,OAAA,CAAAF,OAAA,GAE/B,IAAAG,qBAAY,EAAC,CAAC;EAC3BC,KAAK;EACLC,MAAM;EACNC;AACF,CAAC,KAAK;EACJ,MAAM;IACJC;EACF,CAAC,GAAGD,QAAQ;;EAEZ;EACA,IAAIC,IAAI,KAAK,OAAO,IAAIA,IAAI,KAAK,YAAY,EAAE;IAC7C,KAAK,MAAMC,GAAG,IAAIJ,KAAK,CAACK,IAAI,EAAE;MAC5B,IAAID,GAAG,CAACE,IAAI,CAACC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,EAAE;QAC9BN,MAAM,CAAC,qDAAqD,EAAE,IAAI,EAAEG,GAAG,CAAC;QACxE;MACF;IACF;EACF;AACF,CAAC,EAAE;EACDI,gBAAgB,EAAE,IAAI;EACtBC,IAAI,EAAE;IACJC,IAAI,EAAE;MACJC,WAAW,EAAE,oGAAoG;MACjHC,GAAG,EAAE;IACP,CAAC;IACDN,IAAI,EAAE;EACR;AACF,CAAC,CAAC;AAAAO,MAAA,CAAAf,OAAA,GAAAA,OAAA,CAAAF,OAAA","ignoreList":[]}
+{"version":3,"file":"checkSyntax.cjs","names":["iterateJsdoc"],"sources":["../../src/rules/checkSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  jsdoc,\n  report,\n  settings,\n}) => {\n  const {\n    mode,\n  } = settings;\n\n  // Don't check for \"permissive\" and \"closure\"\n  if (mode === 'jsdoc' || mode === 'typescript') {\n    for (const tag of jsdoc.tags) {\n      if (tag.type.slice(-1) === '=') {\n        report('Syntax should not be Google Closure Compiler style.', null, tag);\n        break;\n      }\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,0BAAeA,6BAAa,CAAC,EAC3B,OACA,QACA,UACD,KAAK;CACJ,MAAM,EACJ,MACD,GAAG;AAGJ,KAAI,SAAS,WAAW,SAAS,cAC/B;OAAK,MAAM,OAAO,MAAM,KACtB,KAAI,IAAI,KAAK,MAAM,GAAG,KAAK,KAAK;GAC9B,OAAO,uDAAuD,MAAM,IAAI;AACxE;EACD;CACF;AAEJ,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkSyntax.js

@@ -0,0 +1,25 @@
+import iterateJsdoc from "../iterateJsdoc.js";
+
+//#region src/rules/checkSyntax.js
+var checkSyntax_default = iterateJsdoc(({ jsdoc, report, settings }) => {
+	const { mode } = settings;
+	if (mode === "jsdoc" || mode === "typescript") {
+		for (const tag of jsdoc.tags) if (tag.type.slice(-1) === "=") {
+			report("Syntax should not be Google Closure Compiler style.", null, tag);
+			break;
+		}
+	}
+}, {
+	iterateAllJsdocs: true,
+	meta: {
+		docs: {
+			description: "Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).",
+			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header"
+		},
+		type: "suggestion"
+	}
+});
+
+//#endregion
+export { checkSyntax_default as default };
+//# sourceMappingURL=checkSyntax.js.map

package/dist/rules/checkSyntax.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"checkSyntax.js","names":[],"sources":["../../src/rules/checkSyntax.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\nexport default iterateJsdoc(({\n  jsdoc,\n  report,\n  settings,\n}) => {\n  const {\n    mode,\n  } = settings;\n\n  // Don't check for \"permissive\" and \"closure\"\n  if (mode === 'jsdoc' || mode === 'typescript') {\n    for (const tag of jsdoc.tags) {\n      if (tag.type.slice(-1) === '=') {\n        report('Syntax should not be Google Closure Compiler style.', null, tag);\n        break;\n      }\n    }\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header',\n    },\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;AAEA,0BAAe,aAAa,CAAC,EAC3B,OACA,QACA,UACD,KAAK;CACJ,MAAM,EACJ,MACD,GAAG;AAGJ,KAAI,SAAS,WAAW,SAAS,cAC/B;OAAK,MAAM,OAAO,MAAM,KACtB,KAAI,IAAI,KAAK,MAAM,GAAG,KAAK,KAAK;GAC9B,OAAO,uDAAuD,MAAM,IAAI;AACxE;EACD;CACF;AAEJ,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,MAAM;CACP;AACF,EAAC"}