This site uses cookies for analytics. By continuing to browse this site, you agree to this use.

Local

Local (@hint/connector-local)

A local connector to analyze the local files in your project with webhint.

Installation

First, you need to install webhint:

npm install hint

Then, install the new connector:

npm install @hint/connector-local

Usage

Configure the connector name in your .hintrc configuration file:

{
    "connector": {
        "name": "local"
    },
    ...
}

Options

local allows you to configure the following:

  • pattern: Add or ignore files defined in the pattern. By default the local connector will use the following pattern ['**', '!.git/**']. This doesn’t apply if you are targeting just a file or if you are using the options content.
  • watch: Run webhint in watch mode. Watch files and trigger the analysis on changes.
{
    "connector": {
        "name": "local",
        "options": {
            "pattern": ["**", "!.git/**"],
            "watch": false
        }
    },
    ...
}

In addition, the local connector accept a new parameter in the method collect that allow you to pass the content to analyze as an string. To use that property, you need to call to the executeOn method in the engine with the content to analyze.

engine.executeOn(url, {content: '{{your content}}'});

Further Reading