eslint-plugin-jsdoc 53.0.1 → 54.1.0

package/dist/rules/checkAlignment.js

@@ -1,47 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/checkAlignment.js
-/**
-* @param {string} string
-* @returns {string}
-*/
-const trimStart = (string) => {
-	return string.replace(/^\s+/v, "");
-};
-var checkAlignment_default = iterateJsdoc(({ indent, jsdocNode, report, sourceCode }) => {
-	const indentLevel = indent.length + 1;
-	const sourceLines = sourceCode.getText(jsdocNode).split("\n").slice(1).map((line) => {
-		return line.split("*")[0];
-	}).filter((line) => {
-		return !trimStart(line).length;
-	});
-	/** @type {import('eslint').Rule.ReportFixer} */
-	const fix = (fixer) => {
-		const replacement = sourceCode.getText(jsdocNode).split("\n").map((line, index) => {
-			const ignored = !index || trimStart(line.split("*")[0]).length;
-			return ignored ? line : `${indent} ${trimStart(line)}`;
-		}).join("\n");
-		return fixer.replaceText(jsdocNode, replacement);
-	};
-	sourceLines.some((line, lineNum) => {
-		if (line.length !== indentLevel) {
-			report("Expected JSDoc block to be aligned.", fix, { line: lineNum + 1 });
-			return true;
-		}
-		return false;
-	});
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Reports invalid alignment of JSDoc block asterisks.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header"
-		},
-		fixable: "code",
-		type: "layout"
-	}
-});
-
-//#endregion
-export { checkAlignment_default as default };
-//# sourceMappingURL=checkAlignment.js.map

