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

package/ARCHITECTURE.md

@@ -0,0 +1,204 @@
+# ESLint Plugin Architecture
+
+This document describes the architecture of `@api-extractor-tools/eslint-plugin`.
+
+## Design Principles
+
+### Isomorphic Core
+
+The plugin is designed to work in both Node.js and browser environments. While the core functionality aims to be environment-agnostic, the current implementation uses `@typescript-eslint/utils` which has transitive Node.js dependencies. Browser usage requires polyfills (see usage examples).
+
+### Explicit Configuration
+
+Rules accept configuration explicitly via options rather than automatically discovering configuration files. This makes the rules predictable, testable, and environment-agnostic.
+
+### Optional Node.js Enhancements
+
+Node.js-specific functionality (reading files from disk, discovering configuration) is provided as a separate entry point. This is purely a convenience layer - users can always provide equivalent configuration explicitly.
+
+## Package Structure
+
+```text
+src/
+├── index.ts              # Main entry point (isomorphic)
+├── node.ts               # Node.js utilities entry point
+├── types.ts              # TypeScript types (isomorphic)
+├── rules/
+│   ├── index.ts          # Rule exports
+│   ├── missing-release-tag.ts
+│   ├── override-keyword.ts
+│   └── package-documentation.ts
+├── configs/
+│   ├── index.ts          # Config exports
+│   └── recommended.ts    # Recommended ruleset
+└── utils/
+    ├── tsdoc-parser.ts   # TSDoc parsing (isomorphic)
+    ├── config-loader.ts  # Config file loading (Node.js only)
+    └── entry-point.ts    # Entry point detection (Node.js only)
+```
+
+## Entry Points
+
+### Main Entry Point (`.`)
+
+```ts
+import plugin from '@api-extractor-tools/eslint-plugin'
+```
+
+Exports:
+
+- `default` - The ESLint plugin object with `rules` and `configs`
+- `rules` - All ESLint rules
+- `recommendedRules` - Recommended rule configuration
+- Types - `ApiExtractorConfig`, `ReleaseTag`, rule option types, etc.
+- TSDoc utilities - `parseTSDocComment`, `extractReleaseTag`, etc.
+
+This entry point can be used in browser environments with appropriate polyfills for `@typescript-eslint/utils` dependencies.
+
+### Node.js Entry Point (`./node`)
+
+```ts
+import {
+  findApiExtractorConfig,
+  loadApiExtractorConfig,
+} from '@api-extractor-tools/eslint-plugin/node'
+```
+
+Exports:
+
+- `findApiExtractorConfig(startDir)` - Discovers api-extractor.json by searching upward
+- `loadApiExtractorConfig(path)` - Loads and parses an api-extractor.json file
+- `resolveConfig(filePath, configPath?)` - Resolves config for a file
+- `getMessageLogLevel(config, messageId)` - Gets log level for a message
+- `findPackageJson(startDir)` - Discovers package.json by searching upward
+- `isEntryPoint(filePath, pkgPath)` - Checks if a file is a package entry point
+
+This entry point requires Node.js (`fs`, `path` modules).
+
+## Rules
+
+### missing-release-tag
+
+Requires exported symbols to have a release tag (`@public`, `@beta`, `@alpha`, or `@internal`).
+
+**Options:**
+
+```ts
+interface MissingReleaseTagRuleOptions {
+  severity?: 'error' | 'warning' | 'none' // default: 'warning'
+}
+```
+
+### override-keyword
+
+Requires the TypeScript `override` keyword when the `@override` TSDoc tag is present.
+
+**Options:** None (purely syntactic)
+
+### package-documentation
+
+Enforces correct usage of the `@packageDocumentation` tag based on whether a file is a package entry point (barrel file). The rule automatically detects entry points by examining the nearest `package.json`.
+
+- **Barrel files** (entry points): Requires `@packageDocumentation` tag to be present.
+- **Non-barrel files**: Reports an error if `@packageDocumentation` tag is found.
+
+**Options:** None
+
+Note: This rule uses `findPackageJson` and `isEntryPoint` from the entry-point utilities to determine barrel file status. If no `package.json` is found, the rule is skipped.
+
+## Usage Examples
+
+### Browser Environment (ESLint 9 Flat Config)
+
+```js
+import { Linter } from 'eslint-linter-browserify'
+import * as tsParser from '@typescript-eslint/parser'
+import { rules } from '@api-extractor-tools/eslint-plugin'
+
+const linter = new Linter()
+
+// Lint code using ESLint 9 flat config style
+const messages = linter.verify(
+  code,
+  {
+    files: ['**/*.ts', '**/*.d.ts'],
+    plugins: {
+      '@api-extractor-tools': { rules },
+    },
+    languageOptions: {
+      parser: tsParser,
+      parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+      },
+    },
+    rules: {
+      '@api-extractor-tools/missing-release-tag': [
+        'warn',
+        { severity: 'warning' },
+      ],
+      '@api-extractor-tools/override-keyword': 'error',
+    },
+  },
+  { filename: 'file.d.ts' },
+)
+```
+
+**Note:** When using in a browser, you'll need to polyfill or stub Node.js modules that `@typescript-eslint/parser` depends on (e.g., `fs`, `path`, `process`). See the demo-site for a working example using Vite aliases.
+
+### Node.js with ESLint Flat Config
+
+```js
+// eslint.config.js
+import apiExtractorPlugin from '@api-extractor-tools/eslint-plugin'
+
+export default [apiExtractorPlugin.configs.recommended]
+```
+
+### Node.js with Config Discovery
+
+```js
+// eslint.config.js
+import apiExtractorPlugin from '@api-extractor-tools/eslint-plugin'
+import {
+  findApiExtractorConfig,
+  loadApiExtractorConfig,
+  getMessageLogLevel,
+} from '@api-extractor-tools/eslint-plugin/node'
+
+// Discover and load api-extractor.json
+const configPath = findApiExtractorConfig(process.cwd())
+const config = configPath ? loadApiExtractorConfig(configPath) : null
+
+// Get severity from config (or use default)
+const severity = config
+  ? getMessageLogLevel(config, 'ae-missing-release-tag')
+  : 'warning'
+
+export default [
+  {
+    plugins: { '@api-extractor-tools': apiExtractorPlugin },
+    rules: {
+      '@api-extractor-tools/missing-release-tag': ['warn', { severity }],
+      '@api-extractor-tools/override-keyword': 'error',
+    },
+  },
+]
+```
+
+## Dependencies
+
+### Runtime Dependencies
+
+- `@microsoft/tsdoc` - TSDoc comment parsing (browser-compatible)
+
+### Dev Dependencies
+
+- `@typescript-eslint/utils` - ESLint rule utilities and TypeScript AST types
+- `@typescript-eslint/rule-tester` - Testing harness for ESLint rules
+- `@typescript-eslint/parser` - TypeScript parser for ESLint (used in tests)
+
+### Peer Dependencies
+
+- `eslint` >= 8.0.0
+- `typescript` >= 5.5.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # @api-extractor-tools/eslint-plugin
 
