eslint-plugin-jsdoc

Variables

• configs
• index
• jsdoc
• rules

Functions

• getJsdocProcessorPlugin()

Type Aliases

• ConfigGroups
• ConfigVariants
• ErrorLevelVariants
• FlatConfigNames
• JsdocPlugin

Namespaces

• @babel/eslint-parser
• gitdown

  • Gitdown
  • readFile()

variable configs

const configs: Record<FlatConfigNames, any> &
    Record<
        'examples' | 'default-expressions' | 'examples-and-default-expressions',
        any[]
    > &
    Record<'flat/recommended-mixed', any[]>;

• {Record< FlatConfigNames, import('eslint').Linter.Config > & Record< "examples"|"default-expressions"|"examples-and-default-expressions", import('eslint').Linter.Config[] > & Record<"flat/recommended-mixed", import('eslint').Linter.Config[]> }

variable index

const index: any;

• {"recommended" | "stylistic" | "contents" | "logical" | "requirements"} ConfigGroups {"" | "-typescript" | "-typescript-flavor"} ConfigVariants {"" | "-error"} ErrorLevelVariants {flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants} | "flat/recommended-tsdoc" | "flat/recommended-tsdoc-error"} FlatConfigNames {import('eslint').ESLint.Plugin & { configs: Record< FlatConfigNames, import('eslint').Linter.Config > & Record< "examples"|"default-expressions"|"examples-and-default-expressions", import('eslint').Linter.Config[] > & Record<"flat/recommended-mixed", import('eslint').Linter.Config[]> }} JsdocPlugin

variable jsdoc

const jsdoc: (cfg?: any) => any;

• {(( cfg?: import('eslint').Linter.Config & { config?: FlatConfigNames, mergeSettings?: boolean, settings?: Partial<import('./iterateJsdoc.js').Settings>, rules?: {[key in keyof import('./rules.d.ts').Rules]?: import('eslint').Linter.RuleEntry<import('./rules.d.ts').Rules[key]>}, extraRuleDefinitions?: { forbid?: { [contextName: string]: { description?: string, url?: string, contexts: (string|{ message: string, context: string, comment: string })[] } }, preferTypes?: { [typeName: string]: { description: string, overrideSettings: { [typeNodeName: string]: { message: string, replacement?: false|string, unifyParentAndChildTypeChecks?: boolean, } }, url: string, } } } } ) => import('eslint').Linter.Config)}

variable rules

const rules: any;

• {import('eslint').ESLint.Plugin['rules']}

function getJsdocProcessorPlugin

getJsdocProcessorPlugin: (options?: JsdocProcessorOptions) => ESLint.Plugin;

type ConfigGroups

type ConfigGroups =
    | 'recommended'
    | 'stylistic'
    | 'contents'
    | 'logical'
    | 'requirements';

type ConfigVariants

type ConfigVariants = '' | '-typescript' | '-typescript-flavor';

type ErrorLevelVariants

type ErrorLevelVariants = '' | '-error';

type FlatConfigNames

type FlatConfigNames =
    | `flat/${ConfigGroups}${ConfigVariants}${ErrorLevelVariants}`
    | 'flat/recommended-tsdoc'
    | 'flat/recommended-tsdoc-error';

type JsdocPlugin

type JsdocPlugin = import('eslint').ESLint.Plugin & {
    configs: Record<FlatConfigNames, import('eslint').Linter.Config> &
        Record<
            'examples' | 'default-expressions' | 'examples-and-default-expressions',
            import('eslint').Linter.Config[]
        > &
        Record<'flat/recommended-mixed', import('eslint').Linter.Config[]>;
};