{"id":27068278,"url":"https://github.com/oreshinya/purescript-simple-i18n","last_synced_at":"2026-01-20T03:01:33.864Z","repository":{"id":52795064,"uuid":"210157553","full_name":"oreshinya/purescript-simple-i18n","owner":"oreshinya","description":"Type-safe internationalization utilities.","archived":false,"fork":false,"pushed_at":"2022-11-17T11:11:02.000Z","size":149,"stargazers_count":8,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-06T00:22:00.520Z","etag":null,"topics":["i18n","purescript"],"latest_commit_sha":null,"homepage":null,"language":"PureScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oreshinya.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-22T14:07:00.000Z","updated_at":"2025-05-26T11:01:02.000Z","dependencies_parsed_at":"2022-08-22T09:00:53.819Z","dependency_job_id":null,"html_url":"https://github.com/oreshinya/purescript-simple-i18n","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/oreshinya/purescript-simple-i18n","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oreshinya%2Fpurescript-simple-i18n","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oreshinya%2Fpurescript-simple-i18n/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oreshinya%2Fpurescript-simple-i18n/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oreshinya%2Fpurescript-simple-i18n/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oreshinya","download_url":"https://codeload.github.com/oreshinya/purescript-simple-i18n/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oreshinya%2Fpurescript-simple-i18n/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28594958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T02:08:49.799Z","status":"ssl_error","status_checked_at":"2026-01-20T02:08:44.148Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["i18n","purescript"],"created_at":"2025-04-05T20:36:57.474Z","updated_at":"2026-01-20T03:01:33.847Z","avatar_url":"https://github.com/oreshinya.png","language":"PureScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# purescript-simple-i18n\n\n[![Latest release](http://img.shields.io/github/release/oreshinya/purescript-simple-i18n.svg)](https://github.com/oreshinya/purescript-simple-i18n/releases)\n\nType-safe internationalization utilities.\n\n## Installation\n\n### Bower\n\n```\n$ bower install purescript-simple-i18n\n```\n\n### Spago\n\n```\n$ spago install simple-i18n\n```\n\n## Usage\n\n### Define labels\n\nYou can define labels **with typelevel string list** for translation.\n\nThis force you to translate all labels **without excess and deficiently**.\n\n**NOTE: Labels should be ordered alphabetically.**\n\n```purescript\nimport Record.Extra (type (:::), SNil)\n\n-- Symbols should be in alphabetic order.\ntype Labels =\n    ( \"apple\"\n  ::: \"banana\"\n  ::: \"grape\"\n  ::: SNil\n    )\n```\n\n### Define translations\n\nYou can define translations with `Simple.I18n.Translation` module.\n\n```purescript\nimport Simple.I18n.Translation (Translation, fromRecord)\n\nen :: Translation Labels\nen = fromRecord\n  { apple: \"Apple\"\n  , banana: \"Banana\"\n  , grape: \"Grape\"\n  }\n\nja :: Translation Labels\nja = fromRecord\n  { apple: \"りんご\"\n  , banana: \"バナナ\"\n  , grape: \"ぶどう\"\n  }\n```\n\n### Create translator\n\nNext step is creating translator with `Simple.I18n.Translator` module.\n\nPass fallback language and translations to `createTranslator`.\n\n```purescript\nimport Simple.I18n.Translator (Translator, createTranslator, label, setLang, translate)\nimport Type.Proxy (Proxy(..))\n\ntranslator :: Translator Labels\ntranslator =\n  createTranslator\n    (Proxy :: _ \"en\") -- Fallback language (and default language)\n    { en, ja } -- Translations\n```\n\n### Change language setting\n\nYou can set language with `setLang`.\n\n```purescript\nimport Prelude\n\nimport Simple.I18n.Translator (Translator, createTranslator, label, setLang, translate)\n\nmain :: Effect Unit\nmain = do\n  let translator' = translator # setLang \"ja\"\n  -- some codes\n```\n\nYou might think \"Why can `setLang` receive `String` instead of `Proxy`?\".\n\nThe reason is that we get language setting from outside of PureScript like `navigator.language`, `localStorage`, `subdomain`, `path`, `query parameter`, or others in most cases.\n\nSo `String` is enough.\n\n### Translate\n\nYou can get translation type-safely.\n\n```purescript\nimport Prelude\n\nimport Simple.I18n.Translator (Translator, createTranslator, label, setLang, translate)\nimport Type.Proxy (Proxy(..))\n\ntranslator :: Translator Labels\ntranslator =\n  createTranslator\n    (Proxy :: _ \"en\") -- Fallback language (and default language)\n    { en, ja } -- Translations\n\nmain :: Effect Unit\nmain = do\n  log $ translator # translate (label :: _ \"apple\") -- \"Apple\"\n  let translator' = translator # setLang \"ja\"\n  log $ translator' # translate (label :: _ \"apple\") -- \"りんご\"\n  -- some codes\n```\n\n## Documentation\n\nModule documentation is [published on Pursuit](http://pursuit.purescript.org/packages/purescript-simple-i18n).\n\n## LICENSE\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foreshinya%2Fpurescript-simple-i18n","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foreshinya%2Fpurescript-simple-i18n","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foreshinya%2Fpurescript-simple-i18n/lists"}