eslint-plugin-complete 1.0.0

package/dist/configs/recommended.js

@@ -0,0 +1,63 @@
+/// THIS FILE IS AUTOMATICALLY GENERATED BY THE "generate.ts" SCRIPT.
+/// DO NOT EDIT THIS FILE! YOU CAN REGENERATE IT WITH:
+/// npm run generate
+export const recommended = [
+    {
+        plugins: {},
+        rules: {
+            eqeqeq: "off",
+            "no-useless-return": "off",
+            "no-template-curly-in-string": "off",
+            "prefer-const": "off",
+            "complete/complete-sentences-jsdoc": "error",
+            "complete/complete-sentences-line-comments": "error",
+            "complete/consistent-enum-values": "error",
+            "complete/consistent-named-tuples": "error",
+            "complete/eqeqeq-fix": "error",
+            "complete/format-jsdoc-comments": "error",
+            "complete/format-line-comments": "error",
+            "complete/jsdoc-code-block-language": "error",
+            "complete/newline-between-switch-case": "error",
+            "complete/no-confusing-set-methods": "error",
+            "complete/no-empty-jsdoc": "error",
+            "complete/no-empty-line-comments": "error",
+            "complete/no-explicit-array-loops": "error",
+            "complete/no-explicit-map-set-loops": "error",
+            "complete/no-for-in": "error",
+            "complete/no-let-any": "error",
+            "complete/no-mutable-return": "error",
+            "complete/no-number-enums": "error",
+            "complete/no-object-any": "error",
+            "complete/no-object-methods-with-map-set": "error",
+            "complete/no-string-length-0": "error",
+            "complete/no-template-curly-in-string-fix": "error",
+            "complete/no-undefined-return-type": "error",
+            "complete/no-unnecessary-assignment": "error",
+            "complete/no-unsafe-plusplus": "error",
+            "complete/no-useless-return": "error",
+            "complete/no-void-return-type": "error",
+            "complete/prefer-const": "error",
+            "complete/prefer-plusplus": "error",
+            "complete/prefer-postfix-plusplus": "error",
+            "complete/prefer-readonly-parameter-types": "error",
+            "complete/require-break": "error",
+            "complete/require-capital-const-assertions": "error",
+            "complete/require-capital-read-only": "error",
+            "complete/require-unannotated-const-assertions": "error",
+            "complete/require-variadic-function-argument": "error",
+            "complete/strict-array-methods": "error",
+            "complete/strict-enums": "error",
+            "complete/strict-undefined-functions": "error",
+            "complete/strict-void-functions": "error",
+        },
+    },
+    {
+        files: ["**/*.js", "**/*.cjs", "**/*.mjs", "**/*.jsx"],
+        rules: {
+            "complete/no-let-any": "off",
+            "complete/no-object-any": "off",
+            "complete/require-capital-const-assertions": "off",
+            "complete/require-capital-read-only": "off",
+        },
+    },
+];

package/dist/configs.d.ts

@@ -0,0 +1,4 @@
+export declare const configs: {
+    recommended: import("@typescript-eslint/utils/ts-eslint").FlatConfig.ConfigArray;
+};
+//# sourceMappingURL=configs.d.ts.map

package/dist/configs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"configs.d.ts","sourceRoot":"","sources":["../src/configs.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO;;CAEnB,CAAC"}

package/dist/configs.js

@@ -0,0 +1,4 @@
+import { recommended } from "./configs/recommended.js";
+export const configs = {
+    recommended,
+};

package/dist/constants.d.ts

@@ -0,0 +1,8 @@
+/**
+ * From: https://www.w3schools.com/js/js_reserved.asp
+ *
+ * - Some words that would not typically start a line are manually removed.
+ * - `console` is added.
+ */
+export declare const JAVASCRIPT_RESERVED_WORDS_SET: ReadonlySet<string>;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,6BAA6B,EAAE,WAAW,CAAC,MAAM,CAkE5D,CAAC"}

package/dist/constants.js

