@api-extractor-tools/eslint-plugin 0.1.0-alpha.0

package/dist/rules/missing-release-tag.js

@@ -0,0 +1,148 @@
+"use strict";
+/**
+ * ESLint rule for detecting missing release tags on exported symbols.
+ * @internal
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.missingReleaseTag = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+const utils_2 = require("../utils");
+const createRule = utils_1.ESLintUtils.RuleCreator((name) => `https://github.com/mike-north/api-extractor-tools/blob/main/tools/eslint-plugin/docs/rules/${name}.md`);
+exports.missingReleaseTag = createRule({
+    name: 'missing-release-tag',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Require exported symbols to have a release tag (@public, @beta, @alpha, or @internal)',
+        },
+        messages: {
+            missingReleaseTag: 'Exported symbol "{{name}}" is missing a release tag. Add @public, @beta, @alpha, or @internal to its TSDoc comment.',
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    configPath: {
+                        type: 'string',
+                        description: 'Path to api-extractor.json configuration file',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+    defaultOptions: [{}],
+    create(context) {
+        const options = context.options[0] ?? {};
+        const filename = context.filename;
+        const config = (0, utils_2.resolveConfig)(filename, options.configPath);
+        const logLevel = (0, utils_2.getMessageLogLevel)(config, 'ae-missing-release-tag');
+        // If configured to 'none', disable the rule
+        if (logLevel === 'none') {
+            return {};
+        }
+        const sourceCode = context.sourceCode;
+        /**
+         * Checks if a node has a release tag in its TSDoc comment.
+         */
+        function hasReleaseTag(node) {
+            const commentText = (0, utils_2.getLeadingTSDocComment)(sourceCode, node);
+            if (!commentText) {
+                return false;
+            }
+            const parsed = (0, utils_2.parseTSDocComment)(commentText);
+            if (parsed.docComment) {
+                const tag = (0, utils_2.extractReleaseTag)(parsed.docComment);
+                return tag !== undefined;
+            }
+            return false;
+        }
+        /**
+         * Gets the name of a declaration.
+         */
+        function getDeclarationName(node) {
+            if (node.type === utils_1.AST_NODE_TYPES.VariableDeclaration) {
+                const firstDeclarator = node.declarations[0];
+                if (firstDeclarator?.id.type === utils_1.AST_NODE_TYPES.Identifier) {
+                    return firstDeclarator.id.name;
+                }
+                return '<unknown>';
+            }
+            if ('id' in node && node.id) {
+                return node.id.name;
+            }
+            return '<anonymous>';
+        }
+        /**
+         * Reports a missing release tag error.
+         */
+        function reportMissingTag(node, name) {
+            context.report({
+                node,
+                messageId: 'missingReleaseTag',
+                data: { name },
+            });
+        }
+        /**
+         * Checks if a node is exported.
+         */
+        function isExported(node) {
+            const parent = node.parent;
+            // Direct export: export function foo() {}
+            if (parent?.type === utils_1.AST_NODE_TYPES.ExportNamedDeclaration) {
+                return true;
+            }
+            // Default export: export default function foo() {}
+            if (parent?.type === utils_1.AST_NODE_TYPES.ExportDefaultDeclaration) {
+                return true;
+            }
+            return false;
+        }
+        /**
+         * Checks a declaration node for missing release tag.
+         */
+        function checkDeclaration(node) {
+            if (!isExported(node)) {
+                return;
+            }
+            // For exported declarations, check the export statement for the comment
+            const exportNode = node.parent;
+            const nodeToCheck = exportNode ?? node;
+            if (!hasReleaseTag(nodeToCheck) && !hasReleaseTag(node)) {
+                const name = getDeclarationName(node);
+                reportMissingTag(node, name);
+            }
+        }
+        return {
+            // Check exported function declarations
+            FunctionDeclaration(node) {
+                checkDeclaration(node);
+            },
+            // Check exported class declarations
+            ClassDeclaration(node) {
+                checkDeclaration(node);
+            },
+            // Check exported interface declarations
+            TSInterfaceDeclaration(node) {
+                checkDeclaration(node);
+            },
+            // Check exported type alias declarations
+            TSTypeAliasDeclaration(node) {
+                checkDeclaration(node);
+            },
+            // Check exported enum declarations
+            TSEnumDeclaration(node) {
+                checkDeclaration(node);
+            },
+            // Check exported variable declarations
+            VariableDeclaration(node) {
+                checkDeclaration(node);
+            },
+            // Note: We intentionally don't handle ExportNamedDeclaration with specifiers
+            // (e.g., `export { foo }` or `export { foo } from './bar'`) because:
+            // - Re-exports should have release tags on the original declaration
+            // - Named exports reference declarations that are checked elsewhere
+        };
+    },
+});
+//# sourceMappingURL=missing-release-tag.js.map

