sanitize-html 开源项目教程

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

sanitize-html 是一个用于净化 HTML 的 Node.js 模块，其目录结构相对简单。以下是主要的目录和文件介绍：

• / (根目录)
  • index.js: 项目的主入口文件。
  • package.json: 项目的依赖和元数据配置文件。
  • README.md: 项目的说明文档。
  • test/: 包含项目的测试文件。
    • test.js: 主要的测试文件。
  • lib/: 包含项目的核心代码。
    • sanitize-html.js: 核心的净化 HTML 功能的实现文件。

2. 项目的启动文件介绍

sanitize-html 的启动文件是 index.js，它导入了 lib/sanitize-html.js 中的主要功能，并提供了对外的接口。以下是 index.js 的主要内容：

'use strict';

module.exports = require('./lib/sanitize-html');

这个文件非常简洁，主要作用是引入并导出 lib/sanitize-html.js 中的功能。

3. 项目的配置文件介绍

sanitize-html 的配置文件是 package.json，它包含了项目的依赖、脚本、版本信息等。以下是 package.json 的主要内容：

{
  "name": "sanitize-html",
  "version": "2.7.0",
  "description": "Clean up user-submitted HTML, preserving whitelisted elements and whitelisted attributes on a per-element basis",
  "main": "index.js",
  "scripts": {
    "test": "mocha --reporter spec --timeout 10000"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/apostrophecms/sanitize-html.git"
  },
  "keywords": [
    "html",
    "sanitize",
    "parser",
    "sanitizer",
    "apostrophe"
  ],
  "author": "Apostrophe Technologies",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/apostrophecms/sanitize-html/issues"
  },
  "homepage": "https://github.com/apostrophecms/sanitize-html#readme",
  "dependencies": {
    "htmlparser2": "^6.0.0",
    "lodash": "^4.17.21",
    "postcss": "^8.2.15",
    "postcss-safe-parser": "^5.0.2",
    "style-to-object": "^0.3.0"
  },
  "devDependencies": {
    "chai": "^4.3.4",
    "eslint": "^7.26.0",
    "eslint-config-standard": "^16.0.2",
    "eslint-plugin-import": "^2.23.2",
    "eslint-plugin-node": "^11.1.0",
    "eslint-plugin-promise": "^4.3.1",
    "eslint-plugin-standard": "^5.0.0",
    "mocha": "^8.4.0"
  }
}

这个文件定义了项目的名称、版本、描述、主入口文件、脚本、依赖等信息。通过这个文件，用户可以了解项目的依赖关系和如何运行测试。