Package

purescript-unicode

Repository
purescript-contrib/purescript-unicode
License
BSD-3-Clause
Uploaded by
thomashoneyman
Published on
2021-02-26

CI Release Pursuit Maintainer: cdepillabout

A library for working with the properties of Unicode code points, including the general category of a code point, predicates for determining whether a code point is a letter or number character (isLetter and isNumber, for example), and case conversion functions (toUpper, toLower, and toTitle, as well as caseFold for caseless matching).

General functions for working with Strings in terms of CodePoints are found in the Data.String.CodePoints module in the strings library.

The version of the Unicode standard supported by this library can be found in the unicode-version file.

Installation

Install unicode with Spago:

spago install unicode

Quick start

The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the docs directory.

Documentation

unicode documentation is stored in a few places:

  1. Module documentation is published on Pursuit.
  2. Written documentation is kept in the docs directory.
  3. Usage examples can be found in the test suite.

If you get stuck, there are several ways to get help:

Contributing

You can contribute to unicode in several ways:

  1. If you encounter a problem or have a question, please open an issue. We'll do our best to work with you to resolve or answer it.

  2. If you would like to contribute code, tests, or documentation, please read the contributor guide. It's a short, helpful introduction to contributing to this library, including development instructions.

  3. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the PureScript Discourse! Writing libraries and learning resources are a great way to help this library succeed.