@morgan-stanley/eslint-plugin-externalincludes
v0.0.1
Published
Suite of @html-eslint ESLint rules for working with external references such as script src and link hrefs
Downloads
3
Readme
eslint-plugin-externalincludes
Suite of @html-eslint ESLint rules for working with external references such as script src and link hrefs.
Installation
You'll first need to install ESLint:
npm i eslint --save-dev
Next, install @morgan-stanley/eslint-plugin-externalincludes
:
npm install @morgan-stanley/eslint-plugin-externalincludes --save-dev
While @morgan-stanley/eslint-plugin-externalincludes
installs @html-eslint/eslint-plugin and @html-eslint/parser as peerDependencies you can optionally install directly.
Usage
Update your .eslintrc
configuration file to add ESLint override for html files to specify the @html-eslint/parser and extend recommended rules if desired.
Add @html-eslint
and externalincludes
to the plugins section.
You can omit the eslint-plugin-
prefix:
overrides: [
{
files: ["*.html"],
parser: "@html-eslint/parser",
extends: ["plugin:@html-eslint/recommended"],
},
],
plugins: [
"@html-eslint",
"@morgan-stanley/externalincludes"
],
Then configure the rules you want to use under the rules section:
{
"rules": {
"@morgan-stanley/externalincludes/enforce-no-external-url": "error",
"@morgan-stanley/externalincludes/require-script-integrity": "error",
}
}
If you are using the VS Code ESLint extension, update settings.json to include validation of html:
{
"eslint.enable": true,
"eslint.validate": ["javascript", "html"]
}
Rules
| Name | Description |
| :----------------------------------------------------------------- | :----------------------------------------------- |
| enforce-no-external-url | Disallow external includes. |
| require-script-integrity | Require integrity
attribute at <script>
tag. |