+## 0.1.0-alpha.2
+
+### Minor Changes
+
+- [#204](https://github.com/mike-north/api-extractor-tools/pull/204) [`3accc97`](https://github.com/mike-north/api-extractor-tools/commit/3accc97733d1b21eb7bbbe82b122a347e9b5ea76) Thanks [@mike-north](https://github.com/mike-north)! - fix: enforce @packageDocumentation only on package barrel files
+
+  The `package-documentation` rule now automatically detects whether a file is a package entry point by examining the nearest `package.json`. Barrel files are required to have the `@packageDocumentation` tag, and non-barrel files report an error if the tag is present. Previously the rule required the tag on every file regardless of whether it was an entry point.
+
+## 0.1.0-alpha.1
+
+### Patch Changes
+
+- [#182](https://github.com/mike-north/api-extractor-tools/pull/182) [`d77d4d1`](https://github.com/mike-north/api-extractor-tools/commit/d77d4d1657641e16dc98736b88ece121c3d27563) Thanks [@mike-north](https://github.com/mike-north)! - Integrate declaration-file-normalizer into build pipelines and add comprehensive test coverage.
+
+  **Test Coverage Improvements:**
+  - Added comprehensive test suite for declaration-file-normalizer (64 tests total)
+  - Improved coverage from 8.39% to 67.97%
+  - Coverage breakdown:
+    - index.ts: 96.77% statements, 92.3% branch coverage
+    - normalizer.ts: 100% coverage
+    - parser.ts: 86.56% statements, 66.66% branch coverage
+    - writer.ts: 90.9% statements, 66.66% branch coverage
+  - Added test suites for parser, writer, index orchestration, and CLI
+
+  **Build Pipeline Integration:**
+  - Integrated declaration-file-normalizer into build pipeline for all packages using API Extractor
+  - Build flow is now: `tsc → declaration-file-normalizer → api-extractor`
+  - This ensures stable union/intersection type ordering in API reports across builds
+
+  **Configuration:**
+  - Fixed vitest.config.mts to properly track index.ts coverage
+
 ## 0.1.0-alpha.0
 
 ### Minor Changes

package/README.md

@@ -34,6 +34,12 @@ export default [
       '@api-extractor-tools/missing-release-tag': 'error',
       '@api-extractor-tools/override-keyword': 'error',
       '@api-extractor-tools/package-documentation': 'warn',
+      '@api-extractor-tools/forgotten-export': 'warn',
+      '@api-extractor-tools/incompatible-release-tags': 'warn',
+      '@api-extractor-tools/extra-release-tag': 'error',
+      '@api-extractor-tools/public-on-private-member': 'error',
+      '@api-extractor-tools/public-on-non-exported': 'error',
+      '@api-extractor-tools/valid-enum-type': 'warn',
     },
   },
 ]
