Neolithic Prancing Minotaurs

    markuplint
    TypeScript icon, indicating that this package has built-in type declarations

    2.8.0 • Public • Published

    markuplint

    npm version Test Coverage Status

    Peace of mind in your markup - A Linter for All Markup Languages.

    Features

    • Conformance checking that according to HTML Living Standard, WAI-ARIA, and ARIA in HTML.
    • Supports SVG and CSS Values.
    • Supports React, Vue, Svelte, Pug, PHP, and more.
    • Possible to specify the rule to each element if you use the selector.
    • Possible to create a custom rule.

    Screenshot: Violation Report CLI output

    Instant using

    $ npx markuplint target.html
    

    Supported for Node.js v12.4.0 or later.

    Usage

    Initialization

    Create a configuration file and install dependencies.

    $ npx markuplint --init
    # or
    $ yarn run markuplint --init
    

    Answer questions interactively. By doing this, needed modules are installed includes markuplint.

    Add a command to the scripts option on package.json:

    {
      "scripts": {
        "html:lint": "markuplint **/*.html"
      }
    }

    If you want to change the target path, you can change it for your project.

    Execute the script:

    $ npm run html:lint
    # or
    $ yarn html:lint
    

    Command line options

    $ npx markuplint --help
    
    Usage
    	$ markuplint <HTML file pathes (glob format)>
    	$ <stdout> | markuplint
    
    Options
    	--config,                -c FILE_PATH  A configuration file path.
    	--fix,                                 Fix HTML.
    	--format,                -f FORMAT     Output format. Support "JSON", "Simple" and "Standard". Default: "Standard".
    	--no-search-config                     No search a configure file automatically.
    	--ignore-ext                           Evaluate files that are received even though the type of extension.
    	--no-import-preset-rules               No import preset rules.
    	--locale                               Locale of the message of violation. Default is an OS setting.
    	--no-color,                            Output no color.
    	--problem-only,          -p            Output only problems, without passeds.
    	--verbose                              Output with detailed information.
    
    	--init                                 Initialize settings interactively.
    	--create-rule                          Add the scaffold of a custom rule.
    
    	--help,                  -h            Show help.
    	--version,               -v            Show version.
    
    Examples
    	$ markuplint verifyee.html --config path/to/.markuplintrc
    	$ cat verifyee.html | markuplint
    

    Guideline

    Editor Extensions

    Editor Installation Page Author
    Visual Studio Code: markuplint extension Visual Studio Code @YusukeHirao

    License

    FOSSA Status

    Sponsors

    ❤️ Sponsor

    Personal Supporters

    mikimhk Tokitake

    Thanks

    This linter is inspired by:

    Keywords

    none

    Install

    npm i markuplint

    DownloadsWeekly Downloads

    6,124

    Version

    2.8.0

    License

    MIT

    Unpacked Size

    1.88 MB

    Total Files

    59

    Last publish

    Collaborators

    • yusukehirao