package/dist/rules/missing-release-tag.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"missing-release-tag.js","sourceRoot":"","sources":["../../src/rules/missing-release-tag.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,oDAAgF;AAChF,oCAMiB;AAGjB,MAAM,UAAU,GAAG,mBAAW,CAAC,WAAW,CACxC,CAAC,IAAI,EAAE,EAAE,CACP,8FAA8F,IAAI,KAAK,CAC1G,CAAA;AAIY,QAAA,iBAAiB,GAAG,UAAU,CAGzC;IACA,IAAI,EAAE,qBAAqB;IAC3B,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,uFAAuF;SAC1F;QACD,QAAQ,EAAE;YACR,iBAAiB,EACf,qHAAqH;SACxH;QACD,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,+CAA+C;qBAC7D;iBACF;gBACD,oBAAoB,EAAE,KAAK;aAC5B;SACF;KACF;IACD,cAAc,EAAE,CAAC,EAAE,CAAC;IACpB,MAAM,CAAC,OAAO;QACZ,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QACxC,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QACjC,MAAM,MAAM,GAAG,IAAA,qBAAa,EAAC,QAAQ,EAAE,OAAO,CAAC,UAAU,CAAC,CAAA;QAC1D,MAAM,QAAQ,GAAG,IAAA,0BAAkB,EAAC,MAAM,EAAE,wBAAwB,CAAC,CAAA;QAErE,4CAA4C;QAC5C,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;YACxB,OAAO,EAAE,CAAA;QACX,CAAC;QAED,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QAErC;;WAEG;QACH,SAAS,aAAa,CAAC,IAAmB;YACxC,MAAM,WAAW,GAAG,IAAA,8BAAsB,EAAC,UAAU,EAAE,IAAI,CAAC,CAAA;YAC5D,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,OAAO,KAAK,CAAA;YACd,CAAC;YAED,MAAM,MAAM,GAAG,IAAA,yBAAiB,EAAC,WAAW,CAAC,CAAA;YAC7C,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;gBACtB,MAAM,GAAG,GAAG,IAAA,yBAAiB,EAAC,MAAM,CAAC,UAAU,CAAC,CAAA;gBAChD,OAAO,GAAG,KAAK,SAAS,CAAA;YAC1B,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC;QAED;;WAEG;QACH,SAAS,kBAAkB,CACzB,IAMgC;YAEhC,IAAI,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,mBAAmB,EAAE,CAAC;gBACrD,MAAM,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;gBAC5C,IAAI,eAAe,EAAE,EAAE,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;oBAC3D,OAAO,eAAe,CAAC,EAAE,CAAC,IAAI,CAAA;gBAChC,CAAC;gBACD,OAAO,WAAW,CAAA;YACpB,CAAC;YAED,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,EAAE,EAAE,CAAC;gBAC5B,OAAO,IAAI,CAAC,EAAE,CAAC,IAAI,CAAA;YACrB,CAAC;YAED,OAAO,aAAa,CAAA;QACtB,CAAC;QAED;;WAEG;QACH,SAAS,gBAAgB,CAAC,IAAmB,EAAE,IAAY;YACzD,OAAO,CAAC,MAAM,CAAC;gBACb,IAAI;gBACJ,SAAS,EAAE,mBAAmB;gBAC9B,IAAI,EAAE,EAAE,IAAI,EAAE;aACf,CAAC,CAAA;QACJ,CAAC;QAED;;WAEG;QACH,SAAS,UAAU,CAAC,IAAmB;YACrC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;YAE1B,0CAA0C;YAC1C,IAAI,MAAM,EAAE,IAAI,KAAK,sBAAc,CAAC,sBAAsB,EAAE,CAAC;gBAC3D,OAAO,IAAI,CAAA;YACb,CAAC;YAED,mDAAmD;YACnD,IAAI,MAAM,EAAE,IAAI,KAAK,sBAAc,CAAC,wBAAwB,EAAE,CAAC;gBAC7D,OAAO,IAAI,CAAA;YACb,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC;QAED;;WAEG;QACH,SAAS,gBAAgB,CACvB,IAMgC;YAEhC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtB,OAAM;YACR,CAAC;YAED,wEAAwE;YACxE,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAA;YAC9B,MAAM,WAAW,GAAG,UAAU,IAAI,IAAI,CAAA;YAEtC,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;gBACxD,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAA;gBACrC,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;YAC9B,CAAC;QACH,CAAC;QAED,OAAO;YACL,uCAAuC;YACvC,mBAAmB,CAAC,IAAI;gBACtB,gBAAgB,CAAC,IAAI,CAAC,CAAA;YACxB,CAAC;YAED,oCAAoC;YACpC,gBAAgB,CAAC,IAAI;gBACnB,gBAAgB,CAAC,IAAI,CAAC,CAAA;YACxB,CAAC;YAED,wCAAwC;YACxC,sBAAsB,CAAC,IAAI;gBACzB,gBAAgB,CAAC,IAAI,CAAC,CAAA;YACxB,CAAC;YAED,yCAAyC;YACzC,sBAAsB,CAAC,IAAI;gBACzB,gBAAgB,CAAC,IAAI,CAAC,CAAA;YACxB,CAAC;YAED,mCAAmC;YACnC,iBAAiB,CAAC,IAAI;gBACpB,gBAAgB,CAAC,IAAI,CAAC,CAAA;YACxB,CAAC;YAED,uCAAuC;YACvC,mBAAmB,CAAC,IAAI;gBACtB,gBAAgB,CAAC,IAAI,CAAC,CAAA;YACxB,CAAC;YAED,6EAA6E;YAC7E,qEAAqE;YACrE,oEAAoE;YACpE,oEAAoE;SACrE,CAAA;IACH,CAAC;CACF,CAAC,CAAA"}

