| 1 | import { Config, RuleConfigValue } from '@markuplint/ml-config';
|
| 2 | import { MLResultInfo } from './types';
|
| 3 | import { MLRule } from '@markuplint/ml-core';
|
| 4 | export declare function lint(options: {
|
| 5 | /**
|
| 6 | * Glob pattern
|
| 7 | */
|
| 8 | files?: string | string[];
|
| 9 | /**
|
| 10 | * Target source code of evaluation
|
| 11 | */
|
| 12 | sourceCodes?: string | string[];
|
| 13 | /**
|
| 14 | * File names when `sourceCodes`
|
| 15 | */
|
| 16 | names?: string | string[];
|
| 17 | /**
|
| 18 | * Workspace path when `sourceCodes`
|
| 19 | */
|
| 20 | workspace?: string;
|
| 21 | /**
|
| 22 | * Configure file or object
|
| 23 | */
|
| 24 | config?: string | Config;
|
| 25 | /**
|
| 26 | * Rules (default: `@markuplint/rules`)
|
| 27 | */
|
| 28 | rules?: MLRule<RuleConfigValue, unknown>[];
|
| 29 | /**
|
| 30 | * Auto resolve rules
|
| 31 | *
|
| 32 | * Auto importing form *node_modules* when set `@markuplint/rule-{RULE_NAME}` or `markuplint-rule-{RULE_NAME}` in config rules
|
| 33 | */
|
| 34 | rulesAutoResolve?: boolean;
|
| 35 | /**
|
| 36 | * Auto fix
|
| 37 | */
|
| 38 | fix?: boolean;
|
| 39 | /**
|
| 40 | * Locale
|
| 41 | */
|
| 42 | locale?: string;
|
| 43 | }): Promise<MLResultInfo[]>;
|