@@ -0,0 +1,73 @@
+/**
+ * From: https://www.w3schools.com/js/js_reserved.asp
+ *
+ * - Some words that would not typically start a line are manually removed.
+ * - `console` is added.
+ */
+export const JAVASCRIPT_RESERVED_WORDS_SET = new Set([
+    "abstract",
+    // "arguments",
+    "await",
+    // "boolean",
+    "break",
+    // "byte",
+    "case",
+    "catch",
+    // "char",
+    "class",
+    "console", // Manually added.
+    "const",
+    "continue",
+    "debugger",
+    // "default",
+    // "delete",
+    "do",
+    // "double",
+    "else",
+    "enum",
+    // "eval",
+    "export",
+    // "extends",
+    // "false",
+    // "final",
+    "finally",
+    // - "float",
+    "for",
+    "function",
+    "goto",
+    "if",
+    // "implements",
+    "import",
+    // "in",
+    // "instanceof",
+    // "int",
+    "interface",
+    "let",
+    // "long",
+    // "native",
+    "new",
+    // "null",
+    // "package",
+    "private",
+    "protected",
+    "public",
+    "return",
+    // "short",
+    "static",
+    "super",
+    "switch",
+    // "synchronized",
+    // "this",
+    "throw",
+    // "throws",
+    // "transient",
+    // "true",
+    "try",
+    // "typeof",
+    // "var",
+    // "void",
+    // "volatile",
+    "while",
+    // "with",
+    "yield",
+]);

package/dist/format.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Feed this function a string that contains one or more lines of text. It will combine all of the
+ * lines and return a string with lines that do not exceed the maximum line length.
+ *
+ * For obvious reasons, this function works best on text that is composed of complete sentences.
+ * Otherwise, it would incorrectly combine together two disparate sentences.
+ *
+ * This function tries to be as smart as possible in that it will not merge specific kinds of lines,
+ * like bullet points, "eslint-disable" comments, and so on.
+ *
+ * @param text One or more lines of text, separated by newlines.
+ * @param maxLength The ruler cutoff for the formatted text.
+ * @param shouldParseJSDocTags Whether to make formatting decisions based on the presence of JSDoc
+ *                             tags. True by default. Pass false if working with leading line
+ *                             comments or other non-JSDoc text.
+ */
+export declare function formatText(text: string, maxLength: number, shouldParseJSDocTags?: boolean): string;
+//# sourceMappingURL=format.d.ts.map

package/dist/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AASA;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,UAAU,CACxB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,oBAAoB,UAAO,GAC1B,MAAM,CAyRR"}

package/dist/format.js

