What is micromark-util-normalize-identifier?
The micromark-util-normalize-identifier package is a utility for normalizing identifiers in markdown processing. It ensures that identifiers are consistent and can be compared reliably, which is particularly useful in markdown parsers and processors.
What are micromark-util-normalize-identifier's main functionalities?
Normalize Identifiers
This feature allows you to normalize a given identifier to a consistent format. The example code demonstrates how to normalize an identifier by converting it to lowercase and replacing non-alphanumeric characters with hyphens.
const normalizeIdentifier = require('micromark-util-normalize-identifier');
const id = 'Some-Example_ID';
const normalizedId = normalizeIdentifier(id);
console.log(normalizedId); // Output: 'some-example-id'
Other packages similar to micromark-util-normalize-identifier
slugify
The slugify package converts strings into URL-friendly slugs. It is similar to micromark-util-normalize-identifier in that it normalizes strings, but it is more focused on creating slugs for URLs rather than general identifier normalization.
sanitize-filename
The sanitize-filename package is used to sanitize filenames by removing or replacing invalid characters. While it also deals with string normalization, its primary focus is on ensuring filenames are safe and valid across different filesystems, unlike micromark-util-normalize-identifier which is more general-purpose.
lodash.kebabcase
The lodash.kebabcase package is a utility that converts strings to kebab case. It is similar to micromark-util-normalize-identifier in that it normalizes strings by converting them to a specific case format, but it is part of the larger lodash library which provides a wide range of utility functions.
micromark-util-normalize-identifier
micromark utility normalize identifiers (as found in references, definitions).
Contents
Install
npm:
npm install micromark-util-normalize-identifier
Use
import {normalizeIdentifier} from 'micromark-util-normalize-identifier'
normalizeIdentifier(' a ')
normalizeIdentifier('a\t\r\nb')
normalizeIdentifier('ТОЛПОЙ')
normalizeIdentifier('Толпой')
API
This module exports the following identifiers: normalizeIdentifier
.
There is no default export.
normalizeIdentifier(value)
Normalize an identifier (such as used in definitions).
Collapse Markdown whitespace, trim, and then lower- and uppercase.
Some characters are considered “uppercase”, such as U+03F4 (ϴ
), but if their
lowercase counterpart (U+03B8 (θ
)) is uppercased will result in a different
uppercase character (U+0398 (Θ
)).
Hence, to get that form, we perform both lower- and uppercase.
Using uppercase last makes sure keys will not interact with default prototypal
methods: no method is uppercase.
Parameters
value
(string
) — Identifier to normalize.
Returns
string
— Normalized value.
Security
See security.md
in micromark/.github
for how to
submit a security report.
Contribute
See contributing.md
in micromark/.github
for ways
to get started.
See support.md
for ways to get help.
This project has a code of conduct.
By interacting with this repository, organisation, or community you agree to
abide by its terms.
License
MIT © Titus Wormer