package/dist/rules/override-keyword.d.ts

@@ -0,0 +1,8 @@
+/**
+ * ESLint rule requiring the TypeScript `override` keyword when `@override` TSDoc tag is used.
+ * @internal
+ */
+import { ESLintUtils } from '@typescript-eslint/utils';
+import type { OverrideKeywordRuleOptions } from '../types';
+export declare const overrideKeyword: ESLintUtils.RuleModule<"missingOverrideKeyword", [OverrideKeywordRuleOptions], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=override-keyword.d.ts.map

package/dist/rules/override-keyword.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"override-keyword.d.ts","sourceRoot":"","sources":["../../src/rules/override-keyword.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAkB,WAAW,EAAY,MAAM,0BAA0B,CAAA;AAMhF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,UAAU,CAAA;AAS1D,eAAO,MAAM,eAAe,mHAsH1B,CAAA"}

package/dist/rules/override-keyword.js

@@ -0,0 +1,106 @@
+"use strict";
+/**
+ * ESLint rule requiring the TypeScript `override` keyword when `@override` TSDoc tag is used.
+ * @internal
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.overrideKeyword = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+const utils_2 = require("../utils");
+const createRule = utils_1.ESLintUtils.RuleCreator((name) => `https://github.com/mike-north/api-extractor-tools/blob/main/tools/eslint-plugin/docs/rules/${name}.md`);
+exports.overrideKeyword = createRule({
+    name: 'override-keyword',
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Require the TypeScript `override` keyword when the `@override` TSDoc tag is present',
+        },
+        fixable: 'code',
+        messages: {
+            missingOverrideKeyword: 'Member "{{name}}" has @override TSDoc tag but is missing the TypeScript `override` keyword.',
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    configPath: {
+                        type: 'string',
+                        description: 'Path to api-extractor.json configuration file',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+    defaultOptions: [{}],
+    create(context) {
+        const sourceCode = context.sourceCode;
+        /**
+         * Checks if a node has the @override TSDoc tag.
+         */
+        function nodeHasOverrideTag(node) {
+            const commentText = (0, utils_2.getLeadingTSDocComment)(sourceCode, node);
+            if (!commentText) {
+                return false;
+            }
+            const parsed = (0, utils_2.parseTSDocComment)(commentText);
+            if (parsed.docComment) {
+                return (0, utils_2.hasOverrideTag)(parsed.docComment);
+            }
+            return false;
+        }
+        /**
+         * Checks if a method or property has the override keyword.
+         */
+        function hasOverrideModifier(node) {
+            return node.override === true;
+        }
+        /**
+         * Gets the name of a class member.
+         */
+        function getMemberName(node) {
+            if (node.key.type === utils_1.AST_NODE_TYPES.Identifier) {
+                return node.key.name;
+            }
+            if (node.key.type === utils_1.AST_NODE_TYPES.Literal) {
+                return String(node.key.value);
+            }
+            return '<computed>';
+        }
+        /**
+         * Checks a class member for missing override keyword.
+         */
+        function checkMember(node) {
+            // Skip constructors
+            if (node.type === utils_1.AST_NODE_TYPES.MethodDefinition &&
+                node.kind === 'constructor') {
+                return;
+            }
+            if (!nodeHasOverrideTag(node)) {
+                return;
+            }
+            if (hasOverrideModifier(node)) {
+                return;
+            }
+            const name = getMemberName(node);
+            context.report({
+                node,
+                messageId: 'missingOverrideKeyword',
+                data: { name },
+                fix(fixer) {
+                    // Insert override keyword at the start of the member declaration
+                    return fixer.insertTextBefore(node, 'override ');
+                },
+            });
+        }
+        return {
+            MethodDefinition(node) {
+                checkMember(node);
+            },
+            PropertyDefinition(node) {
+                checkMember(node);
+            },
+        };
+    },
+});
+//# sourceMappingURL=override-keyword.js.map