@@ -0,0 +1,246 @@
+import { isEnumBlockLabel, isSeparatorLine, isSpecialComment, } from "./comments.js";
+import { ListKind, getAdjustedList, reachedNewList } from "./list.js";
+import { hasURL } from "./utils.js";
+/**
+ * Feed this function a string that contains one or more lines of text. It will combine all of the
+ * lines and return a string with lines that do not exceed the maximum line length.
+ *
+ * For obvious reasons, this function works best on text that is composed of complete sentences.
+ * Otherwise, it would incorrectly combine together two disparate sentences.
+ *
+ * This function tries to be as smart as possible in that it will not merge specific kinds of lines,
+ * like bullet points, "eslint-disable" comments, and so on.
+ *
+ * @param text One or more lines of text, separated by newlines.
+ * @param maxLength The ruler cutoff for the formatted text.
+ * @param shouldParseJSDocTags Whether to make formatting decisions based on the presence of JSDoc
+ *                             tags. True by default. Pass false if working with leading line
+ *                             comments or other non-JSDoc text.
+ */
+export function formatText(text, maxLength, shouldParseJSDocTags = true) {
+    // First, replace any whitespace that is not a newline or a space with a space (like e.g. tabs).
+    text = text.replaceAll(/[^\S\n ]+/g, " ");
+    let formattedText = "";
+    let formattedLine = "";
+    let insideList;
+    let insideCodeBlock = false;
+    let insideExampleTagBlock = false;
+    let encounteredJSDocTags = false;
+    const lines = text.split("\n");
+    for (const [i, line] of lines.entries()) {
+        // Gather information about this line.
+        const lineIsBlank = line.trim() === "";
+        const hasCodeBlock = line.includes("```");
+        const previousLineInsideCodeBlock = insideCodeBlock;
+        if (hasCodeBlock) {
+            insideCodeBlock = !insideCodeBlock;
+        }
+        const previousLineInsideExampleTagBlock = insideExampleTagBlock;
+        if (shouldParseJSDocTags) {
+            const hasExampleTag = line.includes("@example");
+            if (hasExampleTag) {
+                insideExampleTagBlock = true;
+            }
+            else if (insideExampleTagBlock && line.trimStart().startsWith("@")) {
+                insideExampleTagBlock = false;
+            }
+        }
+        const lineHasURL = hasURL(line);
+        const hasExample = startsWithExample(line);
+        const separatorLine = isSeparatorLine(line);
+        const specialComment = isSpecialComment(line);
+        const enumBlockLabel = isEnumBlockLabel(line);
+        const beginsWithPipe = line.trimStart().startsWith("|");
+        // Gather information about the previous line.
+        const previousLine = lines[i - 1];
+        const previousLineWasBlank = previousLine === undefined || previousLine.trim() === "";
+        const previousLineHasCodeBlock = previousLine !== undefined && previousLine.includes("```");
+        const previousLineHadURL = previousLine !== undefined && hasURL(previousLine);
+        const previousLineEndedInColon = previousLine !== undefined && previousLine.trimEnd().endsWith(":");
+        const previousLineWasSeparatorLine = previousLine !== undefined && isSeparatorLine(previousLine);
+        const previousLineWasEnumBlockLabel = previousLine !== undefined && isEnumBlockLabel(previousLine);
+        // Handle blank lines.
+        if (lineIsBlank) {
+            // Append the partial line that we were building, if any.
+            [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+            // Append the blank line, but ignore multiple blank lines in a row (unless we are inside of a
+            // code block).
+            const lastCharacter = formattedText.at(-1);
+            if ((lastCharacter !== undefined && lastCharacter !== "\n") ||
+                insideCodeBlock) {
+                formattedText += "\n";
+            }
+            insideList = undefined;
+            continue;
+        }
+        // Handle code blocks. This case is simple because we need to exactly preserve the text.
+        if (hasCodeBlock ||
+            previousLineHasCodeBlock ||
+            insideCodeBlock ||
+            insideExampleTagBlock) {
+            // Append the partial line that we were building, if any.
+            [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+            // Enforce newlines before the beginning of code blocks. (But not inside of an example code
+            // block, because there should not be newlines between tags.)
+            if (hasCodeBlock &&
+                !previousLineInsideCodeBlock &&
+                !previousLineWasBlank &&
+                !insideExampleTagBlock) {
+                formattedText += "\n";
+            }
+            // Copy the line exactly.
+            formattedLine += line;
+            // Enforce newlines after the end of code blocks. (But not inside of an example code block,
+            // because there should not be newlines between tags.)
+            const nextLine = lines[i + 1];
+            const nextLineIsBlank = nextLine === undefined || nextLine.trim() === "";
+            if (hasCodeBlock &&
+                previousLineInsideCodeBlock &&
+                !nextLineIsBlank &&
+                !insideExampleTagBlock) {
+                // Append the partial line that we were building, if any.
+                [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+                formattedText += "\n";
+            }
+            insideList = undefined;
+            continue;
+        }
+        // Handle lines that begin with a pipe, which indicate a Markdown table. This case is simple
+        // because we need to exactly preserve the text.
+        if (beginsWithPipe) {
+            // Append the partial line that we were building, if any.
+            [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+            // Copy the line exactly.
+            formattedLine += line;
+            continue;
+        }
+        // Handle special comments.
+        if (specialComment) {
+            // Append the partial line that we were building, if any.
+            [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+            // Copy the line exactly.
+            formattedLine += line;
+            [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+            continue;
+        }
+        // Handle lists. (JSDoc tags also count as lists.)
+        const list = getAdjustedList(line, previousLineWasBlank, previousLineEndedInColon, insideList);
+        if (reachedNewList(insideList, list)) {
+            // Keep track that we have begun a list (or a new sub-list).
+            insideList = list;
+        }
+        // Lists and some other specific text elements indicate that we should always insert a new line,
+        // even if the text has no wrapped to the end of the ruler yet.
+        if (list !== undefined ||
+            lineHasURL ||
+            previousLineHadURL ||
+            hasExample ||
+            separatorLine ||
+            previousLineWasSeparatorLine ||
+            enumBlockLabel ||
+            previousLineWasEnumBlockLabel) {
+            // Append the partial line that we were building, if any.
+            [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+        }
+        // Keep track of when we first encounter JSDoc tags. (JSDoc comments can be thought of as having
+        // an "description" or "introductory" section at the top, and then a list of JSDoc tags at the
+        // bottom.)
+        if (shouldParseJSDocTags &&
+            !encounteredJSDocTags &&
+            list !== undefined &&
+            list.kind === ListKind.JSDocTag) {
+            encounteredJSDocTags = true;
+            // Enforce a newline between a JSDoc description (i.e. introductory text) and the first JSDoc
+            // tag.
+            if (!stringContainsOnlyWhitespace(formattedText) &&
+                !previousLineWasBlank &&
+                !previousLineInsideExampleTagBlock) {
+                // Append the partial line that we were building, if any.
+                [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+                formattedText += "\n";
+            }
+        }
+        const words = getWordsFromLine(line);
+        for (const word of words) {
+            // Words can be blank strings in certain cases. For example: "dog cat"
+            if (word === "") {
+                continue;
+            }
+            // Handle splitting to a new line.
+            const splitToNewLine = shouldSplitToNewLine(formattedLine, word, maxLength);
+            if (splitToNewLine) {
+                // Append the partial line that we were building, if any.
+                [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+                // Overflowed lists should be indented so that the list items can be more easily
+                // distinguished.
+                if (insideList !== undefined) {
+                    // It is possible for JSDoc comments to have really long variable names, which would make
+                    // the indent be really big. Thus, we arbitrarily hard-cap the effective marker size at a
+                    // third of the width of the remaining space.
+                    const amountOfSpacesToWorkWith = maxLength - insideList.numLeadingSpaces;
+                    const thirdOfRemainingSpace = Math.floor(amountOfSpacesToWorkWith / 3);
+                    const effectiveMarkerSize = Math.min(insideList.markerSize, thirdOfRemainingSpace);
+                    // We subtract one since we will add an extra space below when adding the first word.
+                    const numSpacesToAdd = insideList.numLeadingSpaces + effectiveMarkerSize - 1;
+                    formattedLine += " ".repeat(numSpacesToAdd);
+                }
+            }
+            // Add the word. (`numLeadingSpaces` will be set if this is a line with a sub-bullet point.)
+            const atBeginningOfLine = formattedLine === "";
+            const numLeadingSpaces = list === undefined ? 0 : list.numLeadingSpaces;
+            const leadingSpaces = " ".repeat(numLeadingSpaces);
+            const textToAdd = atBeginningOfLine
+                ? `${leadingSpaces}${word}`
+                : ` ${word}`;
+            formattedLine += textToAdd;
+        }
+    }
+    // Append the partial line that we were building, if any.
+    // eslint-disable-next-line no-useless-assignment
+    [formattedLine, formattedText] = appendLineToText(formattedLine, formattedText);
+    return formattedText;
+}
+/**
+ * We split to a new line if:
+ * 1. adding the word would make it overflow past the maximum length
+ * 2. and there is at least one word on the current line
+ *
+ * For example, there could be a very long URL that exceeds the maximum length, but since there are
+ * no spaces in the URL, it can't be split up and has to exceed the maximum length.
+ */
+function shouldSplitToNewLine(formattedLine, word, effectiveLength) {
+    const atBeginningOfLine = formattedLine === "";
+    const textToAdd = atBeginningOfLine ? word : ` ${word}`;
+    const lineLengthIfAdded = formattedLine.length + textToAdd.length;
+    return lineLengthIfAdded > effectiveLength && !atBeginningOfLine;
+}
+function appendLineToText(formattedLine, formattedText) {
+    if (formattedLine !== "") {
+        if (formattedText !== "") {
+            formattedText += "\n";
+        }
+        formattedText += formattedLine;
+        formattedLine = "";
+    }
+    return [formattedLine, formattedText];
+}
+function startsWithExample(text) {
+    const trimmedText = text.trimStart();
+    return (trimmedText.startsWith("e.g. ") ||
+        trimmedText.startsWith("(e.g. ") ||
+        trimmedText.startsWith("i.e. ") ||
+        trimmedText.startsWith("(i.e. "));
+}
+function stringContainsOnlyWhitespace(string) {
+    return string.trim() === "";
+}
+/**
+ * For most cases, we can get the words on a line by splitting on a space.
+ *
+ * However, we don't want to split up a fragment like "{@link foo}" between lines, because it breaks
+ * the parsing inside VSCode. Thus, anything matching this pattern should be considered its own
+ * word, even if it has spaces inside of it.
+ */
+function getWordsFromLine(line) {
+    return line.match(/(?:{@link .+?}|\S)+/g) ?? [];
+}

package/dist/index.d.ts

@@ -0,0 +1,60 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+declare const plugin: {
+    meta: {
+        name: unknown;
+        version: unknown;
+    };
+    configs: {
+        recommended: TSESLint.FlatConfig.ConfigArray;
+    };
+    rules: {
+        "complete-sentences-jsdoc": TSESLint.RuleModule<import("./completeSentence.js").CompleteSentenceMessageIds, [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "complete-sentences-line-comments": TSESLint.RuleModule<import("./completeSentence.js").CompleteSentenceMessageIds, [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "consistent-enum-values": TSESLint.RuleModule<"inconsistentValue", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "consistent-named-tuples": TSESLint.RuleModule<"notNamed", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "eqeqeq-fix": TSESLint.RuleModule<"unexpected", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "format-jsdoc-comments": TSESLint.RuleModule<"incorrectlyFormatted", import("./rules/format-jsdoc-comments.js").Options, import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "format-line-comments": TSESLint.RuleModule<"incorrectlyFormatted", import("./rules/format-line-comments.js").Options, import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "jsdoc-code-block-language": TSESLint.RuleModule<"noLanguage", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "newline-between-switch-case": TSESLint.RuleModule<"noNewline", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-confusing-set-methods": TSESLint.RuleModule<"noKeys" | "noEntries", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-empty-jsdoc": TSESLint.RuleModule<"isEmpty", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-empty-line-comments": TSESLint.RuleModule<"isEmpty", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-explicit-array-loops": TSESLint.RuleModule<"noExplicitArray", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-explicit-map-set-loops": TSESLint.RuleModule<"noExplicitMap" | "noExplicitSet", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-for-in": TSESLint.RuleModule<"noForIn", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-let-any": TSESLint.RuleModule<"noType", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-mutable-return": TSESLint.RuleModule<"mutableArray" | "mutableMap" | "mutableSet", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-number-enums": TSESLint.RuleModule<"noNumberEnums", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-object-any": TSESLint.RuleModule<"noType", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-object-methods-with-map-set": TSESLint.RuleModule<"noObjectEntriesMap" | "noObjectKeysMap" | "noObjectValuesMap" | "noObjectEntriesSet" | "noObjectKeysSet" | "noObjectValuesSet", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-string-length-0": TSESLint.RuleModule<"noStringLength0", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-template-curly-in-string-fix": TSESLint.RuleModule<"unexpectedTemplateExpression", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-undefined-return-type": TSESLint.RuleModule<"undefinedReturnType", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-unnecessary-assignment": TSESLint.RuleModule<import("./rules/no-unnecessary-assignment.js").MessageIds, [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-unsafe-plusplus": TSESLint.RuleModule<"plusPlus" | "minusMinus", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-useless-return": TSESLint.RuleModule<"unnecessaryReturn", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "no-void-return-type": TSESLint.RuleModule<"voidReturnType", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "prefer-const": TSESLint.RuleModule<"useConst", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "prefer-plusplus": TSESLint.RuleModule<import("./rules/prefer-plusplus.js").MessageIds, [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "prefer-postfix-plusplus": TSESLint.RuleModule<"plusPlus" | "minusMinus", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "prefer-readonly-parameter-types": TSESLint.RuleModule<"shouldBeReadonly", [{
+            allow?: import("@typescript-eslint/type-utils").TypeOrValueSpecifier[];
+            checkParameterProperties?: boolean;
+            ignoreInferredTypes?: boolean;
+            treatMethodsAsReadonly?: boolean;
+            onlyRecordsArraysMapsSet?: boolean;
+        }], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "require-break": TSESLint.RuleModule<"noBreak", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "require-capital-const-assertions": TSESLint.RuleModule<"noConstAssertion", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "require-capital-read-only": TSESLint.RuleModule<import("./rules/require-capital-read-only.js").MessageIds, [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "require-unannotated-const-assertions": TSESLint.RuleModule<"annotatedConstAssertion", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "require-variadic-function-argument": TSESLint.RuleModule<"noArgument", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "strict-array-methods": TSESLint.RuleModule<"conditionError", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "strict-enums": TSESLint.RuleModule<import("./rules/strict-enums.js").MessageIds, [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "strict-undefined-functions": TSESLint.RuleModule<"mismatchedReturnType", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+        "strict-void-functions": TSESLint.RuleModule<"mismatchedReturnType", [], import("./interfaces/MyPluginDocs.js").MyPluginDocs, TSESLint.RuleListener>;
+    };
+};
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AASzD,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAOX,CAAC;AAIF,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,49 @@
+import fs from "node:fs";
+import path from "node:path";
+import { configs } from "./configs.js";
+import { rules } from "./rules.js";
+const { name, version } = getPackageJSON();
+const plugin = {
+    meta: {
+        name,
+        version,
+    },
+    configs,
+    rules,
+};
+addPluginToConfigs(configs, name);
+export default plugin;
+/**
+ * We parse the package JSON manually since importing JSON files directly in Node is experimental.
+ */
+function getPackageJSON() {
+    const packageRoot = path.join(import.meta.dirname, "..");
+    const packageJSONPath = path.join(packageRoot, "package.json");
+    try {
+        const packageJSONString = fs.readFileSync(packageJSONPath, "utf8");
+        return JSON.parse(packageJSONString);
+    }
+    catch (error) {
+        throw new Error(`Failed to read the "${packageJSONPath}" file: ${error}`);
+    }
+}
+/** @see https://eslint.org/docs/latest/extend/plugins#configs-in-plugins */
+function addPluginToConfigs(configsToMutate, packageName) {
+    if (typeof packageName !== "string") {
+        throw new TypeError('Failed to parse the plugin name from the "package.json" file.');
+    }
+    const packageNameWords = packageName.split("-");
+    const pluginName = packageNameWords.at(-1);
+    if (pluginName === undefined || pluginName === "") {
+        throw new Error("Failed to parse the plugin name from the package name.");
+    }
+    for (const configArray of Object.values(configsToMutate)) {
+        for (const config of configArray) {
+            if (config.plugins !== undefined) {
+                Object.assign(config.plugins, {
+                    [pluginName]: plugin,
+                });
+            }
+        }
+    }
+}

package/dist/interfaces/MyPluginDocs.d.ts

@@ -0,0 +1,6 @@
+/** @see https://typescript-eslint.io/developers/custom-rules#extra-rule-docs-types */
+export interface MyPluginDocs {
+    recommended: boolean;
+    requiresTypeChecking: boolean;
+}
+//# sourceMappingURL=MyPluginDocs.d.ts.map

package/dist/interfaces/MyPluginDocs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MyPluginDocs.d.ts","sourceRoot":"","sources":["../../src/interfaces/MyPluginDocs.ts"],"names":[],"mappings":"AAAA,sFAAsF;AACtF,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,OAAO,CAAC;IACrB,oBAAoB,EAAE,OAAO,CAAC;CAC/B"}

package/dist/interfaces/MyPluginDocs.js

@@ -0,0 +1 @@
+export {};

package/dist/jsdoc.d.ts

@@ -0,0 +1,4 @@
+import { TSESTree } from "@typescript-eslint/utils";
+export declare function getJSDocComments(comments: readonly TSESTree.Comment[]): readonly TSESTree.Comment[];
+export declare function getTextFromJSDocComment(comment: string): string;
+//# sourceMappingURL=jsdoc.d.ts.map

package/dist/jsdoc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsdoc.d.ts","sourceRoot":"","sources":["../src/jsdoc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,SAAS,QAAQ,CAAC,OAAO,EAAE,GACpC,SAAS,QAAQ,CAAC,OAAO,EAAE,CAM7B;AAED,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAuB/D"}

package/dist/jsdoc.js

@@ -0,0 +1,24 @@
+import { TSESTree } from "@typescript-eslint/utils";
+export function getJSDocComments(comments) {
+    return comments.filter((comment) => comment.type === TSESTree.AST_TOKEN_TYPES.Block && // i.e. a "/*" comment
+        comment.value.startsWith("*"));
+}
+export function getTextFromJSDocComment(comment) {
+    comment = comment.trim();
+    const lines = comment.split("\n");
+    const linesWithRemovedAsterisks = lines.map((line) => {
+        // First, if the line contains only spaces and/or asterisks, it can be deleted.
+        if (/^[\s*]*$/.test(line)) {
+            return "";
+        }
+        // We have to be careful not to trim all of the whitespace from the line here because whitespace
+        // must be preserved while inside of code blocks.
+        line = line.replace(/^\s*\* /, "");
+        // Remove any duplicate asterisks, like "* * Foo".
+        while (line.startsWith("* ")) {
+            line = line.replace(/^\* /, "");
+        }
+        return line;
+    });
+    return linesWithRemovedAsterisks.join("\n").trim();
+}

package/dist/leadingLineComments.d.ts

@@ -0,0 +1,32 @@
+import type { TSESLint } from "@typescript-eslint/utils";
+import { TSESTree } from "@typescript-eslint/utils";
+export declare function getLeadingLineComments(sourceCode: TSESLint.SourceCode, comments: readonly TSESTree.Comment[]): readonly TSESTree.Comment[];
+/**
+ * An object containing one or more contiguous leading line comments. For example:
+ *
+ * ```ts
+ * // The first line of the block.
+ * // The second line of the block.
+ * ```
+ */
+interface LeadingLineCommentBlock {
+    mergedText: string;
+    originalComments: TSESTree.Comment[];
+}
+/**
+ * Returns an array of grouped comments. For example, the following code would return an array of
+ * three comment blocks:
+ *
+ * ```ts
+ * // This is the first block.
+ *
+ * // This is the second block.
+ * // We are still in the second block, because there has not been a newline separator yet.
+ *
+ * // This is the third block.
+ * ```
+ */
+export declare function getCommentBlocks(comments: readonly TSESTree.Comment[]): readonly LeadingLineCommentBlock[];
+export declare function allCommentsInBlockAreCommentedOutArrayElements(commentBlock: LeadingLineCommentBlock): boolean;
+export {};
+//# sourceMappingURL=leadingLineComments.d.ts.map

package/dist/leadingLineComments.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"leadingLineComments.d.ts","sourceRoot":"","sources":["../src/leadingLineComments.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAGpD,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,QAAQ,CAAC,UAAU,EAC/B,QAAQ,EAAE,SAAS,QAAQ,CAAC,OAAO,EAAE,GACpC,SAAS,QAAQ,CAAC,OAAO,EAAE,CAQ7B;AAED;;;;;;;GAOG;AACH,UAAU,uBAAuB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;CACtC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,SAAS,QAAQ,CAAC,OAAO,EAAE,GACpC,SAAS,uBAAuB,EAAE,CAgEpC;AAED,wBAAgB,8CAA8C,CAC5D,YAAY,EAAE,uBAAuB,GACpC,OAAO,CAIT"}