API

Markuplint APIを使うと、Node.jsからプログラム的にリントを実行できます。CI/CDパイプライン、E2Eテスト、カスタム統合の構築に便利です。

基本的な使い方

import { MLEngine } from 'markuplint';

const file = await MLEngine.toMLFile('./path/to/page.html');

const engine = new MLEngine(file, {
  configFile: './path/to/.markuplintrc',
});

engine.on('log', (id, message) => {
  console.log(id, message);
});

const result = await engine.exec();

console.log(result.violations);

パッケージ

コア

パッケージ	NPM
`markuplint`
`@markuplint/ml-core`
`@markuplint/ml-ast`
`@markuplint/ml-config`
`@markuplint/ml-spec`
`@markuplint/rules`
`@markuplint/types`
`@markuplint/selector`
`@markuplint/i18n`
`@markuplint/shared`
`@markuplint/cli-utils`
`@markuplint/file-resolver`
`@markuplint/config-presets`

HTML

パッケージ	NPM
`@markuplint/html-parser`
`@markuplint/html-spec`

パーサー

パッケージ	NPM
`@markuplint/parser-utils`
`@markuplint/jsx-parser`
`@markuplint/vue-parser`
`@markuplint/svelte-parser`
`@markuplint/astro-parser`
`@markuplint/alpine-parser`
`@markuplint/pug-parser`
`@markuplint/ejs-parser`
`@markuplint/erb-parser`
`@markuplint/liquid-parser`
`@markuplint/mustache-parser`
`@markuplint/nunjucks-parser`
`@markuplint/php-parser`
`@markuplint/smarty-parser`
`@markuplint/markdown-parser`
`@markuplint/mdx-parser`
`@markuplint/tagged-template-literal-parser`