You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

60 lines
2.0 KiB

3 months ago
  1. # unicode-property-aliases-ecmascript [![Build status](https://travis-ci.org/mathiasbynens/unicode-property-aliases-ecmascript.svg?branch=main)](https://travis-ci.org/mathiasbynens/unicode-property-aliases-ecmascript) [![unicode-property-aliases-ecmascript on npm](https://img.shields.io/npm/v/unicode-property-aliases-ecmascript)](https://www.npmjs.com/package/unicode-property-aliases-ecmascript)
  2. _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).
  3. It’s based on Unicode’s `PropertyAliases.txt`.
  4. ## Installation
  5. To use _unicode-property-aliases-ecmascript_ programmatically, install it as a dependency via [npm](https://www.npmjs.com/):
  6. ```bash
  7. $ npm install unicode-property-aliases-ecmascript
  8. ```
  9. Then, `require` it:
  10. ```js
  11. const propertyAliases = require('unicode-property-aliases-ecmascript');
  12. ```
  13. ## Usage
  14. This module exports a `Map` object. The most common usage is to convert a property alias to its canonical form:
  15. ```js
  16. propertyAliases.get('scx')
  17. // → 'Script_Extensions'
  18. ```
  19. ## For maintainers
  20. ### How to publish a new release
  21. 1. On the `main` branch, bump the version number in `package.json`:
  22. ```sh
  23. npm version patch -m 'Release v%s'
  24. ```
  25. Instead of `patch`, use `minor` or `major` [as needed](https://semver.org/).
  26. Note that this produces a Git commit + tag.
  27. 1. Push the release commit and tag:
  28. ```sh
  29. git push && git push --tags
  30. ```
  31. Our CI then automatically publishes the new release to npm.
  32. ## Author
  33. | [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") |
  34. |---|
  35. | [Mathias Bynens](https://mathiasbynens.be/) |
  36. ## License
  37. _unicode-property-aliases-ecmascript_ is available under the [MIT](https://mths.be/mit) license.