package/dist/rules/checkAlignment.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkAlignment.js","names":[],"sources":["../../src/rules/checkAlignment.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} string\n * @returns {string}\n */\nconst trimStart = (string) => {\n  return string.replace(/^\\s+/v, '');\n};\n\nexport default iterateJsdoc(({\n  indent,\n  jsdocNode,\n  report,\n  sourceCode,\n}) => {\n  // `indent` is whitespace from line 1 (`/**`), so slice and account for \"/\".\n  const indentLevel = indent.length + 1;\n  const sourceLines = sourceCode.getText(jsdocNode).split('\\n')\n    .slice(1)\n    .map((line) => {\n      return line.split('*')[0];\n    })\n    .filter((line) => {\n      return !trimStart(line).length;\n    });\n\n  /** @type {import('eslint').Rule.ReportFixer} */\n  const fix = (fixer) => {\n    const replacement = sourceCode.getText(jsdocNode).split('\\n')\n      .map((line, index) => {\n        // Ignore the first line and all lines not starting with `*`\n        const ignored = !index || trimStart(line.split('*')[0]).length;\n\n        return ignored ? line : `${indent} ${trimStart(line)}`;\n      })\n      .join('\\n');\n\n    return fixer.replaceText(jsdocNode, replacement);\n  };\n\n  sourceLines.some((line, lineNum) => {\n    if (line.length !== indentLevel) {\n      report('Expected JSDoc block to be aligned.', fix, {\n        line: lineNum + 1,\n      });\n\n      return true;\n    }\n\n    return false;\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports invalid alignment of JSDoc block asterisks.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header',\n    },\n    fixable: 'code',\n    type: 'layout',\n  },\n});\n"],"mappings":";;;;;;;AAMA,MAAM,YAAY,CAAC,WAAW;AAC5B,QAAO,OAAO,QAAQ,SAAS,GAAG;AACnC;AAED,6BAAe,aAAa,CAAC,EAC3B,QACA,WACA,QACA,YACD,KAAK;CAEJ,MAAM,cAAc,OAAO,SAAS;CACpC,MAAM,cAAc,WAAW,QAAQ,UAAU,CAAC,MAAM,KAAK,CAC1D,MAAM,EAAE,CACR,IAAI,CAAC,SAAS;AACb,SAAO,KAAK,MAAM,IAAI,CAAC;CACxB,EAAC,CACD,OAAO,CAAC,SAAS;AAChB,SAAO,CAAC,UAAU,KAAK,CAAC;CACzB,EAAC;;CAGJ,MAAM,MAAM,CAAC,UAAU;EACrB,MAAM,cAAc,WAAW,QAAQ,UAAU,CAAC,MAAM,KAAK,CAC1D,IAAI,CAAC,MAAM,UAAU;GAEpB,MAAM,UAAU,CAAC,SAAS,UAAU,KAAK,MAAM,IAAI,CAAC,GAAG,CAAC;AAExD,UAAO,UAAU,OAAO,GAAG,OAAO,CAAC,EAAE,UAAU,KAAK,EAAE;EACvD,EAAC,CACD,KAAK,KAAK;AAEb,SAAO,MAAM,YAAY,WAAW,YAAY;CACjD;CAED,YAAY,KAAK,CAAC,MAAM,YAAY;AAClC,MAAI,KAAK,WAAW,aAAa;GAC/B,OAAO,uCAAuC,KAAK,EACjD,MAAM,UAAU,EACjB,EAAC;AAEF,UAAO;EACR;AAED,SAAO;CACR,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,SAAS;EACT,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkExamples.js

@@ -1,348 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-import eslint, { ESLint } from "eslint";
-import semver from "semver";
-
-//#region src/rules/checkExamples.js
-const { CLIEngine } = eslint;
-const zeroBasedLineIndexAdjust = -1;
-const likelyNestedJSDocIndentSpace = 1;
-const preTagSpaceLength = 1;
-const firstLinePrefixLength = preTagSpaceLength;
-const hasCaptionRegex = /^\s*<caption>([\s\S]*?)<\/caption>/v;
-/**
-* @param {string} str
-* @returns {string}
-*/
-const escapeStringRegexp = (str) => {
-	return str.replaceAll(/[.*+?^$\{\}\(\)\|\[\]\\]/gv, "\\$&");
-};
-/**
-* @param {string} str
-* @param {string} ch
-* @returns {import('../iterateJsdoc.js').Integer}
-*/
-const countChars = (str, ch) => {
-	return (str.match(new RegExp(escapeStringRegexp(ch), "gv")) || []).length;
-};
-/** @type {import('eslint').Linter.RulesRecord} */
-const defaultMdRules = {
-	"eol-last": 0,
-	"import/no-unresolved": 0,
-	"import/unambiguous": 0,
-	"jsdoc/require-file-overview": 0,
-	"jsdoc/require-jsdoc": 0,
-	"no-console": 0,
-	"no-multiple-empty-lines": 0,
-	"no-undef": 0,
-	"no-unused-vars": 0,
-	"node/no-missing-import": 0,
-	"node/no-missing-require": 0,
-	"padded-blocks": 0
-};
-/** @type {import('eslint').Linter.RulesRecord} */
-const defaultExpressionRules = {
-	...defaultMdRules,
-	"chai-friendly/no-unused-expressions": "off",
-	"no-empty-function": "off",
-	"no-new": "off",
-	"no-unused-expressions": "off",
-	quotes: ["error", "double"],
-	semi: ["error", "never"],
-	strict: "off"
-};
-/**
-* @param {string} text
-* @returns {[
-*   import('../iterateJsdoc.js').Integer,
-*   import('../iterateJsdoc.js').Integer
-* ]}
-*/
-const getLinesCols = (text) => {
-	const matchLines = countChars(text, "\n");
-	const colDelta = matchLines ? text.slice(text.lastIndexOf("\n") + 1).length : text.length;
-	return [matchLines, colDelta];
-};
-var checkExamples_default = iterateJsdoc(({ context, globalState, report, utils }) => {
-	if (semver.gte(ESLint.version, "8.0.0")) {
-		report("This rule does not work for ESLint 8+; you should disable this rule and usethe processor mentioned in the docs.", null, {
-			column: 1,
-			line: 1
-		});
-		return;
-	}
-	if (!globalState.has("checkExamples-matchingFileName")) globalState.set("checkExamples-matchingFileName", /* @__PURE__ */ new Map());
-	const matchingFileNameMap = globalState.get("checkExamples-matchingFileName");
-	const options = context.options[0] || {};
-	let { exampleCodeRegex = null, rejectExampleCodeRegex = null } = options;
-	const { allowInlineConfig = true, baseConfig = {}, captionRequired = false, checkDefaults = false, checkEslintrc = true, checkParams = false, checkProperties = false, configFile, matchingFileName = null, matchingFileNameDefaults = null, matchingFileNameParams = null, matchingFileNameProperties = null, noDefaultExampleRules = false, paddedIndent = 0, reportUnusedDisableDirectives = true } = options;
-	/**
-	* @type {never[]}
-	*/
-	const rulePaths = [];
-	const mdRules = noDefaultExampleRules ? void 0 : defaultMdRules;
-	const expressionRules = noDefaultExampleRules ? void 0 : defaultExpressionRules;
-	if (exampleCodeRegex) exampleCodeRegex = utils.getRegexFromString(exampleCodeRegex);
-	if (rejectExampleCodeRegex) rejectExampleCodeRegex = utils.getRegexFromString(rejectExampleCodeRegex);
-	/**
-	* @param {{
-	*   filename: string,
-	*   defaultFileName: string|undefined,
-	*   source: string,
-	*   targetTagName: string,
-	*   rules?: import('eslint').Linter.RulesRecord|undefined,
-	*   lines?: import('../iterateJsdoc.js').Integer,
-	*   cols?: import('../iterateJsdoc.js').Integer,
-	*   skipInit?: boolean,
-	*   sources?: {
-	*     nonJSPrefacingCols: import('../iterateJsdoc.js').Integer,
-	*     nonJSPrefacingLines: import('../iterateJsdoc.js').Integer,
-	*     string: string,
-	*   }[],
-	*   tag?: import('comment-parser').Spec & {
-	*     line?: import('../iterateJsdoc.js').Integer,
-	*   }|{
-	*     line: import('../iterateJsdoc.js').Integer,
-	*   }
-	* }} cfg
-	*/
-	const checkSource = ({ cols = 0, defaultFileName, filename, lines = 0, rules = expressionRules, skipInit, source, sources = [], tag = { line: 0 }, targetTagName }) => {
-		if (!skipInit) sources.push({
-			nonJSPrefacingCols: cols,
-			nonJSPrefacingLines: lines,
-			string: source
-		});
-		/**
-		* @param {{
-		*   nonJSPrefacingCols: import('../iterateJsdoc.js').Integer,
-		*   nonJSPrefacingLines: import('../iterateJsdoc.js').Integer,
-		*   string: string
-		* }} cfg
-		*/
-		const checkRules = function({ nonJSPrefacingCols, nonJSPrefacingLines, string }) {
-			const cliConfig = {
-				allowInlineConfig,
-				baseConfig,
-				configFile,
-				reportUnusedDisableDirectives,
-				rulePaths,
-				rules,
-				useEslintrc: checkEslintrc
-			};
-			const cliConfigStr = JSON.stringify(cliConfig);
-			const src = paddedIndent ? string.replaceAll(new RegExp(`(^|\n) {${paddedIndent}}(?!$)`, "gv"), "\n") : string;
-			const fileNameMapKey = filename ? "a" + cliConfigStr + filename : "b" + cliConfigStr + defaultFileName;
-			const file = filename || defaultFileName;
-			let cliFile;
-			if (matchingFileNameMap.has(fileNameMapKey)) cliFile = matchingFileNameMap.get(fileNameMapKey);
-			else {
-				const cli = new CLIEngine(cliConfig);
-				let config;
-				if (filename || checkEslintrc) config = cli.getConfigForFile(file);
-				cliFile = new CLIEngine({
-					allowInlineConfig,
-					baseConfig: {
-						...baseConfig,
-						...config
-					},
-					configFile,
-					reportUnusedDisableDirectives,
-					rulePaths,
-					rules,
-					useEslintrc: false
-				});
-				matchingFileNameMap.set(fileNameMapKey, cliFile);
-			}
-			const { results: [{ messages }] } = cliFile.executeOnText(src);
-			if (!("line" in tag)) tag.line = tag.source[0].number;
-			const codeStartLine = tag.line + nonJSPrefacingLines;
-			const codeStartCol = likelyNestedJSDocIndentSpace;
-			for (const { column, line, message, ruleId, severity } of messages) {
-				const startLine = codeStartLine + line + zeroBasedLineIndexAdjust;
-				const startCol = codeStartCol + (line <= 1 ? nonJSPrefacingCols + firstLinePrefixLength : preTagSpaceLength) + column;
-				report("@" + targetTagName + " " + (severity === 2 ? "error" : "warning") + (ruleId ? " (" + ruleId + ")" : "") + ": " + message, null, {
-					column: startCol,
-					line: startLine
-				});
-			}
-		};
-		for (const targetSource of sources) checkRules(targetSource);
-	};
-	/**
-	*
-	* @param {string} filename
-	* @param {string} [ext] Since `eslint-plugin-markdown` v2, and
-	*   ESLint 7, this is the default which other JS-fenced rules will used.
-	*   Formerly "md" was the default.
-	* @returns {{defaultFileName: string|undefined, filename: string}}
-	*/
-	const getFilenameInfo = (filename, ext = "md/*.js") => {
-		let defaultFileName;
-		if (!filename) {
-			const jsFileName = context.getFilename();
-			if (typeof jsFileName === "string" && jsFileName.includes(".")) defaultFileName = jsFileName.replace(/\.[^.]*$/v, `.${ext}`);
-			else defaultFileName = `dummy.${ext}`;
-		}
-		return {
-			defaultFileName,
-			filename
-		};
-	};
-	if (checkDefaults) {
-		const filenameInfo = getFilenameInfo(matchingFileNameDefaults, "jsdoc-defaults");
-		utils.forEachPreferredTag("default", (tag, targetTagName) => {
-			if (!tag.description.trim()) return;
-			checkSource({
-				source: `(${utils.getTagDescription(tag)})`,
-				targetTagName,
-				...filenameInfo
-			});
-		});
-	}
-	if (checkParams) {
-		const filenameInfo = getFilenameInfo(matchingFileNameParams, "jsdoc-params");
-		utils.forEachPreferredTag("param", (tag, targetTagName) => {
-			if (!tag.default || !tag.default.trim()) return;
-			checkSource({
-				source: `(${tag.default})`,
-				targetTagName,
-				...filenameInfo
-			});
-		});
-	}
-	if (checkProperties) {
-		const filenameInfo = getFilenameInfo(matchingFileNameProperties, "jsdoc-properties");
-		utils.forEachPreferredTag("property", (tag, targetTagName) => {
-			if (!tag.default || !tag.default.trim()) return;
-			checkSource({
-				source: `(${tag.default})`,
-				targetTagName,
-				...filenameInfo
-			});
-		});
-	}
-	const tagName = utils.getPreferredTagName({ tagName: "example" });
-	if (!utils.hasTag(tagName)) return;
-	const matchingFilenameInfo = getFilenameInfo(matchingFileName);
-	utils.forEachPreferredTag("example", (tag, targetTagName) => {
-		let source = utils.getTagDescription(tag);
-		const match = source.match(hasCaptionRegex);
-		if (captionRequired && (!match || !match[1].trim())) report("Caption is expected for examples.", null, tag);
-		source = source.replace(hasCaptionRegex, "");
-		const [lines, cols] = match ? getLinesCols(match[0]) : [0, 0];
-		if (exampleCodeRegex && !exampleCodeRegex.test(source) || rejectExampleCodeRegex && rejectExampleCodeRegex.test(source)) return;
-		const sources = [];
-		let skipInit = false;
-		if (exampleCodeRegex) {
-			let nonJSPrefacingCols = 0;
-			let nonJSPrefacingLines = 0;
-			let startingIndex = 0;
-			let lastStringCount = 0;
-			let exampleCode;
-			exampleCodeRegex.lastIndex = 0;
-			while ((exampleCode = exampleCodeRegex.exec(source)) !== null) {
-				const { "0": n0, "1": n1, index } = exampleCode;
-				const preMatch = source.slice(startingIndex, index);
-				const [preMatchLines, colDelta] = getLinesCols(preMatch);
-				let nonJSPreface;
-				let nonJSPrefaceLineCount;
-				if (n1) {
-					const idx = n0.indexOf(n1);
-					nonJSPreface = n0.slice(0, idx);
-					nonJSPrefaceLineCount = countChars(nonJSPreface, "\n");
-				} else {
-					nonJSPreface = "";
-					nonJSPrefaceLineCount = 0;
-				}
-				nonJSPrefacingLines += lastStringCount + preMatchLines + nonJSPrefaceLineCount;
-				if (nonJSPrefaceLineCount) {
-					const charsInLastLine = nonJSPreface.slice(nonJSPreface.lastIndexOf("\n") + 1).length;
-					nonJSPrefacingCols += charsInLastLine;
-				} else nonJSPrefacingCols += colDelta + nonJSPreface.length;
-				const string = n1 || n0;
-				sources.push({
-					nonJSPrefacingCols,
-					nonJSPrefacingLines,
-					string
-				});
-				startingIndex = exampleCodeRegex.lastIndex;
-				lastStringCount = countChars(string, "\n");
-				if (!exampleCodeRegex.global) break;
-			}
-			skipInit = true;
-		}
-		checkSource({
-			cols,
-			lines,
-			rules: mdRules,
-			skipInit,
-			source,
-			sources,
-			tag,
-			targetTagName,
-			...matchingFilenameInfo
-		});
-	});
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-examples.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: {
-				allowInlineConfig: {
-					default: true,
-					type: "boolean"
-				},
-				baseConfig: { type: "object" },
-				captionRequired: {
-					default: false,
-					type: "boolean"
-				},
-				checkDefaults: {
-					default: false,
-					type: "boolean"
-				},
-				checkEslintrc: {
-					default: true,
-					type: "boolean"
-				},
-				checkParams: {
-					default: false,
-					type: "boolean"
-				},
-				checkProperties: {
-					default: false,
-					type: "boolean"
-				},
-				configFile: { type: "string" },
-				exampleCodeRegex: { type: "string" },
-				matchingFileName: { type: "string" },
-				matchingFileNameDefaults: { type: "string" },
-				matchingFileNameParams: { type: "string" },
-				matchingFileNameProperties: { type: "string" },
-				noDefaultExampleRules: {
-					default: false,
-					type: "boolean"
-				},
-				paddedIndent: {
-					default: 0,
-					type: "integer"
-				},
-				rejectExampleCodeRegex: { type: "string" },
-				reportUnusedDisableDirectives: {
-					default: true,
-					type: "boolean"
-				}
-			},
-			type: "object"
-		}],
-		type: "suggestion"
-	}
-});
-
-//#endregion
-export { checkExamples_default as default };
-//# sourceMappingURL=checkExamples.js.map

