/** * @packageDocumentation * Public plugin entrypoint for eslint-plugin-write-good-comments-2. */ import type { ESLint, Linter } from "eslint"; import type { ArrayValues, Except } from "type-fest"; /** Canonical flat-config preset keys exposed through `plugin.configs`. */ export declare const writeGoodCommentsConfigNames: readonly ["all", "recommended"]; /** Canonical rule names exposed through `plugin.rules`. */ export declare const writeGoodCommentsRuleNames: readonly ["inclusive-language-comments", "no-profane-comments", "readability-comments", "spellcheck-comments", "task-comment-format", "write-good-comments"]; /** Canonical flat-config preset key type exposed through `plugin.configs`. */ export type WriteGoodCommentsConfigName = ArrayValues; /** Flat-config preset shape produced by this plugin. */ export type WriteGoodCommentsPresetConfig = Linter.Config & { rules: NonNullable; }; /** Strongly typed qualified rule-id union exported by this plugin. */ export type WriteGoodCommentsRuleId = `write-good-comments/${WriteGoodCommentsRuleName}`; /** Strongly typed unqualified rule-name union exported by this plugin. */ export type WriteGoodCommentsRuleName = ArrayValues; /** Runtime rule-entry shape expected by the public ESLint plugin contract. */ type PluginRuleEntry = NonNullable[string]; /** Runtime rule-map shape expected by the public ESLint plugin contract. */ type PluginRulesMap = NonNullable; /** Runtime rule registry shipped by this plugin. */ export declare const writeGoodCommentsRules: Readonly>; /** Runtime config registry shipped by this plugin. */ export type WriteGoodCommentsConfigs = Record; /** Fully assembled plugin contract used by the runtime default export. */ export type WriteGoodCommentsPlugin = Except & { configs: WriteGoodCommentsConfigs; meta: { name: string; namespace: string; version: string; }; rules: PluginRulesMap & typeof writeGoodCommentsRules; }; /** Runtime default plugin export. */ declare const plugin: WriteGoodCommentsPlugin; export default plugin; //# sourceMappingURL=plugin.d.ts.map