vue-docgen-api/dist/types.d.ts

Toolbox to extract information from Vue component files for documentation generation purposes.

import * as bt from '@babel/types';
import type Map from 'ts-map';
import type { NodePath } from 'ast-types/lib/node-path';
import type { TemplateChildNode } from '@vue/compiler-dom';
import type { Options as PugOptions } from 'pug';
import type { Descriptor, Documentation } from './Documentation';
export type ParseFileFunction = (opt: ParseOptions, documentation?: Documentation) => Promise<Documentation[]>;
export type HandlerExecutorsFunction = (componentDefinitions: Map<string, NodePath>, ast: bt.File, options: ParseOptions, deps: {
    parseFile: ParseFileFunction;
}, documentation?: Documentation, forceSingleExport?: boolean) => Promise<Documentation[] | undefined>;
export type ScriptHandler = (doc: Documentation, componentDefinition: NodePath, ast: bt.File, opt: ParseOptions, deps: {
    parseFile: ParseFileFunction;
    addDefaultAndExecuteHandlers: HandlerExecutorsFunction;
}) => Promise<void>;
export interface TemplateParserOptions {
    functional: boolean;
}
export type TemplateHandler = (documentation: Documentation, templateAst: TemplateChildNode, siblings: TemplateChildNode[], options: TemplateParserOptions) => void;
export interface ParseOptions extends DocGenOptions, Descriptor {
    validExtends: (fullFilePath: string) => boolean;
    filePath: string;
    /**
     * In what language is the component written
     * @default undefined - let the system decide
     */
    lang?: 'ts' | 'js';
}
export interface DocGenOptions {
    /**
     * Which exported variables should be looked at
     * @default undefined - means treat all exports
     */
    nameFilter?: string[];
    /**
     * What alias should be replaced in requires and imports
     */
    alias?: {
        [alias: string]: string | string[];
    };
    /**
     * What directories should be searched when resolving modules
     */
    modules?: string[];
    /**
     * Handlers that will be added at the end of the script analysis
     */
    addScriptHandlers?: ScriptHandler[];
    /**
     * Handlers that will be added at the end of the template analysis
     */
    addTemplateHandlers?: TemplateHandler[];
    /**
     * Handlers that will replace the extend and mixins analyzer
     * They will be run before the main component analysis to avoid bleeding onto the main
     */
    scriptPreHandlers?: ScriptHandler[];
    /**
     * Handlers that will replace the main script analysis
     */
    scriptHandlers?: ScriptHandler[];
    /**
     * Handlers that will replace the template analysis
     */
    templateHandlers?: TemplateHandler[];
    /**
     * Does parsed components use jsx?
     * @default true - if you do not disable it, babel will fail with `(<any>window).$`
     */
    jsx?: boolean;
    /**
     * Should extended components be parsed?
     * @default `fullFilePath=>!/[\\/]node_modules[\\/]/.test(fullFilePath)`
     */
    validExtends?: (fullFilePath: string) => boolean;
    /**
     * all pug options passed to the pug compiler if you use it
     */
    pugOptions?: PugOptions;
}