package/dist/rules/checkExamples.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkExamples.js","names":[],"sources":["../../src/rules/checkExamples.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\nimport eslint, {\n  ESLint,\n} from 'eslint';\nimport semver from 'semver';\n\nconst {\n  // @ts-expect-error Older ESLint\n  CLIEngine,\n} = eslint;\n\nconst zeroBasedLineIndexAdjust = -1;\nconst likelyNestedJSDocIndentSpace = 1;\nconst preTagSpaceLength = 1;\n\n// If a space is present, we should ignore it\nconst firstLinePrefixLength = preTagSpaceLength;\n\nconst hasCaptionRegex = /^\\s*<caption>([\\s\\S]*?)<\\/caption>/v;\n\n/**\n * @param {string} str\n * @returns {string}\n */\nconst escapeStringRegexp = (str) => {\n  return str.replaceAll(/[.*+?^$\\{\\}\\(\\)\\|\\[\\]\\\\]/gv, '\\\\$&');\n};\n\n/**\n * @param {string} str\n * @param {string} ch\n * @returns {import('../iterateJsdoc.js').Integer}\n */\nconst countChars = (str, ch) => {\n  return (str.match(new RegExp(escapeStringRegexp(ch), 'gv')) || []).length;\n};\n\n/** @type {import('eslint').Linter.RulesRecord} */\nconst defaultMdRules = {\n  // \"always\" newline rule at end unlikely in sample code\n  'eol-last': 0,\n\n  // Wouldn't generally expect example paths to resolve relative to JS file\n  'import/no-unresolved': 0,\n\n  // Snippets likely too short to always include import/export info\n  'import/unambiguous': 0,\n\n  'jsdoc/require-file-overview': 0,\n\n  // The end of a multiline comment would end the comment the example is in.\n  'jsdoc/require-jsdoc': 0,\n\n  // Unlikely to have inadvertent debugging within examples\n  'no-console': 0,\n\n  // Often wish to start `@example` code after newline; also may use\n  //   empty lines for spacing\n  'no-multiple-empty-lines': 0,\n\n  // Many variables in examples will be `undefined`\n  'no-undef': 0,\n\n  // Common to define variables for clarity without always using them\n  'no-unused-vars': 0,\n\n  // See import/no-unresolved\n  'node/no-missing-import': 0,\n  'node/no-missing-require': 0,\n\n  // Can generally look nicer to pad a little even if code imposes more stringency\n  'padded-blocks': 0,\n};\n\n/** @type {import('eslint').Linter.RulesRecord} */\nconst defaultExpressionRules = {\n  ...defaultMdRules,\n  'chai-friendly/no-unused-expressions': 'off',\n  'no-empty-function': 'off',\n  'no-new': 'off',\n  'no-unused-expressions': 'off',\n  quotes: [\n    'error', 'double',\n  ],\n  semi: [\n    'error', 'never',\n  ],\n  strict: 'off',\n};\n\n/**\n * @param {string} text\n * @returns {[\n *   import('../iterateJsdoc.js').Integer,\n *   import('../iterateJsdoc.js').Integer\n * ]}\n */\nconst getLinesCols = (text) => {\n  const matchLines = countChars(text, '\\n');\n\n  const colDelta = matchLines ?\n    text.slice(text.lastIndexOf('\\n') + 1).length :\n    text.length;\n\n  return [\n    matchLines, colDelta,\n  ];\n};\n\nexport default iterateJsdoc(({\n  context,\n  globalState,\n  report,\n  utils,\n}) => {\n  if (semver.gte(ESLint.version, '8.0.0')) {\n    report(\n      'This rule does not work for ESLint 8+; you should disable this rule and use' +\n        'the processor mentioned in the docs.',\n      null,\n      {\n        column: 1,\n        line: 1,\n      },\n    );\n\n    return;\n  }\n\n  if (!globalState.has('checkExamples-matchingFileName')) {\n    globalState.set('checkExamples-matchingFileName', new Map());\n  }\n\n  const matchingFileNameMap = /** @type {Map<string, string>} */ (\n    globalState.get('checkExamples-matchingFileName')\n  );\n\n  const options = context.options[0] || {};\n  let {\n    exampleCodeRegex = null,\n    rejectExampleCodeRegex = null,\n  } = options;\n  const {\n    allowInlineConfig = true,\n    baseConfig = {},\n    captionRequired = false,\n    checkDefaults = false,\n    checkEslintrc = true,\n    checkParams = false,\n    checkProperties = false,\n    configFile,\n    matchingFileName = null,\n    matchingFileNameDefaults = null,\n    matchingFileNameParams = null,\n    matchingFileNameProperties = null,\n    noDefaultExampleRules = false,\n    paddedIndent = 0,\n    reportUnusedDisableDirectives = true,\n  } = options;\n\n  // Make this configurable?\n  /**\n   * @type {never[]}\n   */\n  const rulePaths = [];\n\n  const mdRules = noDefaultExampleRules ? undefined : defaultMdRules;\n\n  const expressionRules = noDefaultExampleRules ? undefined : defaultExpressionRules;\n\n  if (exampleCodeRegex) {\n    exampleCodeRegex = utils.getRegexFromString(exampleCodeRegex);\n  }\n\n  if (rejectExampleCodeRegex) {\n    rejectExampleCodeRegex = utils.getRegexFromString(rejectExampleCodeRegex);\n  }\n\n  /**\n   * @param {{\n   *   filename: string,\n   *   defaultFileName: string|undefined,\n   *   source: string,\n   *   targetTagName: string,\n   *   rules?: import('eslint').Linter.RulesRecord|undefined,\n   *   lines?: import('../iterateJsdoc.js').Integer,\n   *   cols?: import('../iterateJsdoc.js').Integer,\n   *   skipInit?: boolean,\n   *   sources?: {\n   *     nonJSPrefacingCols: import('../iterateJsdoc.js').Integer,\n   *     nonJSPrefacingLines: import('../iterateJsdoc.js').Integer,\n   *     string: string,\n   *   }[],\n   *   tag?: import('comment-parser').Spec & {\n   *     line?: import('../iterateJsdoc.js').Integer,\n   *   }|{\n   *     line: import('../iterateJsdoc.js').Integer,\n   *   }\n   * }} cfg\n   */\n  const checkSource = ({\n    cols = 0,\n    defaultFileName,\n    filename,\n    lines = 0,\n    rules = expressionRules,\n    skipInit,\n    source,\n    sources = [],\n    tag = {\n      line: 0,\n    },\n    targetTagName,\n  }) => {\n    if (!skipInit) {\n      sources.push({\n        nonJSPrefacingCols: cols,\n        nonJSPrefacingLines: lines,\n        string: source,\n      });\n    }\n\n    /**\n     * @param {{\n     *   nonJSPrefacingCols: import('../iterateJsdoc.js').Integer,\n     *   nonJSPrefacingLines: import('../iterateJsdoc.js').Integer,\n     *   string: string\n     * }} cfg\n     */\n    const checkRules = function ({\n      nonJSPrefacingCols,\n      nonJSPrefacingLines,\n      string,\n    }) {\n      const cliConfig = {\n        allowInlineConfig,\n        baseConfig,\n        configFile,\n        reportUnusedDisableDirectives,\n        rulePaths,\n        rules,\n        useEslintrc: checkEslintrc,\n      };\n      const cliConfigStr = JSON.stringify(cliConfig);\n\n      const src = paddedIndent ?\n        string.replaceAll(new RegExp(`(^|\\n) {${paddedIndent}}(?!$)`, 'gv'), '\\n') :\n        string;\n\n      // Programmatic ESLint API: https://eslint.org/docs/developer-guide/nodejs-api\n      const fileNameMapKey = filename ?\n        'a' + cliConfigStr + filename :\n        'b' + cliConfigStr + defaultFileName;\n      const file = filename || defaultFileName;\n      let cliFile;\n      if (matchingFileNameMap.has(fileNameMapKey)) {\n        cliFile = matchingFileNameMap.get(fileNameMapKey);\n      } else {\n        const cli = new CLIEngine(cliConfig);\n        let config;\n        if (filename || checkEslintrc) {\n          config = cli.getConfigForFile(file);\n        }\n\n        // We need a new instance to ensure that the rules that may only\n        //  be available to `file` (if it has its own `.eslintrc`),\n        //  will be defined.\n        cliFile = new CLIEngine({\n          allowInlineConfig,\n          baseConfig: {\n            ...baseConfig,\n            ...config,\n          },\n          configFile,\n          reportUnusedDisableDirectives,\n          rulePaths,\n          rules,\n          useEslintrc: false,\n        });\n        matchingFileNameMap.set(fileNameMapKey, cliFile);\n      }\n\n      const {\n        results: [\n          {\n            messages,\n          },\n        ],\n      } = cliFile.executeOnText(src);\n\n      if (!('line' in tag)) {\n        tag.line = tag.source[0].number;\n      }\n\n      // NOTE: `tag.line` can be 0 if of form `/** @tag ... */`\n      const codeStartLine = /**\n                             * @type {import('comment-parser').Spec & {\n                             *     line: import('../iterateJsdoc.js').Integer,\n                             * }}\n                             */ (tag).line + nonJSPrefacingLines;\n      const codeStartCol = likelyNestedJSDocIndentSpace;\n\n      for (const {\n        column,\n        line,\n        message,\n        ruleId,\n        severity,\n      } of messages) {\n        const startLine = codeStartLine + line + zeroBasedLineIndexAdjust;\n        const startCol = codeStartCol + (\n\n          // This might not work for line 0, but line 0 is unlikely for examples\n          line <= 1 ? nonJSPrefacingCols + firstLinePrefixLength : preTagSpaceLength\n        ) + column;\n\n        report(\n          '@' + targetTagName + ' ' + (severity === 2 ? 'error' : 'warning') +\n            (ruleId ? ' (' + ruleId + ')' : '') + ': ' +\n            message,\n          null,\n          {\n            column: startCol,\n            line: startLine,\n          },\n        );\n      }\n    };\n\n    for (const targetSource of sources) {\n      checkRules(targetSource);\n    }\n  };\n\n  /**\n   *\n   * @param {string} filename\n   * @param {string} [ext] Since `eslint-plugin-markdown` v2, and\n   *   ESLint 7, this is the default which other JS-fenced rules will used.\n   *   Formerly \"md\" was the default.\n   * @returns {{defaultFileName: string|undefined, filename: string}}\n   */\n  const getFilenameInfo = (filename, ext = 'md/*.js') => {\n    let defaultFileName;\n    if (!filename) {\n      const jsFileName = context.getFilename();\n      if (typeof jsFileName === 'string' && jsFileName.includes('.')) {\n        defaultFileName = jsFileName.replace(/\\.[^.]*$/v, `.${ext}`);\n      } else {\n        defaultFileName = `dummy.${ext}`;\n      }\n    }\n\n    return {\n      defaultFileName,\n      filename,\n    };\n  };\n\n  if (checkDefaults) {\n    const filenameInfo = getFilenameInfo(matchingFileNameDefaults, 'jsdoc-defaults');\n    utils.forEachPreferredTag('default', (tag, targetTagName) => {\n      if (!tag.description.trim()) {\n        return;\n      }\n\n      checkSource({\n        source: `(${utils.getTagDescription(tag)})`,\n        targetTagName,\n        ...filenameInfo,\n      });\n    });\n  }\n\n  if (checkParams) {\n    const filenameInfo = getFilenameInfo(matchingFileNameParams, 'jsdoc-params');\n    utils.forEachPreferredTag('param', (tag, targetTagName) => {\n      if (!tag.default || !tag.default.trim()) {\n        return;\n      }\n\n      checkSource({\n        source: `(${tag.default})`,\n        targetTagName,\n        ...filenameInfo,\n      });\n    });\n  }\n\n  if (checkProperties) {\n    const filenameInfo = getFilenameInfo(matchingFileNameProperties, 'jsdoc-properties');\n    utils.forEachPreferredTag('property', (tag, targetTagName) => {\n      if (!tag.default || !tag.default.trim()) {\n        return;\n      }\n\n      checkSource({\n        source: `(${tag.default})`,\n        targetTagName,\n        ...filenameInfo,\n      });\n    });\n  }\n\n  const tagName = /** @type {string} */ (utils.getPreferredTagName({\n    tagName: 'example',\n  }));\n  if (!utils.hasTag(tagName)) {\n    return;\n  }\n\n  const matchingFilenameInfo = getFilenameInfo(matchingFileName);\n\n  utils.forEachPreferredTag('example', (tag, targetTagName) => {\n    let source = /** @type {string} */ (utils.getTagDescription(tag));\n    const match = source.match(hasCaptionRegex);\n\n    if (captionRequired && (!match || !match[1].trim())) {\n      report('Caption is expected for examples.', null, tag);\n    }\n\n    source = source.replace(hasCaptionRegex, '');\n    const [\n      lines,\n      cols,\n    ] = match ? getLinesCols(match[0]) : [\n      0, 0,\n    ];\n\n    if (exampleCodeRegex && !exampleCodeRegex.test(source) ||\n      rejectExampleCodeRegex && rejectExampleCodeRegex.test(source)\n    ) {\n      return;\n    }\n\n    const sources = [];\n    let skipInit = false;\n    if (exampleCodeRegex) {\n      let nonJSPrefacingCols = 0;\n      let nonJSPrefacingLines = 0;\n\n      let startingIndex = 0;\n      let lastStringCount = 0;\n\n      let exampleCode;\n      exampleCodeRegex.lastIndex = 0;\n      while ((exampleCode = exampleCodeRegex.exec(source)) !== null) {\n        const {\n          '0': n0,\n          '1': n1,\n          index,\n        } = exampleCode;\n\n        // Count anything preceding user regex match (can affect line numbering)\n        const preMatch = source.slice(startingIndex, index);\n\n        const [\n          preMatchLines,\n          colDelta,\n        ] = getLinesCols(preMatch);\n\n        let nonJSPreface;\n        let nonJSPrefaceLineCount;\n        if (n1) {\n          const idx = n0.indexOf(n1);\n          nonJSPreface = n0.slice(0, idx);\n          nonJSPrefaceLineCount = countChars(nonJSPreface, '\\n');\n        } else {\n          nonJSPreface = '';\n          nonJSPrefaceLineCount = 0;\n        }\n\n        nonJSPrefacingLines += lastStringCount + preMatchLines + nonJSPrefaceLineCount;\n\n        // Ignore `preMatch` delta if newlines here\n        if (nonJSPrefaceLineCount) {\n          const charsInLastLine = nonJSPreface.slice(nonJSPreface.lastIndexOf('\\n') + 1).length;\n\n          nonJSPrefacingCols += charsInLastLine;\n        } else {\n          nonJSPrefacingCols += colDelta + nonJSPreface.length;\n        }\n\n        const string = n1 || n0;\n        sources.push({\n          nonJSPrefacingCols,\n          nonJSPrefacingLines,\n          string,\n        });\n        startingIndex = exampleCodeRegex.lastIndex;\n        lastStringCount = countChars(string, '\\n');\n        if (!exampleCodeRegex.global) {\n          break;\n        }\n      }\n\n      skipInit = true;\n    }\n\n    checkSource({\n      cols,\n      lines,\n      rules: mdRules,\n      skipInit,\n      source,\n      sources,\n      tag,\n      targetTagName,\n      ...matchingFilenameInfo,\n    });\n  });\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-examples.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          allowInlineConfig: {\n            default: true,\n            type: 'boolean',\n          },\n          baseConfig: {\n            type: 'object',\n          },\n          captionRequired: {\n            default: false,\n            type: 'boolean',\n          },\n          checkDefaults: {\n            default: false,\n            type: 'boolean',\n          },\n          checkEslintrc: {\n            default: true,\n            type: 'boolean',\n          },\n          checkParams: {\n            default: false,\n            type: 'boolean',\n          },\n          checkProperties: {\n            default: false,\n            type: 'boolean',\n          },\n          configFile: {\n            type: 'string',\n          },\n          exampleCodeRegex: {\n            type: 'string',\n          },\n          matchingFileName: {\n            type: 'string',\n          },\n          matchingFileNameDefaults: {\n            type: 'string',\n          },\n          matchingFileNameParams: {\n            type: 'string',\n          },\n          matchingFileNameProperties: {\n            type: 'string',\n          },\n          noDefaultExampleRules: {\n            default: false,\n            type: 'boolean',\n          },\n          paddedIndent: {\n            default: 0,\n            type: 'integer',\n          },\n          rejectExampleCodeRegex: {\n            type: 'string',\n          },\n          reportUnusedDisableDirectives: {\n            default: true,\n            type: 'boolean',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'suggestion',\n  },\n});\n"],"mappings":";;;;;AAMA,MAAM,EAEJ,WACD,GAAG;AAEJ,MAAM,2BAA2B;AACjC,MAAM,+BAA+B;AACrC,MAAM,oBAAoB;AAG1B,MAAM,wBAAwB;AAE9B,MAAM,kBAAkB;;;;;AAMxB,MAAM,qBAAqB,CAAC,QAAQ;AAClC,QAAO,IAAI,WAAW,8BAA8B,OAAO;AAC5D;;;;;;AAOD,MAAM,aAAa,CAAC,KAAK,OAAO;AAC9B,SAAQ,IAAI,MAAM,IAAI,OAAO,mBAAmB,GAAG,EAAE,MAAM,IAAI,CAAE,GAAE;AACpE;;AAGD,MAAM,iBAAiB;CAErB,YAAY;CAGZ,wBAAwB;CAGxB,sBAAsB;CAEtB,+BAA+B;CAG/B,uBAAuB;CAGvB,cAAc;CAId,2BAA2B;CAG3B,YAAY;CAGZ,kBAAkB;CAGlB,0BAA0B;CAC1B,2BAA2B;CAG3B,iBAAiB;AAClB;;AAGD,MAAM,yBAAyB;CAC7B,GAAG;CACH,uCAAuC;CACvC,qBAAqB;CACrB,UAAU;CACV,yBAAyB;CACzB,QAAQ,CACN,SAAS,QACV;CACD,MAAM,CACJ,SAAS,OACV;CACD,QAAQ;AACT;;;;;;;;AASD,MAAM,eAAe,CAAC,SAAS;CAC7B,MAAM,aAAa,WAAW,MAAM,KAAK;CAEzC,MAAM,WAAW,aACf,KAAK,MAAM,KAAK,YAAY,KAAK,GAAG,EAAE,CAAC,SACvC,KAAK;AAEP,QAAO,CACL,YAAY,QACb;AACF;AAED,4BAAe,aAAa,CAAC,EAC3B,SACA,aACA,QACA,OACD,KAAK;AACJ,KAAI,OAAO,IAAI,OAAO,SAAS,QAAQ,EAAE;EACvC,OACE,mHAEA,MACA;GACE,QAAQ;GACR,MAAM;EACP,EACF;AAED;CACD;AAED,KAAI,CAAC,YAAY,IAAI,iCAAiC,EACpD,YAAY,IAAI,kDAAkC,IAAI,MAAM;CAG9D,MAAM,sBACJ,YAAY,IAAI,iCAAiC;CAGnD,MAAM,UAAU,QAAQ,QAAQ,MAAM,CAAE;CACxC,IAAI,EACF,mBAAmB,MACnB,yBAAyB,MAC1B,GAAG;CACJ,MAAM,EACJ,oBAAoB,MACpB,aAAa,CAAE,GACf,kBAAkB,OAClB,gBAAgB,OAChB,gBAAgB,MAChB,cAAc,OACd,kBAAkB,OAClB,YACA,mBAAmB,MACnB,2BAA2B,MAC3B,yBAAyB,MACzB,6BAA6B,MAC7B,wBAAwB,OACxB,eAAe,GACf,gCAAgC,MACjC,GAAG;;;;CAMJ,MAAM,YAAY,CAAE;CAEpB,MAAM,UAAU,wBAAwB,SAAY;CAEpD,MAAM,kBAAkB,wBAAwB,SAAY;AAE5D,KAAI,kBACF,mBAAmB,MAAM,mBAAmB,iBAAiB;AAG/D,KAAI,wBACF,yBAAyB,MAAM,mBAAmB,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;CAyB3E,MAAM,cAAc,CAAC,EACnB,OAAO,GACP,iBACA,UACA,QAAQ,GACR,QAAQ,iBACR,UACA,QACA,UAAU,CAAE,GACZ,MAAM,EACJ,MAAM,EACP,GACD,eACD,KAAK;AACJ,MAAI,CAAC,UACH,QAAQ,KAAK;GACX,oBAAoB;GACpB,qBAAqB;GACrB,QAAQ;EACT,EAAC;;;;;;;;EAUJ,MAAM,aAAa,SAAU,EAC3B,oBACA,qBACA,QACD,EAAE;GACD,MAAM,YAAY;IAChB;IACA;IACA;IACA;IACA;IACA;IACA,aAAa;GACd;GACD,MAAM,eAAe,KAAK,UAAU,UAAU;GAE9C,MAAM,MAAM,eACV,OAAO,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,aAAa,MAAM,CAAC,EAAE,OAAO,KAAK,GAC1E;GAGF,MAAM,iBAAiB,WACrB,MAAM,eAAe,WACrB,MAAM,eAAe;GACvB,MAAM,OAAO,YAAY;GACzB,IAAI;AACJ,OAAI,oBAAoB,IAAI,eAAe,EACzC,UAAU,oBAAoB,IAAI,eAAe;QAC5C;IACL,MAAM,MAAM,IAAI,UAAU;IAC1B,IAAI;AACJ,QAAI,YAAY,eACd,SAAS,IAAI,iBAAiB,KAAK;IAMrC,UAAU,IAAI,UAAU;KACtB;KACA,YAAY;MACV,GAAG;MACH,GAAG;KACJ;KACD;KACA;KACA;KACA;KACA,aAAa;IACd;IACD,oBAAoB,IAAI,gBAAgB,QAAQ;GACjD;GAED,MAAM,EACJ,SAAS,CACP,EACE,UACD,CACF,EACF,GAAG,QAAQ,cAAc,IAAI;AAE9B,OAAI,EAAE,UAAU,MACd,IAAI,OAAO,IAAI,OAAO,GAAG;GAI3B,MAAM,gBAIqB,IAAK,OAAO;GACvC,MAAM,eAAe;AAErB,QAAK,MAAM,EACT,QACA,MACA,SACA,QACA,UACD,IAAI,UAAU;IACb,MAAM,YAAY,gBAAgB,OAAO;IACzC,MAAM,WAAW,gBAGf,QAAQ,IAAI,qBAAqB,wBAAwB,qBACvD;IAEJ,OACE,MAAM,gBAAgB,OAAO,aAAa,IAAI,UAAU,cACrD,SAAS,OAAO,SAAS,MAAM,MAAM,OACtC,SACF,MACA;KACE,QAAQ;KACR,MAAM;IACP,EACF;GACF;EACF;AAED,OAAK,MAAM,gBAAgB,SACzB,WAAW,aAAa;CAE3B;;;;;;;;;CAUD,MAAM,kBAAkB,CAAC,UAAU,MAAM,cAAc;EACrD,IAAI;AACJ,MAAI,CAAC,UAAU;GACb,MAAM,aAAa,QAAQ,aAAa;AACxC,OAAI,OAAO,eAAe,YAAY,WAAW,SAAS,IAAI,EAC5D,kBAAkB,WAAW,QAAQ,aAAa,CAAC,CAAC,EAAE,KAAK,CAAC;QAE5D,kBAAkB,CAAC,MAAM,EAAE,KAAK;EAEnC;AAED,SAAO;GACL;GACA;EACD;CACF;AAED,KAAI,eAAe;EACjB,MAAM,eAAe,gBAAgB,0BAA0B,iBAAiB;EAChF,MAAM,oBAAoB,WAAW,CAAC,KAAK,kBAAkB;AAC3D,OAAI,CAAC,IAAI,YAAY,MAAM,CACzB;GAGF,YAAY;IACV,QAAQ,CAAC,CAAC,EAAE,MAAM,kBAAkB,IAAI,CAAC,CAAC,CAAC;IAC3C;IACA,GAAG;GACJ,EAAC;EACH,EAAC;CACH;AAED,KAAI,aAAa;EACf,MAAM,eAAe,gBAAgB,wBAAwB,eAAe;EAC5E,MAAM,oBAAoB,SAAS,CAAC,KAAK,kBAAkB;AACzD,OAAI,CAAC,IAAI,WAAW,CAAC,IAAI,QAAQ,MAAM,CACrC;GAGF,YAAY;IACV,QAAQ,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,CAAC;IAC1B;IACA,GAAG;GACJ,EAAC;EACH,EAAC;CACH;AAED,KAAI,iBAAiB;EACnB,MAAM,eAAe,gBAAgB,4BAA4B,mBAAmB;EACpF,MAAM,oBAAoB,YAAY,CAAC,KAAK,kBAAkB;AAC5D,OAAI,CAAC,IAAI,WAAW,CAAC,IAAI,QAAQ,MAAM,CACrC;GAGF,YAAY;IACV,QAAQ,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,CAAC;IAC1B;IACA,GAAG;GACJ,EAAC;EACH,EAAC;CACH;CAED,MAAM,UAAiC,MAAM,oBAAoB,EAC/D,SAAS,UACV,EAAC;AACF,KAAI,CAAC,MAAM,OAAO,QAAQ,CACxB;CAGF,MAAM,uBAAuB,gBAAgB,iBAAiB;CAE9D,MAAM,oBAAoB,WAAW,CAAC,KAAK,kBAAkB;EAC3D,IAAI,SAAgC,MAAM,kBAAkB,IAAI;EAChE,MAAM,QAAQ,OAAO,MAAM,gBAAgB;AAE3C,MAAI,oBAAoB,CAAC,SAAS,CAAC,MAAM,GAAG,MAAM,GAChD,OAAO,qCAAqC,MAAM,IAAI;EAGxD,SAAS,OAAO,QAAQ,iBAAiB,GAAG;EAC5C,MAAM,CACJ,OACA,KACD,GAAG,QAAQ,aAAa,MAAM,GAAG,GAAG,CACnC,GAAG,CACJ;AAED,MAAI,oBAAoB,CAAC,iBAAiB,KAAK,OAAO,IACpD,0BAA0B,uBAAuB,KAAK,OAAO,CAE7D;EAGF,MAAM,UAAU,CAAE;EAClB,IAAI,WAAW;AACf,MAAI,kBAAkB;GACpB,IAAI,qBAAqB;GACzB,IAAI,sBAAsB;GAE1B,IAAI,gBAAgB;GACpB,IAAI,kBAAkB;GAEtB,IAAI;GACJ,iBAAiB,YAAY;AAC7B,WAAQ,cAAc,iBAAiB,KAAK,OAAO,MAAM,MAAM;IAC7D,MAAM,EACJ,KAAK,IACL,KAAK,IACL,OACD,GAAG;IAGJ,MAAM,WAAW,OAAO,MAAM,eAAe,MAAM;IAEnD,MAAM,CACJ,eACA,SACD,GAAG,aAAa,SAAS;IAE1B,IAAI;IACJ,IAAI;AACJ,QAAI,IAAI;KACN,MAAM,MAAM,GAAG,QAAQ,GAAG;KAC1B,eAAe,GAAG,MAAM,GAAG,IAAI;KAC/B,wBAAwB,WAAW,cAAc,KAAK;IACvD,OAAM;KACL,eAAe;KACf,wBAAwB;IACzB;IAED,uBAAuB,kBAAkB,gBAAgB;AAGzD,QAAI,uBAAuB;KACzB,MAAM,kBAAkB,aAAa,MAAM,aAAa,YAAY,KAAK,GAAG,EAAE,CAAC;KAE/E,sBAAsB;IACvB,OACC,sBAAsB,WAAW,aAAa;IAGhD,MAAM,SAAS,MAAM;IACrB,QAAQ,KAAK;KACX;KACA;KACA;IACD,EAAC;IACF,gBAAgB,iBAAiB;IACjC,kBAAkB,WAAW,QAAQ,KAAK;AAC1C,QAAI,CAAC,iBAAiB,OACpB;GAEH;GAED,WAAW;EACZ;EAED,YAAY;GACV;GACA;GACA,OAAO;GACP;GACA;GACA;GACA;GACA;GACA,GAAG;EACJ,EAAC;CACH,EAAC;AACH,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY;IACV,mBAAmB;KACjB,SAAS;KACT,MAAM;IACP;IACD,YAAY,EACV,MAAM,SACP;IACD,iBAAiB;KACf,SAAS;KACT,MAAM;IACP;IACD,eAAe;KACb,SAAS;KACT,MAAM;IACP;IACD,eAAe;KACb,SAAS;KACT,MAAM;IACP;IACD,aAAa;KACX,SAAS;KACT,MAAM;IACP;IACD,iBAAiB;KACf,SAAS;KACT,MAAM;IACP;IACD,YAAY,EACV,MAAM,SACP;IACD,kBAAkB,EAChB,MAAM,SACP;IACD,kBAAkB,EAChB,MAAM,SACP;IACD,0BAA0B,EACxB,MAAM,SACP;IACD,wBAAwB,EACtB,MAAM,SACP;IACD,4BAA4B,EAC1B,MAAM,SACP;IACD,uBAAuB;KACrB,SAAS;KACT,MAAM;IACP;IACD,cAAc;KACZ,SAAS;KACT,MAAM;IACP;IACD,wBAAwB,EACtB,MAAM,SACP;IACD,+BAA+B;KAC7B,SAAS;KACT,MAAM;IACP;GACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}

package/dist/rules/checkIndentation.js

@@ -1,59 +0,0 @@
-import iterateJsdoc from "../iterateJsdoc.js";
-
-//#region src/rules/checkIndentation.js
-/**
-* @param {string} str
-* @param {string[]} excludeTags
-* @returns {string}
-*/
-const maskExcludedContent = (str, excludeTags) => {
-	const regContent = new RegExp(`([ \\t]+\\*)[ \\t]@(?:${excludeTags.join("|")})(?=[ \\n])([\\w\\|\\W]*?\\n)(?=[ \\t]*\\*(?:[ \\t]*@\\w+\\s|\\/))`, "gv");
-	return str.replace(regContent, (_match, margin, code) => {
-		return (margin + "\n").repeat(code.match(/\n/gv).length);
-	});
-};
-/**
-* @param {string} str
-* @returns {string}
-*/
-const maskCodeBlocks = (str) => {
-	const regContent = /([ \t]+\*)[ \t]```[^\n]*?([\w\|\W]*?\n)(?=[ \t]*\*(?:[ \t]*(?:```|@\w+\s)|\/))/gv;
-	return str.replaceAll(regContent, (_match, margin, code) => {
-		return (margin + "\n").repeat(code.match(/\n/gv).length);
-	});
-};
-var checkIndentation_default = iterateJsdoc(({ context, jsdocNode, report, sourceCode }) => {
-	const options = context.options[0] || {};
-	const { excludeTags = ["example"] } = options;
-	const reg = /^(?:\/?\**|[ \t]*)\*[ \t]{2}/gmv;
-	const textWithoutCodeBlocks = maskCodeBlocks(sourceCode.getText(jsdocNode));
-	const text = excludeTags.length ? maskExcludedContent(textWithoutCodeBlocks, excludeTags) : textWithoutCodeBlocks;
-	if (reg.test(text)) {
-		const lineBreaks = text.slice(0, reg.lastIndex).match(/\n/gv) || [];
-		report("There must be no indentation.", null, { line: lineBreaks.length });
-	}
-}, {
-	iterateAllJsdocs: true,
-	meta: {
-		docs: {
-			description: "Reports invalid padding inside JSDoc blocks.",
-			url: "https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md#repos-sticky-header"
-		},
-		schema: [{
-			additionalProperties: false,
-			properties: { excludeTags: {
-				items: {
-					pattern: "^\\S+$",
-					type: "string"
-				},
-				type: "array"
-			} },
-			type: "object"
-		}],
-		type: "layout"
-	}
-});
-
-//#endregion
-export { checkIndentation_default as default };
-//# sourceMappingURL=checkIndentation.js.map