@@ -57,6 +63,12 @@ module.exports = {
     '@api-extractor-tools/missing-release-tag': 'error',
     '@api-extractor-tools/override-keyword': 'error',
     '@api-extractor-tools/package-documentation': 'warn',
+    '@api-extractor-tools/forgotten-export': 'warn',
+    '@api-extractor-tools/incompatible-release-tags': 'warn',
+    '@api-extractor-tools/extra-release-tag': 'error',
+    '@api-extractor-tools/public-on-private-member': 'error',
+    '@api-extractor-tools/public-on-non-exported': 'error',
+    '@api-extractor-tools/valid-enum-type': 'warn',
   },
 }
 ```
@@ -144,6 +156,289 @@ export function foo() {}
 export function foo() {}
 ```
 
+### `@api-extractor-tools/forgotten-export`
+
+Requires that types and symbols referenced by exported APIs are also exported from the entry point.
+
+This rule mirrors API Extractor's `ae-forgotten-export` message.
+
+```ts
+// ❌ Bad - MyInterface is used but not exported
+interface MyInterface {
+  name: string
+}
+
+export function myFunction(param: MyInterface): void {}
+
+// ✅ Good - MyInterface is exported
+export interface MyInterface {
+  name: string
+}
+
+export function myFunction(param: MyInterface): void {}
+```
+
+**Options:**
+
+- `severity` (optional): Severity level for forgotten exports. Default: `'warning'`
+
+```json
+{
+  "@api-extractor-tools/forgotten-export": ["warn", { "severity": "warning" }]
+}
+```
+
+### `@api-extractor-tools/incompatible-release-tags`
+
+Requires that exported APIs do not reference symbols with less visible release tags.
+
+This rule mirrors API Extractor's `ae-incompatible-release-tags` message. For example, a `@public` API should not reference an `@internal` type.
+
+Release tag visibility hierarchy (from least to most visible):
+
+- `@internal` < `@alpha` < `@beta` < `@public`
+
+```ts
+// ❌ Bad - public API using internal type
+/**
+ * An internal interface.
+ * @internal
+ */
+interface MyInterface {
+  name: string
+}
+
+/**
+ * A public function.
+ * @public
+ */
+export function myFunction(param: MyInterface): void {}
+
+// ✅ Good - public API using public type
+/**
+ * A public interface.
+ * @public
+ */
+export interface MyInterface {
+  name: string
+}
+
+/**
+ * A public function.
+ * @public
+ */
+export function myFunction(param: MyInterface): void {}
+```
+
+**Options:**
+
+- `severity` (optional): Severity level for incompatible release tags. Default: `'warning'`
+
+```json
+{
+  "@api-extractor-tools/incompatible-release-tags": [
+    "error",
+    { "severity": "warning" }
+  ]
+}
+```
+
+### `@api-extractor-tools/extra-release-tag`
+
+Requires that symbols have at most one release tag.
+
+This rule mirrors API Extractor's `ae-extra-release-tag` message. Each symbol should have exactly one release tag (`@public`, `@beta`, `@alpha`, or `@internal`).
+
+```ts
+// ❌ Bad - multiple release tags
+/**
+ * A function with multiple tags.
+ * @public
+ * @beta
+ */
+export function myFunction(): void {}
+
+// ✅ Good - single release tag
+/**
+ * A public function.
+ * @public
+ */
+export function myFunction(): void {}
+```
+
+**Options:**
+
+- `severity` (optional): Severity level for extra release tags. Default: `'error'`
+
+```json
+{
+  "@api-extractor-tools/extra-release-tag": ["error", { "severity": "error" }]
+}
+```
+
+### `@api-extractor-tools/public-on-private-member`
+
+Prevents the use of `@public` tag on private or protected class members.
+
+Private and protected members cannot be public API since they are not accessible outside the class or to external consumers.
+
+```ts
+// ❌ Bad - @public on private member
+export class MyClass {
+  /**
+   * A private property.
+   * @public
+   */
+  private myProperty: string = ''
+}
+
+// ✅ Good - @internal on private member
+export class MyClass {
+  /**
+   * A private property.
+   * @internal
+   */
+  private myProperty: string = ''
+}
+
+// ✅ Good - @public on public member
+export class MyClass {
+  /**
+   * A public property.
+   * @public
+   */
+  public myProperty: string = ''
+}
+```
+
+**Options:**
+
+- `severity` (optional): Severity level for public tags on private/protected members. Default: `'error'`
+
+```json
+{
+  "@api-extractor-tools/public-on-private-member": [
+    "error",
+    { "severity": "error" }
+  ]
+}
+```
+
+### `@api-extractor-tools/public-on-non-exported`
+
+Prevents the use of `@public` tag on symbols that are not exported.
+
+The `@public` tag indicates that a symbol is part of the public API, but non-exported symbols cannot be accessed by consumers.
+
+```ts
+// ❌ Bad - @public on non-exported symbol
+/**
+ * A function.
+ * @public
+ */
+function myFunction(): void {}
+
+// ✅ Good - @public on exported symbol
+/**
+ * A function.
+ * @public
+ */
+export function myFunction(): void {}
+
+// ✅ Good - @internal on non-exported symbol
+/**
+ * A function.
+ * @internal
+ */
+function myFunction(): void {}
+
+// ✅ Good - exported separately
+/**
+ * A function.
+ * @public
+ */
+function myFunction(): void {}
+
+export { myFunction }
+```
+
+**Options:**
+
+- `severity` (optional): Severity level for public tags on non-exported symbols. Default: `'error'`
+
+```json
+{
+  "@api-extractor-tools/public-on-non-exported": [
+    "error",
+    { "severity": "error" }
+  ]
+}
+```
+
+### `@api-extractor-tools/valid-enum-type`
+
+Validates the usage of the `@enumType` TSDoc tag on enum declarations and string literal union type aliases.
+
+The `@enumType` tag specifies whether an enum is "open" (new members may be added) or "closed" (the set of members is fixed). This is used by the change detector to properly classify API changes.
+
+```ts
+// ❌ Bad - missing value
+/**
+ * @enumType
+ */
+export enum Status {
+  Active,
+  Inactive,
+}
+
+// ❌ Bad - invalid value
+/**
+ * @enumType invalid
+ */
+export enum Status {
+  Active,
+  Inactive,
+}
+
+// ❌ Bad - @enumType on invalid construct
+/**
+ * @enumType open
+ */
+export function myFunction(): void {}
+
+// ✅ Good - open enum
+/**
+ * Status values for a resource.
+ * @enumType open
+ * @public
+ */
+export enum Status {
+  Active = 'active',
+  Inactive = 'inactive',
+}
+
+// ✅ Good - closed string literal union
+/**
+ * Supported formats.
+ * @enumType closed
+ * @public
+ */
+export type Format = 'json' | 'xml'
+```
+
+**Options:**
+
+- `requireOnExported` (optional): When `true`, requires all exported enums and string literal unions to have an `@enumType` tag. Default: `false`
+
+```json
+{
+  "@api-extractor-tools/valid-enum-type": [
+    "warn",
+    { "requireOnExported": true }
+  ]
+}
+```
+
 ## Configuration Discovery
 
 Rules that read from `api-extractor.json` use the following strategy:
