开源项目 `eslint-plugin-no-unsanitized` 使用教程

开源项目 eslint-plugin-no-unsanitized 使用教程

eslint-plugin-no-unsanitizedCustom ESLint rule to disallows unsafe innerHTML, outerHTML, insertAdjacentHTML and alike项目地址:https://gitcode.com/gh_mirrors/es/eslint-plugin-no-unsanitized

1. 项目的目录结构及介绍

eslint-plugin-no-unsanitized/
├── docs/
│   ├── rules/
│   │   ├── customization.md
│   │   ├── method.md
│   └── README.md
├── lib/
│   ├── rules/
│   │   ├── method.js
│   └── index.js
├── tests/
│   ├── lib/
│   │   ├── rules/
│   │   │   ├── method.js
│   └── index.js
├── .eslintrc.json
├── package.json
└── README.md

目录结构介绍

• docs/: 包含项目的文档，特别是规则的详细说明。
  • rules/: 包含各个规则的详细文档，如 customization.md 和 method.md。
• lib/: 包含项目的主要代码。
  • rules/: 包含各个规则的实现代码，如 method.js。
  • index.js: 项目的入口文件。
• tests/: 包含项目的测试代码。
  • lib/rules/: 包含各个规则的测试代码，如 method.js。
• .eslintrc.json: 项目的 ESLint 配置文件。
• package.json: 项目的依赖管理文件。
• README.md: 项目的介绍和使用说明。

2. 项目的启动文件介绍

项目的启动文件是 lib/index.js。这个文件是整个插件的入口，负责加载和初始化所有的规则。

// lib/index.js
module.exports = {
  rules: {
    method: require('./rules/method')
  }
};

启动文件介绍

• module.exports: 导出一个对象，包含所有的规则。
• rules/method: 加载并导出 method 规则的实现。

3. 项目的配置文件介绍

项目的配置文件是 .eslintrc.json。这个文件定义了 ESLint 的配置，包括插件的加载和规则的启用。

{
  "plugins": ["no-unsanitized"],
  "rules": {
    "no-unsanitized/method": "error"
  }
}

配置文件介绍

• plugins: 指定要加载的 ESLint 插件，这里是 no-unsanitized。
• rules: 定义要启用的规则，这里是 no-unsanitized/method，并且设置为 error 级别。

通过以上配置，项目可以确保在使用 insertAdjacentHTML、document.write 或 document.writeln 等方法时，进行必要的安全检查，避免跨站脚本攻击（XSS）。

eslint-plugin-no-unsanitizedCustom ESLint rule to disallows unsafe innerHTML, outerHTML, insertAdjacentHTML and alike项目地址:https://gitcode.com/gh_mirrors/es/eslint-plugin-no-unsanitized