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.

69 lines
2.4 KiB

3 months ago
  1. # unicode-match-property-ecmascript [![Build status](https://travis-ci.org/mathiasbynens/unicode-match-property-ecmascript.svg?branch=main)](https://travis-ci.org/mathiasbynens/unicode-match-property-ecmascript) [![unicode-match-property-ecmascript on npm](https://img.shields.io/npm/v/unicode-match-property-ecmascript)](https://www.npmjs.com/package/unicode-match-property-ecmascript)
  2. _unicode-match-property-ecmascript_ matches a given Unicode property or [property alias](https://github.com/mathiasbynens/unicode-property-aliases-ecmascript) to its canonical property name without applying [loose matching](https://github.com/mathiasbynens/unicode-loose-match) per the algorithm used for [RegExp Unicode property escapes in ECMAScript](https://github.com/tc39/proposal-regexp-unicode-property-escapes). Consider it a strict alternative to loose matching.
  3. ## Installation
  4. To use _unicode-match-property-ecmascript_ programmatically, install it as a dependency via [npm](https://www.npmjs.com/):
  5. ```bash
  6. $ npm install unicode-match-property-ecmascript
  7. ```
  8. Then, `require` it:
  9. ```js
  10. const matchProperty = require('unicode-match-property-ecmascript');
  11. ```
  12. ## API
  13. This module exports a single function named `matchProperty`.
  14. ### `matchProperty(value)`
  15. This function takes a string `value` and attempts to match it to a canonical Unicode property name. If there’s a match, it returns the canonical property name. Otherwise, it throws an exception.
  16. ```js
  17. // Find the canonical property name:
  18. matchProperty('sc')
  19. // → 'Script'
  20. matchProperty('Script')
  21. // → 'Script'
  22. matchProperty('script') // Note: incorrect casing.
  23. // → throws
  24. ```
  25. ## For maintainers
  26. ### How to publish a new release
  27. 1. On the `main` branch, bump the version number in `package.json`:
  28. ```sh
  29. npm version patch -m 'Release v%s'
  30. ```
  31. Instead of `patch`, use `minor` or `major` [as needed](https://semver.org/).
  32. Note that this produces a Git commit + tag.
  33. 1. Push the release commit and tag:
  34. ```sh
  35. git push && git push --tags
  36. ```
  37. Our CI then automatically publishes the new release to npm.
  38. ## Author
  39. | [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") |
  40. |---|
  41. | [Mathias Bynens](https://mathiasbynens.be/) |
  42. ## License
  43. _unicode-match-property-ecmascript_ is available under the [MIT](https://mths.be/mit) license.