@@ -156,11 +451,17 @@ Rules that read from `api-extractor.json` use the following strategy:
 
 The `recommended` configuration enables all rules with these defaults:
 
-| Rule                    | Severity |
-| ----------------------- | -------- |
-| `missing-release-tag`   | warn     |
-| `override-keyword`      | error    |
-| `package-documentation` | warn     |
+| Rule                        | Severity |
+| --------------------------- | -------- |
+| `missing-release-tag`       | warn     |
+| `override-keyword`          | error    |
+| `package-documentation`     | warn     |
+| `forgotten-export`          | warn     |
+| `incompatible-release-tags` | warn     |
+| `extra-release-tag`         | error    |
+| `public-on-private-member`  | error    |
+| `public-on-non-exported`    | error    |
+| `valid-enum-type`           | warn     |
 
 ## Requirements
 
@@ -176,8 +477,3 @@ The `recommended` configuration enables all rules with these defaults:
 ## License
 
 MIT
-
-
-
-
-

package/api-extractor.json

@@ -8,3 +8,4 @@
     "tsconfigFilePath": "<projectFolder>/tsconfig.json"
   }
 }
+

package/dist/configs/recommended.d.ts

@@ -11,7 +11,7 @@ import type { TSESLint } from '@typescript-eslint/utils';
 /**
  * Recommended rule configuration.
  * These are the rules enabled by default with appropriate severity.
- * @public
+ * @alpha
  */
 export declare const recommendedRules: TSESLint.Linter.RulesRecord;
 /**

package/dist/configs/recommended.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recommended.d.ts","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AAExD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,WAI9C,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,QAAQ,CAAC,UAAU,CAAC,MAAM,CAO5B"}
+{"version":3,"file":"recommended.d.ts","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAA;AAExD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,MAAM,CAAC,WAU9C,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,2BAA2B,CACzC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC9B,QAAQ,CAAC,UAAU,CAAC,MAAM,CAO5B"}

package/dist/configs/recommended.js

@@ -14,12 +14,18 @@ exports.createFlatRecommendedConfig = createFlatRecommendedConfig;
 /**
  * Recommended rule configuration.
  * These are the rules enabled by default with appropriate severity.
- * @public
+ * @alpha
  */
 exports.recommendedRules = {
     '@api-extractor-tools/missing-release-tag': 'warn',
     '@api-extractor-tools/override-keyword': 'error',
     '@api-extractor-tools/package-documentation': 'warn',
+    '@api-extractor-tools/forgotten-export': 'warn',
+    '@api-extractor-tools/incompatible-release-tags': 'warn',
+    '@api-extractor-tools/extra-release-tag': 'error',
+    '@api-extractor-tools/public-on-private-member': 'error',
+    '@api-extractor-tools/public-on-non-exported': 'error',
+    '@api-extractor-tools/valid-enum-type': 'warn',
 };
 /**
  * Flat-config recommended configuration.

package/dist/configs/recommended.js.map

@@ -1 +1 @@
-{"version":3,"file":"recommended.js","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AA4BH,kEASC;AAjCD;;;;GAIG;AACU,QAAA,gBAAgB,GAAgC;IAC3D,0CAA0C,EAAE,MAAM;IAClD,uCAAuC,EAAE,OAAO;IAChD,4CAA4C,EAAE,MAAM;CACrD,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,2BAA2B,CACzC,MAA+B;IAE/B,OAAO;QACL,OAAO,EAAE;YACP,sBAAsB,EAAE,MAAoC;SAC7D;QACD,KAAK,EAAE,wBAAgB;KACxB,CAAA;AACH,CAAC"}
+{"version":3,"file":"recommended.js","sourceRoot":"","sources":["../../src/configs/recommended.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAkCH,kEASC;AAvCD;;;;GAIG;AACU,QAAA,gBAAgB,GAAgC;IAC3D,0CAA0C,EAAE,MAAM;IAClD,uCAAuC,EAAE,OAAO;IAChD,4CAA4C,EAAE,MAAM;IACpD,uCAAuC,EAAE,MAAM;IAC/C,gDAAgD,EAAE,MAAM;IACxD,wCAAwC,EAAE,OAAO;IACjD,+CAA+C,EAAE,OAAO;IACxD,6CAA6C,EAAE,OAAO;IACtD,sCAAsC,EAAE,MAAM;CAC/C,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,2BAA2B,CACzC,MAA+B;IAE/B,OAAO;QACL,OAAO,EAAE;YACP,sBAAsB,EAAE,MAAoC;SAC7D;QACD,KAAK,EAAE,wBAAgB;KACxB,CAAA;AACH,CAAC"}

package/dist/index.d.ts

@@ -1,10 +1,6 @@
 /**
  * ESLint plugin providing authoring-time feedback for API Extractor.
  *
- * @remarks
- * This plugin provides ESLint rules that mirror API Extractor's validations,
- * enabling developers to catch issues during development rather than at build time.
- *
  * @example
  * Using with flat config (eslint.config.js):
  * ```js
@@ -12,15 +8,6 @@
  *
  * export default [
  *   apiExtractorPlugin.configs.recommended,
- *   // Or configure rules individually:
- *   {
- *     plugins: {
- *       '@api-extractor-tools': apiExtractorPlugin,
- *     },
- *     rules: {
- *       '@api-extractor-tools/missing-release-tag': 'error',
- *     },
- *   },
  * ];
  * ```
  *
@@ -38,8 +25,14 @@
 import type { TSESLint } from '@typescript-eslint/utils';
 import { rules } from './rules';
 import { recommendedRules } from './configs';
-export type { ApiExtractorConfig, ApiExtractorLogLevel, ApiExtractorMessagesConfig, MessageConfig, ReleaseTag, MissingReleaseTagRuleOptions, OverrideKeywordRuleOptions, PackageDocumentationRuleOptions, ResolvedEntryPoints, } from './types';
+export type { ApiExtractorConfig, ApiExtractorLogLevel, ApiExtractorMessagesConfig, MessageConfig, ReleaseTag, MissingReleaseTagRuleOptions, OverrideKeywordRuleOptions, PackageDocumentationRuleOptions, ResolvedEntryPoints, ValidEnumTypeRuleOptions, } from './types';
+export type { ForgottenExportRuleOptions } from './rules/forgotten-export';
+export type { IncompatibleReleaseTagsRuleOptions } from './rules/incompatible-release-tags';
+export type { ExtraReleaseTagRuleOptions } from './rules/extra-release-tag';
+export type { PublicOnPrivateMemberRuleOptions } from './rules/public-on-private-member';
+export type { PublicOnNonExportedRuleOptions } from './rules/public-on-non-exported';
 export { RELEASE_TAGS } from './types';
+export { parseTSDocComment, extractReleaseTag, hasOverrideTag, hasPackageDocumentation, getLeadingTSDocComment, findAllTSDocComments, extractEnumType, type EnumTypeValue, type EnumTypeExtraction, } from './utils/tsdoc-parser';
 /**
  * Plugin configuration type.
  * @internal
@@ -53,7 +46,7 @@ interface PluginConfigs {
 }
 /**
  * The ESLint plugin type.
- * @public
+ * @alpha
  */
 export interface ApiExtractorEslintPlugin {
     meta: {
@@ -65,7 +58,7 @@ export interface ApiExtractorEslintPlugin {
 }
 /**
  * The ESLint plugin object.
- * @public
+ * @alpha
  */
 declare const plugin: ApiExtractorEslintPlugin;
 export default plugin;