micromark HTML Tag Names Utility

2.0.1 · active · verified Sun Apr 19

micromark-util-html-tag-name is a low-level utility package within the `micromark` ecosystem, providing curated lists of HTML tag names relevant for CommonMark-compliant Markdown parsing. Specifically, it exports `htmlBlockNames` and `htmlRawNames`, which are used by `micromark` to apply specific parsing rules for HTML (flow) constructs. The `htmlBlockNames` array aids in determining when more relaxed parsing rules apply, based on CommonMark's condition 6, while `htmlRawNames` guides the parser on when HTML content can include lines without exiting until a matching closing tag is found (CommonMark's condition 1). This package is currently in its stable version 2.0.1 and is actively maintained as part of the `micromark` monorepo, which generally sees frequent updates, often with performance enhancements, and drops support for unmaintained Node.js versions with new major releases. It's designed for developers building or extending `micromark` itself, rather than for general HTML tag lookup.

Common errors

```
TypeError: require is not a function
```
cause Attempting to import the ESM-only package using CommonJS `require()` syntax.

fix Update your import statement to `import { htmlBlockNames, htmlRawNames } from 'micromark-util-html-tag-name';` and ensure your environment supports ES modules.
```
SyntaxError: Named export 'htmlTagNames' not found. The requested module 'micromark-util-html-tag-name' does not provide an export named 'htmlTagNames'
```
cause Incorrectly trying to import a non-existent default export or an aggregation that doesn't exist.

fix Correct the import to explicitly use the named exports `htmlBlockNames` and `htmlRawNames`: `import { htmlBlockNames, htmlRawNames } from 'micromark-util-html-tag-name';`.

Warnings

breaking This package is ESM-only since its v2 release. Projects must use ES module import syntax (`import`) and a Node.js version that supports ESM.
Fix: Migrate your project to use ES modules and ensure Node.js 16+ is used. Replace `require()` calls with `import` statements.
breaking Major versions of `micromark` packages, including this utility, drop support for unmaintained Node.js versions. Version 2.x requires Node.js 16 or higher.
Fix: Upgrade your Node.js environment to a currently maintained version (e.g., Node.js 16+ for v2.x).
gotcha The exported lists (`htmlBlockNames`, `htmlRawNames`) are specific to `micromark`'s CommonMark parsing implementation. They are not intended as general-purpose, exhaustive lists for all HTML tags or for arbitrary HTML validation/manipulation.
Fix: Understand that these lists reflect CommonMark specifications for Markdown parsing, not general HTML standards. Consult HTML specifications or dedicated HTML parsing libraries for broader use cases.
gotcha The contents of `htmlBlockNames` and `htmlRawNames` can change with updates to the CommonMark specification. For example, 'search' was added to `htmlBlockNames` in CommonMark@0.31, and 'textarea' was added to `htmlRawNames` in CommonMark@0.30.
Fix: Be aware that new CommonMark versions may introduce or remove tags from these lists. If you're building custom extensions, ensure compatibility with the CommonMark version `micromark` targets.

Install

npm install micromark-util-html-tag-name npm
yarn add micromark-util-html-tag-name yarn
pnpm add micromark-util-html-tag-name pnpm

Imports

htmlBlockNames
wrong:
```
const htmlBlockNames = require('micromark-util-html-tag-name').htmlBlockNames
```
correct:
```
import { htmlBlockNames } from 'micromark-util-html-tag-name'
```
This package is ESM-only since v2, requiring ES module import syntax. Attempting CommonJS `require` will result in an error.
htmlRawNames
wrong:
```
const htmlRawNames = require('micromark-util-html-tag-name').htmlRawNames
```
correct:
```
import { htmlRawNames } from 'micromark-util-html-tag-name'
```
This package is ESM-only since v2, requiring ES module import syntax. Attempting CommonJS `require` will result in an error.
all tag names
wrong:
```
import htmlTagNames from 'micromark-util-html-tag-name'
```
correct:
```
import { htmlBlockNames, htmlRawNames } from 'micromark-util-html-tag-name'
```
There is no default export from this module; all exports are named. Attempting to import a default will result in a runtime error.

Quickstart

This quickstart demonstrates how to import and access the `htmlBlockNames` and `htmlRawNames` arrays, detailing their purpose within the micromark parser's logic for handling HTML tags based on CommonMark specifications.

import { htmlBlockNames, htmlRawNames } from 'micromark-util-html-tag-name';

console.log('--- HTML Block Names (CommonMark Condition 6) ---');
console.log('These tags allow more relaxed parsing rules within micromark.');
console.log('Examples:', htmlBlockNames.slice(0, 5).join(', ') + '...');
console.log(`Total block tags: ${htmlBlockNames.length}`);

console.log('\n--- HTML Raw Names (CommonMark Condition 1) ---');
console.log('Content within these tags is treated as raw HTML, without further Markdown parsing, until a closing tag is found.');
console.log('Examples:', htmlRawNames.slice(0, 3).join(', ') + '...');
console.log(`Total raw tags: ${htmlRawNames.length}`);

// This utility package primarily provides these lists for use within the micromark parser.
// It is not intended for general-purpose HTML tag validation or manipulation outside of micromark's context.
// Developers building custom micromark extensions or alternatives might directly consume these lists.

view raw JSON →