https://github.com/taoensso/tempura
Simple text localization library for Clojure/Script
https://github.com/taoensso/tempura
clojure clojurescript epl gettext i18n taoensso translation
Last synced: about 2 months ago
JSON representation
Simple text localization library for Clojure/Script
- Host: GitHub
- URL: https://github.com/taoensso/tempura
- Owner: taoensso
- License: epl-1.0
- Created: 2016-01-24T05:38:39.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-19T14:14:44.000Z (about 1 year ago)
- Last Synced: 2024-05-01T18:54:39.037Z (about 1 year ago)
- Topics: clojure, clojurescript, epl, gettext, i18n, taoensso, translation
- Language: Clojure
- Homepage: https://www.taoensso.com/tempura
- Size: 122 KB
- Stars: 255
- Watchers: 7
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
[**API**][cljdoc docs] | [**Wiki**][GitHub wiki] | [Latest releases](#latest-releases) | [Slack channel][]
# Tempura
### Simple text localization library for Clojure/Script
**Tempura** is mature, developer-friendly library for supporting **multilingual text** in your Clojure and ClojureScript applications.
It offers a simple, easy-to-use API that allows you to **expand localization content over time**, without bogging down early development.
## Latest release/s
- `2024-06-05` `v1.5.4`: [release info](../../releases/tag/v1.5.4)
[![Main tests][Main tests SVG]][Main tests URL]
[![Graal tests][Graal tests SVG]][Graal tests URL]
See [here][GitHub releases] for earlier releases.
## Why Tempura?
- Tiny (**single fn**), **cross-platform all-Clojure API** for providing multilingual text content.
- Matches [gettext](https://en.wikipedia.org/wiki/Gettext)'s convenience for **embedding default content** directly in code (optional).
- Exceeds [gettext](https://en.wikipedia.org/wiki/Gettext)'s ability to handle **versioned content** through unique content ids.
- Works out-the-box with plain text, Hiccup, **Reactjs**, etc.
- Easy, optional platform-appropriate support for simple **Markdown styles**.
- **Flexibility**: completely open/pluggable resource compiler.
- **Performance**: match or exceed `format` performance through compilation + smart caching.
- All-Clojure **(edn) dictionary format** for ease of use, easy compile-**and-runtime** manipulation, etc.
- Focused on common-case **translation** and no other aspects of i18n/L10n.
## 10-second example
```clojure
(require '[taoensso.tempura :as tempura :refer [tr]]))
(tr ; For "translate"
{:dict ; Dictionary of translations
{:sw {:missing "sw/?" :r1 "sw/r1" :r2 "sw/r2"}
:en {:missing "en/?" :r1 "en/r1" :r2 "en/r2"}}}
[:sw :en <...>] ; Locales (desc priority)
[:r1 :r2 <...> ; Resources (desc priority)
; Optional final fallback string
])
;; =>
(or
sw/r1 sw/r2 <...> ; Descending-priority resources in priority-1 locale
en/r1 en/r2 <...> ; '' in priority-2 locale
<...>
?fallback-str ; Optional fallback string (as last element in resources vec)
sw/? ; Missing (error) resource in priority-1 locale
en/? ; '' priority-2 locale
nil ; If none of the above exist
)
;; etc.
;; Note that ?fallback-str is super handy for development before you
;; have translations ready, e.g.:
(tr {:dict {}} [:en] [:sign-in-btn "Sign in here!"])
;; => "Sign in here!"
;; Tempura also supports Hiccup with Markdown-like styles, e.g.:
(tr {:dict {}} [:en] [:sign-in-btn ["**Sign in** here!"]])
;; => [:span [:strong "Sign in"] " here!"]
```
## Documentation
- [Wiki][GitHub wiki] (getting started, usage, etc.)
- API reference: [cljdoc][cljdoc docs], [Codox][Codox docs]
- Support: [Slack channel][] or [GitHub issues][]
## Funding
You can [help support][sponsor] continued work on this project, thank you!! 🙏
## License
Copyright © 2016-2024 [Peter Taoussanis][].
Licensed under [EPL 1.0](LICENSE.txt) (same as Clojure).
[GitHub releases]: ../../releases
[GitHub issues]: ../../issues
[GitHub wiki]: ../../wiki
[Slack channel]: https://www.taoensso.com/slack
[Peter Taoussanis]: https://www.taoensso.com
[sponsor]: https://www.taoensso.com/sponsor
[Codox docs]: https://taoensso.github.io/tempura/
[cljdoc docs]: https://cljdoc.org/d/com.taoensso/tempura/
[Clojars SVG]: https://img.shields.io/clojars/v/com.taoensso/tempura.svg
[Clojars URL]: https://clojars.org/com.taoensso/tempura
[Main tests SVG]: https://github.com/taoensso/tempura/actions/workflows/main-tests.yml/badge.svg
[Main tests URL]: https://github.com/taoensso/tempura/actions/workflows/main-tests.yml
[Graal tests SVG]: https://github.com/taoensso/tempura/actions/workflows/graal-tests.yml/badge.svg
[Graal tests URL]: https://github.com/taoensso/tempura/actions/workflows/graal-tests.yml