{"id":17845732,"url":"https://github.com/guidevloper/i18n-typings","last_synced_at":"2026-04-26T23:31:57.672Z","repository":{"id":57270378,"uuid":"368101263","full_name":"GuiDevloper/i18n-typings","owner":"GuiDevloper","description":":globe_with_meridians: Internationalize JSDoc inside Typescript typing files","archived":false,"fork":false,"pushed_at":"2021-05-29T22:46:17.000Z","size":31,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-08T10:46:51.647Z","etag":null,"topics":["i18n","internationalization","typescript","typescript-definitions"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/GuiDevloper.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":"2021-05-17T07:52:49.000Z","updated_at":"2021-06-23T16:03:07.000Z","dependencies_parsed_at":"2022-09-15T19:10:22.094Z","dependency_job_id":null,"html_url":"https://github.com/GuiDevloper/i18n-typings","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuiDevloper%2Fi18n-typings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuiDevloper%2Fi18n-typings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuiDevloper%2Fi18n-typings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GuiDevloper%2Fi18n-typings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GuiDevloper","download_url":"https://codeload.github.com/GuiDevloper/i18n-typings/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246839330,"owners_count":20842220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","internationalization","typescript","typescript-definitions"],"created_at":"2024-10-27T21:36:47.497Z","updated_at":"2026-04-26T23:31:57.649Z","avatar_url":"https://github.com/GuiDevloper.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# i18n-typings\n\n\u003e Internationalize JSDoc inside Typescript typing files\n\n[![e2e Tests](https://github.com/GuiDevloper/i18n-typings/actions/workflows/main.yml/badge.svg)](https://github.com/GuiDevloper/i18n-typings/actions/workflows/main.yml)\n\n## Purpose\n\nWhile working at [Nullstack](https://github.com/nullstack/nullstack) typings file, the view of VSCode supporting almost instantly any JSDocs typed appeared as a perfect opportunity to seamlessly and minimalistically bring the docs to devs.\n\nAnd, why wouldn't it be internationalized?\n\n## Current Specification\n\nThe [tests](https://github.com/GuiDevloper/i18n-typings/tree/master/tests) folder is where all examples happens.\n\nIn [locales](https://github.com/GuiDevloper/i18n-typings/tree/master/tests/locales) folder all i18n files are stored (all `.js` for limitless possibilities purpose).\n\nThey are read in order as one Array of strings and it's data injected in corresponding comments in the `index.d.ts`, replacing them by a localized version.\n\nIf the quantity of comments in the typing file is different from the i18n, an warning is throw.\n\n## CLI Usage\n\n```sh\n# install globally using npm\nnpm install i18n-typings -g\n# or yarn\nyarn global add i18n-typings\n```\n\ni18n-types CLI can understand a series of commands, which currently are:\n\n```sh\ni18n-types -v # shows installed version\ni18n-types help # shows help information\n\n# use custom i18n files from a path containing a \"locales\" folder\n# replacing/adding to ones at target package (e.g \"i18n-typings\")\ni18n-types --locale \"./my-path\"\n\n# restore backup files previously saved in \"i18n-ts-backup\"\ni18n-types --restore\n\n# create i18n file from comments in the current dir code\n# you can specify the lang you going to contribute (default: en-US)\ni18n-types --create \u003clang\u003e\n```\n\n## [to-do](https://github.com/GuiDevloper/i18n-typings/issues/1)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguidevloper%2Fi18n-typings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguidevloper%2Fi18n-typings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguidevloper%2Fi18n-typings/lists"}