61 lines
2 KiB
Markdown
61 lines
2 KiB
Markdown
|
# unicode-property-aliases-ecmascript [](https://travis-ci.org/mathiasbynens/unicode-property-aliases-ecmascript) [](https://www.npmjs.com/package/unicode-property-aliases-ecmascript)
|
|||
|
|
|
|||
|
|
_unicode-property-aliases-ecmascript_ offers Unicode property alias mappings in an easy-to-consume JavaScript format. It only contains the Unicode property names that are supported in [ECMAScript RegExp property escapes](https://github.com/tc39/proposal-regexp-unicode-property-escapes).
|
|||
|
|
|
|||
|
|
It’s based on Unicode’s `PropertyAliases.txt`.
|
|||
|
|
|
|||
|
|
## Installation
|
|||
|
|
|
|||
|
|
To use _unicode-property-aliases-ecmascript_ programmatically, install it as a dependency via [npm](https://www.npmjs.com/):
|
|||
|
|
|
|||
|
|
```bash
|
|||
|
|
$ npm install unicode-property-aliases-ecmascript
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
Then, `require` it:
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
const propertyAliases = require('unicode-property-aliases-ecmascript');
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Usage
|
|||
|
|
|
|||
|
|
This module exports a `Map` object. The most common usage is to convert a property alias to its canonical form:
|
|||
|
|
|
|||
|
|
```js
|
|||
|
|
propertyAliases.get('scx')
|
|||
|
|
// → 'Script_Extensions'
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## For maintainers
|
|||
|
|
|
|||
|
|
### How to publish a new release
|
|||
|
|
|
|||
|
|
1. On the `main` branch, bump the version number in `package.json`:
|
|||
|
|
|
|||
|
|
```sh
|
|||
|
|
npm version patch -m 'Release v%s'
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
Instead of `patch`, use `minor` or `major` [as needed](https://semver.org/).
|
|||
|
|
|
|||
|
|
Note that this produces a Git commit + tag.
|
|||
|
|
|
|||
|
|
1. Push the release commit and tag:
|
|||
|
|
|
|||
|
|
```sh
|
|||
|
|
git push && git push --tags
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
Our CI then automatically publishes the new release to npm.
|
|||
|
|
|
|||
|
|
## Author
|
|||
|
|
|
|||
|
|
| [](https://twitter.com/mathias "Follow @mathias on Twitter") |
|
|||
|
|
|---|
|
|||
|
|
| [Mathias Bynens](https://mathiasbynens.be/) |
|
|||
|
|
|
|||
|
|
## License
|
|||
|
|
|
|||
|
|
_unicode-property-aliases-ecmascript_ is available under the [MIT](https://mths.be/mit) license.
|