{"id":13679084,"url":"https://github.com/locize/translation-check","last_synced_at":"2025-04-29T16:30:57.780Z","repository":{"id":40528591,"uuid":"378131471","full_name":"locize/translation-check","owner":"locize","description":"This package shows an overview of your translations. Check which keys are not yet translated.","archived":false,"fork":false,"pushed_at":"2023-11-10T21:55:30.000Z","size":147,"stargazers_count":116,"open_issues_count":1,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-11-03T14:41:02.165Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/locize.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-06-18T11:40:07.000Z","updated_at":"2024-09-30T13:15:33.000Z","dependencies_parsed_at":"2023-11-10T22:41:10.437Z","dependency_job_id":null,"html_url":"https://github.com/locize/translation-check","commit_stats":{"total_commits":7,"total_committers":1,"mean_commits":7.0,"dds":0.0,"last_synced_commit":"45dc244c3690975d4511cc1fe041f96fb590f479"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/locize%2Ftranslation-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/locize%2Ftranslation-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/locize%2Ftranslation-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/locize%2Ftranslation-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/locize","download_url":"https://codeload.github.com/locize/translation-check/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224179335,"owners_count":17269047,"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":[],"created_at":"2024-08-02T13:01:01.780Z","updated_at":"2024-11-11T21:32:17.828Z","avatar_url":"https://github.com/locize.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Introduction\n\n[![npm version](https://img.shields.io/npm/v/translation-check.svg?style=flat-square)](https://www.npmjs.com/package/translation-check)\n\nThis package shows an overview of your translations. Check which keys are not yet translated.\n\n![](preview.jpg)\n\n# Getting started\n\nSource can be loaded via [npm](https://www.npmjs.com/package/translation-check) or via [jsdelivr CDN](https://cdn.jsdelivr.net/npm/translation-check/dist/umd/translationCheck.js).\n\n```bash\n# npm package\n$ npm install translation-check\n```\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/translation-check/dist/umd/translationCheck.min.js\" \u003e\u003c/script\u003e\n\u003cscript\u003e\n  // window.translationCheck.i18nextPlugin\n  // window.translationCheck.showTranslations()\n\u003c/script\u003e\n```\n\n\n## Usage with i18next\n\n### Use it as plugin:\n\n```js\nimport i18next from 'i18next'\nimport { i18nextPlugin } from 'translation-check'\n\ni18next.use(i18nextPlugin).init({\n  // ...your i18next options\n})\n// or with custom options\n// i18next.use(i18nextPlugin).init({\n//   translationStats: { // optional options, if not provided it will guess based on your i18next config\n//     queryStringParam: 'showtranslations',\n//     sourceLng: 'en',\n//     targetLngs: ['de', 'it'],\n//     preserveEmptyStrings: false\n//   }\n// })\n```\n\nThen open your app or website and add `?showtranslations` in your url, i.e. `http://localhost:3000?showtranslations`.\n\n\n### Alternatively, call it after i18next has loaded all your translations:\n\n```js\nimport i18next from 'i18next'\nimport { showTranslations } from 'translation-check'\n\ni18next.init({\n  // ...your i18next options\n}, (err, t) =\u003e {\n  // ...\n  // somewhere in your UI create a button or link or similar, like that:\n  $('#open-editor').click(() =\u003e {\n    showTranslations(i18next)\n    // showTranslations(i18next, { // optional options, if not provided it will guess based on your i18next config\n    //   sourceLng: 'en',\n    //   targetLngs: ['de', 'it'],\n    //   preserveEmptyStrings: false\n    // }) \n  })\n})\n```\n\n\n## Usage without i18next\n\n```js\nimport { showTranslations } from 'translation-check'\n\n// ...\n// somewhere in your UI create a button or link or similar, like that:\n$('#open-editor').click(() =\u003e {\n  showTranslations({\n    en: {\n      // this is a namespace, you can also have multiple namespaces\n      translation: {\n        salutation: 'hello world'\n      },\n      anotherNS: {\n        nice: 'This is a nice day!'\n      }\n    },\n    de: {\n      translation: {\n        salutation: 'hallo welt'\n      },\n      anotherNS: {\n        nice: 'Es ist ein schöner Tag!'\n      }\n    }\n  })\n})\n```\n\n# What's that mini.locize.com?\n\nThe overview of your translations is displayed in a React.js app hosted on Github pages.\n\nThis is all done on the client side only, which means locize does NOT collect ANY of your data.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocize%2Ftranslation-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flocize%2Ftranslation-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocize%2Ftranslation-check/lists"}