package/dist/rules/override-keyword.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"override-keyword.js","sourceRoot":"","sources":["../../src/rules/override-keyword.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,oDAAgF;AAChF,oCAIiB;AAGjB,MAAM,UAAU,GAAG,mBAAW,CAAC,WAAW,CACxC,CAAC,IAAI,EAAE,EAAE,CACP,8FAA8F,IAAI,KAAK,CAC1G,CAAA;AAIY,QAAA,eAAe,GAAG,UAAU,CAGvC;IACA,IAAI,EAAE,kBAAkB;IACxB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE;YACJ,WAAW,EACT,qFAAqF;SACxF;QACD,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACR,sBAAsB,EACpB,6FAA6F;SAChG;QACD,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,+CAA+C;qBAC7D;iBACF;gBACD,oBAAoB,EAAE,KAAK;aAC5B;SACF;KACF;IACD,cAAc,EAAE,CAAC,EAAE,CAAC;IACpB,MAAM,CAAC,OAAO;QACZ,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QAErC;;WAEG;QACH,SAAS,kBAAkB,CAAC,IAAmB;YAC7C,MAAM,WAAW,GAAG,IAAA,8BAAsB,EAAC,UAAU,EAAE,IAAI,CAAC,CAAA;YAC5D,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,OAAO,KAAK,CAAA;YACd,CAAC;YAED,MAAM,MAAM,GAAG,IAAA,yBAAiB,EAAC,WAAW,CAAC,CAAA;YAC7C,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;gBACtB,OAAO,IAAA,sBAAc,EAAC,MAAM,CAAC,UAAU,CAAC,CAAA;YAC1C,CAAC;YAED,OAAO,KAAK,CAAA;QACd,CAAC;QAED;;WAEG;QACH,SAAS,mBAAmB,CAC1B,IAA6D;YAE7D,OAAO,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAA;QAC/B,CAAC;QAED;;WAEG;QACH,SAAS,aAAa,CACpB,IAA6D;YAE7D,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU,EAAE,CAAC;gBAChD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAA;YACtB,CAAC;YACD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO,EAAE,CAAC;gBAC7C,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YAC/B,CAAC;YACD,OAAO,YAAY,CAAA;QACrB,CAAC;QAED;;WAEG;QACH,SAAS,WAAW,CAClB,IAA6D;YAE7D,oBAAoB;YACpB,IACE,IAAI,CAAC,IAAI,KAAK,sBAAc,CAAC,gBAAgB;gBAC7C,IAAI,CAAC,IAAI,KAAK,aAAa,EAC3B,CAAC;gBACD,OAAM;YACR,CAAC;YAED,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,OAAM;YACR,CAAC;YAED,IAAI,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,OAAM;YACR,CAAC;YAED,MAAM,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC,CAAA;YAEhC,OAAO,CAAC,MAAM,CAAC;gBACb,IAAI;gBACJ,SAAS,EAAE,wBAAwB;gBACnC,IAAI,EAAE,EAAE,IAAI,EAAE;gBACd,GAAG,CAAC,KAAK;oBACP,iEAAiE;oBACjE,OAAO,KAAK,CAAC,gBAAgB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAA;gBAClD,CAAC;aACF,CAAC,CAAA;QACJ,CAAC;QAED,OAAO;YACL,gBAAgB,CAAC,IAAI;gBACnB,WAAW,CAAC,IAAI,CAAC,CAAA;YACnB,CAAC;YACD,kBAAkB,CAAC,IAAI;gBACrB,WAAW,CAAC,IAAI,CAAC,CAAA;YACnB,CAAC;SACF,CAAA;IACH,CAAC;CACF,CAAC,CAAA"}

