AK-21/Graphite-Industrial-Intelligence

1# micromark-util-normalize-identifier2 3[![Build][build-badge]][build]4[![Coverage][coverage-badge]][coverage]5[![Downloads][downloads-badge]][downloads]6[![Size][bundle-size-badge]][bundle-size]7[![Sponsors][sponsors-badge]][opencollective]8[![Backers][backers-badge]][opencollective]9[![Chat][chat-badge]][chat]10 11[micromark][] utility normalize identifiers.12 13## Contents14 15* [What is this?](#what-is-this)16* [When should I use this?](#when-should-i-use-this)17* [Install](#install)18* [Use](#use)19* [API](#api)20  * [`normalizeIdentifier(value)`](#normalizeidentifiervalue)21* [Types](#types)22* [Compatibility](#compatibility)23* [Security](#security)24* [Contribute](#contribute)25* [License](#license)26 27## What is this?28 29This package exposes an algorithm to normalize identifiers found in markdown.30 31## When should I use this?32 33This package might be useful when you are making your own micromark extensions.34 35## Install36 37This package is [ESM only][esm].38In Node.js (version 16+), install with [npm][]:39 40```sh41npm install micromark-util-normalize-identifier42```43 44In Deno with [`esm.sh`][esmsh]:45 46```js47import {normalizeIdentifier} from 'https://esm.sh/micromark-util-normalize-identifier@1'48```49 50In browsers with [`esm.sh`][esmsh]:51 52```html53<script type="module">54  import {normalizeIdentifier} from 'https://esm.sh/micromark-util-normalize-identifier@1?bundle'55</script>56```57 58## Use59 60```js61import {normalizeIdentifier} from 'micromark-util-normalize-identifier'62 63normalizeIdentifier(' a ') // 'A'64normalizeIdentifier('a\t\r\nb') // 'A B'65normalizeIdentifier('ТОЛПОЙ') // 'ТОЛПОЙ'66normalizeIdentifier('Толпой') // 'ТОЛПОЙ'67```68 69## API70 71This module exports the identifier72[`normalizeIdentifier`][api-normalize-identifier].73There is no default export.74 75### `normalizeIdentifier(value)`76 77Normalize an identifier (as found in references, definitions).78 79Collapses markdown whitespace, trim, and then lower- and uppercase.80 81Some characters are considered “uppercase”, such as U+03F4 (`ϴ`), but if their82lowercase counterpart (U+03B8 (`θ`)) is uppercased will result in a different83uppercase character (U+0398 (`Θ`)).84So, to get a canonical form, we perform both lower- and uppercase.85 86Using uppercase last makes sure keys will never interact with default87prototypal values (such as `constructor`): nothing in the prototype of `Object`88is uppercase.89 90###### Parameters91 92* `value` (`string`)93  — identifier to normalize94 95###### Returns96 97Normalized identifier (`string`).98 99## Types100 101This package is fully typed with [TypeScript][].102It exports no additional types.103 104## Compatibility105 106Projects maintained by the unified collective are compatible with maintained107versions of Node.js.108 109When we cut a new major release, we drop support for unmaintained versions of110Node.111This means we try to keep the current release line,112`micromark-util-normalize-identifier@2`, compatible with Node.js 16.113This package works with `micromark@3`.114 115## Security116 117This package is safe.118See [`security.md`][securitymd] in [`micromark/.github`][health] for how to119submit a security report.120 121## Contribute122 123See [`contributing.md`][contributing] in [`micromark/.github`][health] for ways124to get started.125See [`support.md`][support] for ways to get help.126 127This project has a [code of conduct][coc].128By interacting with this repository, organisation, or community you agree to129abide by its terms.130 131## License132 133[MIT][license] © [Titus Wormer][author]134 135<!-- Definitions -->136 137[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg138 139[build]: https://github.com/micromark/micromark/actions140 141[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg142 143[coverage]: https://codecov.io/github/micromark/micromark144 145[downloads-badge]: https://img.shields.io/npm/dm/micromark-util-normalize-identifier.svg146 147[downloads]: https://www.npmjs.com/package/micromark-util-normalize-identifier148 149[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-util-normalize-identifier150 151[bundle-size]: https://bundlejs.com/?q=micromark-util-normalize-identifier152 153[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg154 155[backers-badge]: https://opencollective.com/unified/backers/badge.svg156 157[opencollective]: https://opencollective.com/unified158 159[npm]: https://docs.npmjs.com/cli/install160 161[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c162 163[esmsh]: https://esm.sh164 165[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg166 167[chat]: https://github.com/micromark/micromark/discussions168 169[license]: https://github.com/micromark/micromark/blob/main/license170 171[author]: https://wooorm.com172 173[health]: https://github.com/micromark/.github174 175[securitymd]: https://github.com/micromark/.github/blob/main/security.md176 177[contributing]: https://github.com/micromark/.github/blob/main/contributing.md178 179[support]: https://github.com/micromark/.github/blob/main/support.md180 181[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md182 183[typescript]: https://www.typescriptlang.org184 185[micromark]: https://github.com/micromark/micromark186 187[api-normalize-identifier]: #normalizeidentifiervalue188