eslint-plugin-microtemplates

ESLint plugin for linting Resig-style microtemplate strings.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
eslint-plugin-microtemplates
0.2.08 years ago8 years agoMinified + gzip package size for eslint-plugin-microtemplates in KB

Readme

eslint-plugin-microtemplates
Build Status npm npm GitHub license Join the chat at https://gitter.im/platinumazure/eslint-plugin-microtemplates
ESLint plugin for linting Resig-style microtemplate strings.

Installation

You'll first need to install ESLint:
$ npm i eslint --save-dev

Next, install eslint-plugin-microtemplates:
$ npm install eslint-plugin-microtemplates --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-microtemplates globally.

Usage

Basic Configuration

Add microtemplates to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
{
    "plugins": [
        "microtemplates"
    ]
}

You should also ensure ESLint will process HTML files. This can be done on the cli or in the CLIEngine API.
CLI:
$> eslint --ext .js,.htm,.html <options> <paths>

CLIEngine:
var CLIEngine = require("eslint").CLIEngine;

var engine = new CLIEngine({
    extensions: [".js", ".htm", ".html"],
    // etc.
});

Avoiding False Positives

You will want to configure ESLint to avoid common false positives. This might mean creating a separate config file for microtemplate use.
Here are some rules that may be worth disabling for microtemplates:
```json {
"rules": {
    "no-undef": 0
}
}