package/dist/rules/package-documentation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * ESLint rule requiring @packageDocumentation in package entry point files.
+ * @internal
+ */
+import { ESLintUtils } from '@typescript-eslint/utils';
+import type { PackageDocumentationRuleOptions } from '../types';
+export declare const packageDocumentation: ESLintUtils.RuleModule<"missingPackageDocumentation", [PackageDocumentationRuleOptions], unknown, ESLintUtils.RuleListener>;
+//# sourceMappingURL=package-documentation.d.ts.map

package/dist/rules/package-documentation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-documentation.d.ts","sourceRoot":"","sources":["../../src/rules/package-documentation.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAA;AAOtD,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,UAAU,CAAA;AAS/D,eAAO,MAAM,oBAAoB,6HAoE/B,CAAA"}

package/dist/rules/package-documentation.js

@@ -0,0 +1,70 @@
+"use strict";
+/**
+ * ESLint rule requiring @packageDocumentation in package entry point files.
+ * @internal
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packageDocumentation = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+const utils_2 = require("../utils");
+const createRule = utils_1.ESLintUtils.RuleCreator((name) => `https://github.com/mike-north/api-extractor-tools/blob/main/tools/eslint-plugin/docs/rules/${name}.md`);
+exports.packageDocumentation = createRule({
+    name: 'package-documentation',
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Require @packageDocumentation tag in package entry point files',
+        },
+        messages: {
+            missingPackageDocumentation: 'Entry point file is missing a @packageDocumentation comment. Add a TSDoc comment with @packageDocumentation at the top of the file.',
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    configPath: {
+                        type: 'string',
+                        description: 'Path to api-extractor.json configuration file',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+    defaultOptions: [{}],
+    create(context) {
+        const filename = context.filename;
+        const sourceCode = context.sourceCode;
+        // Find package.json
+        const pkgPath = (0, utils_2.findPackageJson)(filename);
+        if (!pkgPath) {
+            // No package.json found, nothing to check
+            return {};
+        }
+        // Check if this file is an entry point
+        if (!(0, utils_2.isEntryPoint)(filename, pkgPath)) {
+            // Not an entry point, skip
+            return {};
+        }
+        return {
+            Program(node) {
+                // Look for @packageDocumentation in any TSDoc comment in the file
+                const tsdocComments = (0, utils_2.findAllTSDocComments)(sourceCode);
+                for (const { parsed } of tsdocComments) {
+                    if (parsed.docComment && (0, utils_2.hasPackageDocumentation)(parsed.docComment)) {
+                        // Found @packageDocumentation, all good
+                        return;
+                    }
+                }
+                // No @packageDocumentation found
+                // Report at the first line of the file
+                context.report({
+                    node,
+                    loc: { line: 1, column: 0 },
+                    messageId: 'missingPackageDocumentation',
+                });
+            },
+        };
+    },
+});
+//# sourceMappingURL=package-documentation.js.map

package/dist/rules/package-documentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package-documentation.js","sourceRoot":"","sources":["../../src/rules/package-documentation.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,oDAAsD;AACtD,oCAKiB;AAGjB,MAAM,UAAU,GAAG,mBAAW,CAAC,WAAW,CACxC,CAAC,IAAI,EAAE,EAAE,CACP,8FAA8F,IAAI,KAAK,CAC1G,CAAA;AAIY,QAAA,oBAAoB,GAAG,UAAU,CAG5C;IACA,IAAI,EAAE,uBAAuB;IAC7B,IAAI,EAAE;QACJ,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EACT,gEAAgE;SACnE;QACD,QAAQ,EAAE;YACR,2BAA2B,EACzB,qIAAqI;SACxI;QACD,MAAM,EAAE;YACN;gBACE,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,+CAA+C;qBAC7D;iBACF;gBACD,oBAAoB,EAAE,KAAK;aAC5B;SACF;KACF;IACD,cAAc,EAAE,CAAC,EAAE,CAAC;IACpB,MAAM,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QACjC,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;QAErC,oBAAoB;QACpB,MAAM,OAAO,GAAG,IAAA,uBAAe,EAAC,QAAQ,CAAC,CAAA;QACzC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,0CAA0C;YAC1C,OAAO,EAAE,CAAA;QACX,CAAC;QAED,uCAAuC;QACvC,IAAI,CAAC,IAAA,oBAAY,EAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,CAAC;YACrC,2BAA2B;YAC3B,OAAO,EAAE,CAAA;QACX,CAAC;QAED,OAAO;YACL,OAAO,CAAC,IAAI;gBACV,kEAAkE;gBAClE,MAAM,aAAa,GAAG,IAAA,4BAAoB,EAAC,UAAU,CAAC,CAAA;gBAEtD,KAAK,MAAM,EAAE,MAAM,EAAE,IAAI,aAAa,EAAE,CAAC;oBACvC,IAAI,MAAM,CAAC,UAAU,IAAI,IAAA,+BAAuB,EAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;wBACpE,wCAAwC;wBACxC,OAAM;oBACR,CAAC;gBACH,CAAC;gBAED,iCAAiC;gBACjC,uCAAuC;gBACvC,OAAO,CAAC,MAAM,CAAC;oBACb,IAAI;oBACJ,GAAG,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE;oBAC3B,SAAS,EAAE,6BAA6B;iBACzC,CAAC,CAAA;YACJ,CAAC;SACF,CAAA;IACH,CAAC;CACF,CAAC,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Types for the API Extractor ESLint plugin.
+ *
+ * @packageDocumentation
+ */
+/**
+ * Log levels supported by API Extractor message configuration.
+ * @public
+ */
+export type ApiExtractorLogLevel = 'error' | 'warning' | 'none';
+/**
+ * Configuration for a single message type in API Extractor.
+ * @public
+ */
+export interface MessageConfig {
+    logLevel: ApiExtractorLogLevel;
+    addToApiReportFile?: boolean;
+}
+/**
+ * The messages configuration section from api-extractor.json.
+ * @public
+ */
+export interface ApiExtractorMessagesConfig {
+    compilerMessageReporting?: {
+        default?: MessageConfig;
+        [messageId: string]: MessageConfig | undefined;
+    };
+    extractorMessageReporting?: {
+        default?: MessageConfig;
+        'ae-missing-release-tag'?: MessageConfig;
+        'ae-forgotten-export'?: MessageConfig;
+        'ae-internal-missing-underscore'?: MessageConfig;
+        'ae-incompatible-release-tags'?: MessageConfig;
+        [messageId: string]: MessageConfig | undefined;
+    };
+    tsdocMessageReporting?: {
+        default?: MessageConfig;
+        [messageId: string]: MessageConfig | undefined;
+    };
+}
+/**
+ * Partial representation of api-extractor.json relevant for this plugin.
+ * @public
+ */
+export interface ApiExtractorConfig {
+    extends?: string;
+    mainEntryPointFilePath?: string;
+    messages?: ApiExtractorMessagesConfig;
+}
+/**
+ * Release tags recognized by API Extractor.
+ * @public
+ */
+export type ReleaseTag = 'public' | 'beta' | 'alpha' | 'internal';
+/**
+ * All valid release tags.
+ * @public
+ */
+export declare const RELEASE_TAGS: readonly ReleaseTag[];
+/**
+ * Options for the missing-release-tag rule.
+ * @public
+ */
+export interface MissingReleaseTagRuleOptions {
+    configPath?: string;
+}
+/**
+ * Options for the override-keyword rule.
+ * @public
+ */
+export interface OverrideKeywordRuleOptions {
+    configPath?: string;
+}
+/**
+ * Options for the package-documentation rule.
+ * @public
+ */
+export interface PackageDocumentationRuleOptions {
+    configPath?: string;
+}
+/**
+ * Resolved entry points from package.json.
+ * @public
+ */
+export interface ResolvedEntryPoints {
+    main?: string;
+    types?: string;
+    exports: string[];
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAA;AAE/D;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,oBAAoB,CAAA;IAC9B,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,wBAAwB,CAAC,EAAE;QACzB,OAAO,CAAC,EAAE,aAAa,CAAA;QACvB,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;KAC/C,CAAA;IACD,yBAAyB,CAAC,EAAE;QAC1B,OAAO,CAAC,EAAE,aAAa,CAAA;QACvB,wBAAwB,CAAC,EAAE,aAAa,CAAA;QACxC,qBAAqB,CAAC,EAAE,aAAa,CAAA;QACrC,gCAAgC,CAAC,EAAE,aAAa,CAAA;QAChD,8BAA8B,CAAC,EAAE,aAAa,CAAA;QAC9C,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;KAC/C,CAAA;IACD,qBAAqB,CAAC,EAAE;QACtB,OAAO,CAAC,EAAE,aAAa,CAAA;QACvB,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;KAC/C,CAAA;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,sBAAsB,CAAC,EAAE,MAAM,CAAA;IAC/B,QAAQ,CAAC,EAAE,0BAA0B,CAAA;CACtC;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,CAAA;AAEjE;;;GAGG;AACH,eAAO,MAAM,YAAY,EAAE,SAAS,UAAU,EAKpC,CAAA;AAEV;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,+BAA+B;IAC9C,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB"}

package/dist/types.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Types for the API Extractor ESLint plugin.
+ *
+ * @packageDocumentation
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RELEASE_TAGS = void 0;
+/**
+ * All valid release tags.
+ * @public
+ */
+exports.RELEASE_TAGS = [
+    'public',
+    'beta',
+    'alpha',
+    'internal',
+];
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAwDH;;;GAGG;AACU,QAAA,YAAY,GAA0B;IACjD,QAAQ;IACR,MAAM;IACN,OAAO;IACP,UAAU;CACF,CAAA"}

package/dist/utils/config-loader.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Utilities for discovering and loading API Extractor configuration.
+ * @internal
+ */
+import type { ApiExtractorConfig, ApiExtractorLogLevel } from '../types';
+/**
+ * Searches upward from the given directory to find api-extractor.json.
+ *
+ * @param startDir - Directory to start searching from
+ * @returns Path to api-extractor.json if found, undefined otherwise
+ */
+export declare function findApiExtractorConfig(startDir: string): string | undefined;
+/**
+ * Loads and parses an api-extractor.json file.
+ *
+ * @param configPath - Path to the api-extractor.json file
+ * @returns Parsed configuration or null if file cannot be read
+ */
+export declare function loadApiExtractorConfig(configPath: string): ApiExtractorConfig | null;
+/**
+ * Gets the log level for a specific message ID from the configuration.
+ *
+ * @param config - API Extractor configuration
+ * @param messageId - The message ID (e.g., 'ae-missing-release-tag')
+ * @returns The configured log level, or 'warning' as default
+ */
+export declare function getMessageLogLevel(config: ApiExtractorConfig | null, messageId: string): ApiExtractorLogLevel;
+/**
+ * Resolves configuration for a file, using auto-discovery or explicit path.
+ *
+ * @param filePath - Path to the file being linted
+ * @param explicitConfigPath - Optional explicit path to api-extractor.json
+ * @returns The resolved configuration or null
+ */
+export declare function resolveConfig(filePath: string, explicitConfigPath?: string): ApiExtractorConfig | null;
+/**
+ * Maps API Extractor log level to ESLint severity.
+ *
+ * @param logLevel - API Extractor log level
+ * @returns ESLint severity (0 = off, 1 = warn, 2 = error)
+ */
+export declare function logLevelToSeverity(logLevel: ApiExtractorLogLevel): 0 | 1 | 2;
+/**
+ * Clears the configuration cache. Useful for testing.
+ */
+export declare function clearConfigCache(): void;
+//# sourceMappingURL=config-loader.d.ts.map

package/dist/utils/config-loader.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-loader.d.ts","sourceRoot":"","sources":["../../src/utils/config-loader.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EACV,kBAAkB,EAClB,oBAAoB,EAErB,MAAM,UAAU,CAAA;AAiBjB;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAa3E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,kBAAkB,GAAG,IAAI,CAkC3B;AA6BD;;;;;;GAMG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,kBAAkB,GAAG,IAAI,EACjC,SAAS,EAAE,MAAM,GAChB,oBAAoB,CAgBtB;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,QAAQ,EAAE,MAAM,EAChB,kBAAkB,CAAC,EAAE,MAAM,GAC1B,kBAAkB,GAAG,IAAI,CAW3B;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,oBAAoB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAS5E;AAED;;GAEG;AACH,wBAAgB,gBAAgB,IAAI,IAAI,CAEvC"}