https://github.com/purescript-contrib/purescript-strings-extra
Additional utilities for the PureScript Strings library.
https://github.com/purescript-contrib/purescript-strings-extra
Last synced: 17 days ago
JSON representation
Additional utilities for the PureScript Strings library.
- Host: GitHub
- URL: https://github.com/purescript-contrib/purescript-strings-extra
- Owner: purescript-contrib
- License: mit
- Created: 2017-09-25T13:45:16.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2022-04-27T22:45:24.000Z (almost 4 years ago)
- Last Synced: 2026-02-11T16:07:22.484Z (about 1 month ago)
- Language: PureScript
- Homepage:
- Size: 124 KB
- Stars: 6
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Strings Extra
[](https://github.com/purescript-contrib/purescript-strings-extra/actions?query=workflow%3ACI+branch%3Amain)
[](https://github.com/purescript-contrib/purescript-strings-extra/releases)
[](http://pursuit.purescript.org/packages/purescript-strings-extra)
Additional utilities for the PureScript Strings library.
## Installation
Install `strings-extra` with [Spago](https://github.com/purescript/spago):
```sh
spago install strings-extra
```
## Quick start
This library provides a simple grab bag of utilities that augment the core `strings` library for PureScript. Install the library and use the functions you need. If you come up with a new function you'd like to upstream to this library, please open a pull request!
```purs
module MyModule where
import Data.String.Extra (words, kebabCase)
kebabCaseAll :: String -> Array String
kebabCaseAll = kebabCase <<< words
```
## Documentation
`strings-extra` documentation is stored in a few places:
1. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-strings-extra).
2. Written documentation is kept in [the docs directory](./docs).
3. Usage examples can be found in [the test suite](./test).
If you get stuck, there are several ways to get help:
- [Open an issue](https://github.com/purescript-contrib/purescript-strings-extra/issues) if you have encountered a bug or problem.
- Ask general questions on the [PureScript Discourse](https://discourse.purescript.org) forum or the [PureScript Discord](https://purescript.org/chat) chat.
## Contributing
You can contribute to `strings-extra` in several ways:
1. If you encounter a problem or have a question, please [open an issue](https://github.com/purescript-contrib/purescript-strings-extra/issues). 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](./CONTRIBUTING.md). 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](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.