markuplint/lib/lint.d.ts

A Linter for All Markup Languages.

import { Config, RuleConfigValue } from '@markuplint/ml-config';
import { MLResultInfo } from './types';
import { MLRule } from '@markuplint/ml-core';
export declare function lint(options: {
    /**
     * Glob pattern
     */
    files?: string | string[];
    /**
     * Target source code of evaluation
     */
    sourceCodes?: string | string[];
    /**
     * File names when `sourceCodes`
     */
    names?: string | string[];
    /**
     * Workspace path when `sourceCodes`
     */
    workspace?: string;
    /**
     * Configure file or object
     */
    config?: string | Config;
    /**
     * The config applied when not resolved from files or set it explicitly.
     */
    defaultConfig?: Config;
    /**
     * Rules (default: `@markuplint/rules`)
     */
    rules?: MLRule<RuleConfigValue, unknown>[];
    /**
     * Auto resolve rules
     *
     * Auto importing form *node_modules* when set `@markuplint/rule-{RULE_NAME}` or `markuplint-rule-{RULE_NAME}` in config rules
     */
    rulesAutoResolve?: boolean;
    /**
     * Auto fix
     */
    fix?: boolean;
    /**
     * Locale
     */
    locale?: string;
}): Promise<MLResultInfo[]>;