API Document

Packages

Basic Usage:

import { exec } from 'markuplint';

const result = await exec({
    files: './**/*.html',
});

console.log(result); // => The results in JSON format

Functions

exec

options

KeyTypeOptionalDescription
filesstring string[]Glob pattern
sourceCodesstring string[]Target source code of evaluation
namesstring string[]File names when sourceCodes
workspacestringWorkspace path when sourceCodes
configstring ConfigConfigure file or object
defaultConfigConfigThe config applied when not resolved from files or set it explicitly.
rulesMLRule[]Rules (default: @markuplint/rules)
rulesAutoResolvebooleanAuto resolve rules - Auto importing form node_modules when set @markuplint/rule-{RULE_NAME} or markuplint-rule-{RULE_NAME} in config rules
fixbooleanwith to fix
localestringLocale

Interface Document

The details are said by https://api.markuplint.dev.