Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vapor-community/lingo-vapor
Vapor provider for Lingo - the Swift localization library
https://github.com/vapor-community/lingo-vapor
localization server swift vapor vapor-provider
Last synced: about 1 month ago
JSON representation
Vapor provider for Lingo - the Swift localization library
- Host: GitHub
- URL: https://github.com/vapor-community/lingo-vapor
- Owner: vapor-community
- License: mit
- Created: 2017-08-25T16:21:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-10-29T11:56:53.000Z (about 2 years ago)
- Last Synced: 2024-11-11T01:36:02.055Z (about 1 month ago)
- Topics: localization, server, swift, vapor, vapor-provider
- Language: Swift
- Homepage:
- Size: 45.9 KB
- Stars: 57
- Watchers: 4
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lingo Provider
[](http://swift.org)
[](https://raw.githubusercontent.com/vapor-community/markdown-provider/master/LICENSE)
A Vapor provider for [Lingo](https://github.com/miroslavkovac/Lingo) - a pure Swift localization library ready to be used in Server Side Swift projects.
## Setup
### Add a dependancy
Add LingoProvider as a dependancy in your `Package.swift` file:
```swift
dependencies: [
...,
.package(name: "LingoVapor", url: "https://github.com/vapor-community/Lingo-Vapor.git", from: "4.2.0")]
],
targets: [
.target(name: "App", dependencies: [
.product(name: "LingoVapor", package: "Lingo-Vapor")
```
### Upgrading from version 4.1.0 to version 4.2.0
The version 4.1.0 uses the new version of [Lingo](https://github.com/miroslavkovac/Lingo) where the format of locale identifiers was changed to match [RFC 5646](https://datatracker.ietf.org/doc/html/rfc5646). Prior to 4.2.0 `_` was used to separate _language code_ and _country code_ in the locale identifier, and now the library uses `-` as per RFC.
If you were using any locales which include a country code, you would need to rename related translation files to match the new format.
### Add the Provider
In the `configure.swift` simply initialize the `LingoVapor` with a default locale:
```swift
import LingoVapor
...
public func configure(_ app: Application) throws {
...
app.lingoVapor.configuration = .init(defaultLocale: "en", localizationsDir: "Localizations")
}
```
> The `localizationsDir` can be omitted, as the _Localizations_ is also the default path. Note that this folder should exist under the _workDir_.
## Use
After you have configured the provider, you can use `lingoVapor` service to create `Lingo`:
```swift
let lingo = try app.lingoVapor.lingo()
...
let localizedTitle = lingo.localize("welcome.title", locale: "en")
```
To get the locale of a user out of the request, you can use `request.locale`. This uses a language, which is in the HTTP header and which is in your available locales, if that exists. Otherwise it falls back to the default locale. Now you can use different locales dynamically:
```swift
let localizedTitle = lingo.localize("welcome.title", locale: request.locale)
```
When overwriting the requested locale, just write the new locale into the session, e.g. like that:
```swift
session.data["locale"] = locale
```
Use the following syntax for defining localizations in a JSON file:
```swift
{
"title": "Hello Swift!",
"greeting.message": "Hi %{full-name}!",
"unread.messages": {
"one": "You have one unread message.",
"other": "You have %{count} unread messages."
}
}
```
### Locale redirection middleware
In case you want to serv different locales on different subfolders, you can use the `LocaleRedirectMiddleware`.
Add in `configure.swift`:
```swift
import LingoVapor
// Inside `configure(_ app: Application)`:
app.middleware.use(LocaleRedirectMiddleware())
```
Add in `routes.swift`:
```swift
import LingoVapor
// Inside `routes(_ app: Application)`:
app.get("home") { /* ... */ }
app.get(":locale", "home") { /* ... */ } // For each route, add the one prefixed by the `locale` parameter
```
That way, going to `/home/` will redirect you to `//home/` (with `` corresponding to your browser locale), and going to `/fr/home/` will display homepage in french whatever the browser locale is.
### Inside Leaf templates
When using [Leaf](https://github.com/vapor/leaf) as templating engine, you can use `LocalizeTag`, `LocaleTag` and `LocaleLinksTag` from `LingoVaporLeaf` for localization inside the templates.
Add in `configure.swift`:
```swift
import LingoVaporLeaf
// Inside `configure(_ app: Application)`:
app.leaf.tags["localize"] = LocalizeTag()
app.leaf.tags["locale"] = LocaleTag()
app.leaf.tags["localeLinks"] = LocaleLinksTag()
```
Afterwards you can call them inside the Leaf templates:
```html
#localize("thisisthelingokey")
#localize("lingokeywithvariable", "{\"foo\":\"bar\"}")
#localeLinks("http://example.com/", "/canonical/path/")
```
## Learn more
- [Lingo](https://github.com/miroslavkovac/Lingo) - learn more about the localization file format, pluralization support, and see how you can get the most out of the Lingo.