Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rawleyfowler/sluj
Sluj, the small but mighty slug encoding library for Clojure
https://github.com/rawleyfowler/sluj
clojure slug slugifier slugify sluj url web
Last synced: 3 months ago
JSON representation
Sluj, the small but mighty slug encoding library for Clojure
- Host: GitHub
- URL: https://github.com/rawleyfowler/sluj
- Owner: rawleyfowler
- License: mit
- Created: 2022-05-17T02:13:02.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-11-04T01:40:27.000Z (over 2 years ago)
- Last Synced: 2024-10-11T02:44:55.150Z (4 months ago)
- Topics: clojure, slug, slugifier, slugify, sluj, url, web
- Language: Clojure
- Homepage:
- Size: 294 KB
- Stars: 36
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Sluj
Sluj is a very small library for converting strings of UTF-16 text to slugs. A slug is a piece of text that is URL safe. Sluj can translate a wide variety of characters, including but not limited to cyrillic, and japanese characters.
This library adheres to the following:
-
RFC 3986
-
Dependency-less
Shout out to [Trott/slug](https://github.com/Trott/slug) for inspiring me to make this over a rainy weekend.
## Clojars
This project is available on [Clojars](https://clojars.org/com.github.rawleyfowler/sluj/), and you can add it to your lein project via:
```clojure
[com.github.rawleyfowler/sluj "1.0.2"]
```
## Why?
Currently the most starred Slug clojure project is abandoned by the maintainer, plus it has dependencies. I thought that I could make it better, so I set out on this project.
## Contributing
Particularly looking for contributions to the locale settings of the project, as there is no way I could create a locale for every alphabet myself. Also, the library needs a little work in the multi-byte characters department.
## Examples
```clojure
;; Simple examples
(sluj "Hey it's me!") ;; => hey-its-me
(sluj "25 ways to pet a cat") ;; => 25-ways-to-pet-a-cat
;; UTF-16 examples
(sluj "I ♥ Unicode!") ;; => i-unicode
(sluj "I ♥ Unicode!" :♥ "love") ;; => i-love-unicode
(sluj "Turn this ship 200°!") ;; => turn-this-ship-200
(sluj "Turn this ship 200 °!" :° "degrees") ;; => turn-this-ship-200-degrees
;; Non english characters
;; These were made with google translate, sorry in advanced.
;; Default locale is Russian for Cyrillics
(sluj "маленький подъезд") ;; => malenkij-poduezd
;; Change the locale if you wish
(sluj "маленький подъезд" :locale "bg") ;; => malenykiy-podaezd
;; Change sparator
(sluj "hi mom" :separator "%") ;; => hi%mom
;; Pass the charmap as a argument
(sluj "I have weird characters ☢ ♥" :charmap {:♥ "heart" :☢ :radiate}) ;; => i-have-weird-characters-radiate-heart
;; Alternatively
(sluj "I have weird characters ☢ ♥" :♥ "heart" :☢ "radiate") ;; => i-have-weird-characters-radiate-heart
;; Change the casing
(sluj "make me upper" :casing "upper") ;; => MAKE-ME-UPPER
```
## License
This project is licensed via the MIT license. Please read through the `LICENSE` file at the root of the project for more information.