markuplint

Setting for other languages

Install plugins for a language

Install the parser plugin through NPM or Yarn:

$ npm install --save-dev @markuplint/pug-parser
# or
$ yarn add -D @markuplint/pug-parser

If a language has its own specification you should install the spec plugin with the parser plugin:

$ npm install --save-dev @markuplint/jsx-parser @markuplint/react-spec
# or
$ yarn add -D @markuplint/jsx-parser @markuplint/react-spec

$ npm install --save-dev @markuplint/vue-parser @markuplint/vue-spec
# or
$ yarn add -D @markuplint/vue-parser @markuplint/vue-spec

Supported languages

LangParserSpec
Pug@markuplint/pug-parser-
JSX (React etc...)@markuplint/jsx-parser@markuplint/react-spec
Vue@markuplint/vue-parser@markuplint/vue-spec
Svelte@markuplint/svelte-parser-
PHP@markuplint/php-parser-
eRuby@markuplint/erb-parser-
EJS@markuplint/ejs-parser-
Mustache or Handlebars@markuplint/mustache-parser-
Nunjucks@markuplint/nunjucks-parser-
Liquid@markuplint/liquid-parser-

Set to the configuration file

Set about the plugin to the parser option on the configuration file. And If it has spec add to the specs option. Set a regular expression that can identify the target file name to the parser option key.

If you use React.

{
    "parser": {
        ".jsx$": "@markuplint/jsx-parser"
    },
    "specs": ["@markuplint/react-spec"]
}

{
    "parser": {
        ".vue$": "@markuplint/vue-parser"
    },
    "specs": ["@markuplint/vue-spec"]
}

For example, if allow the key attribute you need @markuplint/react-spec or @markuplint/vue-spec because it is not allowed through HTML spec.

const Component = ({ list }) => {
    return (
        <ul>
            {list.map(item => (
                <li key={item.key}>{item.text}</li>
            ))}
        </ul>
    );
};

<template>
    <ul>
        <li v-for="item in list" :key="item.key">{{ item.text }}</li>
    </ul>
</template>