package/dist/rules/checkIndentation.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"checkIndentation.js","names":[],"sources":["../../src/rules/checkIndentation.js"],"sourcesContent":["import iterateJsdoc from '../iterateJsdoc.js';\n\n/**\n * @param {string} str\n * @param {string[]} excludeTags\n * @returns {string}\n */\nconst maskExcludedContent = (str, excludeTags) => {\n  const regContent = new RegExp(`([ \\\\t]+\\\\*)[ \\\\t]@(?:${excludeTags.join('|')})(?=[ \\\\n])([\\\\w\\\\|\\\\W]*?\\\\n)(?=[ \\\\t]*\\\\*(?:[ \\\\t]*@\\\\w+\\\\s|\\\\/))`, 'gv');\n\n  return str.replace(regContent, (_match, margin, code) => {\n    return (margin + '\\n').repeat(code.match(/\\n/gv).length);\n  });\n};\n\n/**\n * @param {string} str\n * @returns {string}\n */\nconst maskCodeBlocks = (str) => {\n  const regContent = /([ \\t]+\\*)[ \\t]```[^\\n]*?([\\w\\|\\W]*?\\n)(?=[ \\t]*\\*(?:[ \\t]*(?:```|@\\w+\\s)|\\/))/gv;\n\n  return str.replaceAll(regContent, (_match, margin, code) => {\n    return (margin + '\\n').repeat(code.match(/\\n/gv).length);\n  });\n};\n\nexport default iterateJsdoc(({\n  context,\n  jsdocNode,\n  report,\n  sourceCode,\n}) => {\n  const options = context.options[0] || {};\n  const /** @type {{excludeTags: string[]}} */ {\n    excludeTags = [\n      'example',\n    ],\n  } = options;\n\n  const reg = /^(?:\\/?\\**|[ \\t]*)\\*[ \\t]{2}/gmv;\n  const textWithoutCodeBlocks = maskCodeBlocks(sourceCode.getText(jsdocNode));\n  const text = excludeTags.length ? maskExcludedContent(textWithoutCodeBlocks, excludeTags) : textWithoutCodeBlocks;\n\n  if (reg.test(text)) {\n    const lineBreaks = text.slice(0, reg.lastIndex).match(/\\n/gv) || [];\n    report('There must be no indentation.', null, {\n      line: lineBreaks.length,\n    });\n  }\n}, {\n  iterateAllJsdocs: true,\n  meta: {\n    docs: {\n      description: 'Reports invalid padding inside JSDoc blocks.',\n      url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md#repos-sticky-header',\n    },\n    schema: [\n      {\n        additionalProperties: false,\n        properties: {\n          excludeTags: {\n            items: {\n              pattern: '^\\\\S+$',\n              type: 'string',\n            },\n            type: 'array',\n          },\n        },\n        type: 'object',\n      },\n    ],\n    type: 'layout',\n  },\n});\n"],"mappings":";;;;;;;;AAOA,MAAM,sBAAsB,CAAC,KAAK,gBAAgB;CAChD,MAAM,aAAa,IAAI,OAAO,CAAC,sBAAsB,EAAE,YAAY,KAAK,IAAI,CAAC,kEAAkE,CAAC,EAAE;AAElJ,QAAO,IAAI,QAAQ,YAAY,CAAC,QAAQ,QAAQ,SAAS;AACvD,UAAQ,SAAS,MAAM,OAAO,KAAK,MAAM,OAAO,CAAC,OAAO;CACzD,EAAC;AACH;;;;;AAMD,MAAM,iBAAiB,CAAC,QAAQ;CAC9B,MAAM,aAAa;AAEnB,QAAO,IAAI,WAAW,YAAY,CAAC,QAAQ,QAAQ,SAAS;AAC1D,UAAQ,SAAS,MAAM,OAAO,KAAK,MAAM,OAAO,CAAC,OAAO;CACzD,EAAC;AACH;AAED,+BAAe,aAAa,CAAC,EAC3B,SACA,WACA,QACA,YACD,KAAK;CACJ,MAAM,UAAU,QAAQ,QAAQ,MAAM,CAAE;CACxC,MAA6C,EAC3C,cAAc,CACZ,SACD,GACF,GAAG;CAEJ,MAAM,MAAM;CACZ,MAAM,wBAAwB,eAAe,WAAW,QAAQ,UAAU,CAAC;CAC3E,MAAM,OAAO,YAAY,SAAS,oBAAoB,uBAAuB,YAAY,GAAG;AAE5F,KAAI,IAAI,KAAK,KAAK,EAAE;EAClB,MAAM,aAAa,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,OAAO,IAAI,CAAE;EACnE,OAAO,iCAAiC,MAAM,EAC5C,MAAM,WAAW,OAClB,EAAC;CACH;AACF,GAAE;CACD,kBAAkB;CAClB,MAAM;EACJ,MAAM;GACJ,aAAa;GACb,KAAK;EACN;EACD,QAAQ,CACN;GACE,sBAAsB;GACtB,YAAY,EACV,aAAa;IACX,OAAO;KACL,SAAS;KACT,MAAM;IACP;IACD,MAAM;GACP,EACF;GACD,MAAM;EACP,CACF;EACD,MAAM;CACP;AACF,EAAC"}