@emmetio/html-matcher

中文文档
1.3.0发布于 2020/05/27ISCTypeScriptESM + CJS近 30 天下载 2107.2万

最小和超快的 HTML 解析和匹配器

中文使用文档

小而快的 HTML 匹配器

查找 HTML/XML 源代码中指定位置的打开和关闭标签配对 :

import match from '@emmetio/html-matcher';

const content = '<div><a href="http://emmet.io">Example</a></div>';

// Find tag pair at character 35
const tag = match(content, 35);

console.log(tag.name); // Name of matched tag: "a"
console.log(tag.open); // Range of opening tag: [5, 31]
console.log(tag.end); // Range of closing tag: [38, 42]

// List of attributes found in opening tag
console.log(tag.attributes);

默认情况下,匹配者在HTML中工作,这意味着如果找到已知为空的标签名(例如, <img>它不会寻找它即将关闭的部分。 然而,对于XML语法来说,这种行为可能是出乎意料的,因为所有标记都应该是自闭或提供收尾部分. 在这种情况下,你应该通过 xml: true 选项以正确处理 XML 模式 :

import match from '@emmetio/html-matcher';

const content = '<div><img>Caption</img></div>';
const html = match(content, 8);
const xml = match(content, 8, { xml: true });

console.log(html.name); // "img"
console.log(html.open); // [5, 10]
console.log(html.close); // undefined

console.log(xml.name); // "img"
console.log(xml.open); // [5, 10]
console.log(xml.close); // [17, 23]

特殊标签

在HTML中,一些标记有特殊的含义. 例如,a <script> 标签: 在找到关闭前, 其内容应当被完全忽略 </script> 标签。 不过,如果 <script> 标签包含未知 type 属性值,我们应该将其视为一个普通标记。 默认情况下,匹配者会理解 script 财务报告和审定财务报表 style 标记为“ 特殊 ” , 但您可以用 special 选项 :

import match from '@emmetio/html-matcher';

// Treat `<foo-bar>` tag as ”special”: skip its content until `</foo-bar>`. Note that this option overwrites default value with `['script', 'style']` value
match('...', 10, { special: { 'foo-bar': null } });

这个 special 选项是按键为标记名称和值为 type 属性值,如果在标签中存在,则使其具有特殊性。 如果不提供数组,所有带有给定名称的标记将被视为特殊.

版本与发布记录

@emmetio/html-matcher 共发布 15 个版本,首次发布于 2017/03/22;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.3.0latest2020/05/276 年前
1.2.32020/04/156 年前
1.2.22020/04/126 年前
1.2.12020/04/126 年前
1.2.02019/12/076 年前
1.1.22019/10/307 年前

关于 @emmetio/html-matcher 的常见问题

@emmetio/html-matcher 是什么?

最小和超快的 HTML 解析和匹配器

如何安装 @emmetio/html-matcher?

在项目目录运行 npm install @emmetio/html-matcher,或使用 pnpm add / yarn add / bun add。

@emmetio/html-matcher 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@emmetio/html-matcher 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@emmetio/html-matcher 可以商用吗?

@emmetio/html-matcher 使用 ISC 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@emmetio/html-matcher 的下载量有多少?

根据 npm 官方下载统计,@emmetio/html-matcher 在 2026/10/14 – 2026/11/12 这 30 天内被下载 21,072,366 次,日均约 702,412 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@emmetio/html-matcher 还在维护吗?

最新版本 1.3.0 发布于 2020/05/27(6 年前);至今共发布 15 个版本,其中过去 12 个月发布了 0 个;首次发布于 2017/03/22。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。