{"id":20817281,"url":"https://github.com/intlify/poeditor-service-provider","last_synced_at":"2025-05-07T13:34:22.962Z","repository":{"id":38001014,"uuid":"228763537","full_name":"intlify/poeditor-service-provider","owner":"intlify","description":"POEditor service provider for vue-i18n-locale-message","archived":false,"fork":false,"pushed_at":"2023-01-05T03:14:35.000Z","size":1726,"stargazers_count":4,"open_issues_count":13,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-19T21:48:38.928Z","etag":null,"topics":["l10n","localization","vue-i18n","vue-i18n-locale-message"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/intlify.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-12-18T05:16:51.000Z","updated_at":"2022-07-31T22:42:19.000Z","dependencies_parsed_at":"2023-02-03T08:01:25.276Z","dependency_job_id":null,"html_url":"https://github.com/intlify/poeditor-service-provider","commit_stats":null,"previous_names":["kazupon/poeditor-service-provider"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intlify%2Fpoeditor-service-provider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intlify%2Fpoeditor-service-provider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intlify%2Fpoeditor-service-provider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intlify%2Fpoeditor-service-provider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/intlify","download_url":"https://codeload.github.com/intlify/poeditor-service-provider/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252887415,"owners_count":21819894,"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":["l10n","localization","vue-i18n","vue-i18n-locale-message"],"created_at":"2024-11-17T21:40:26.687Z","updated_at":"2025-05-07T13:34:22.941Z","avatar_url":"https://github.com/intlify.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# poeditor-service-provider\n\n[![npm](https://img.shields.io/npm/v/poeditor-service-provider.svg)](https://www.npmjs.com/package/poeditor-service-provider)\n[![CircleCI](https://circleci.com/gh/kazupon/poeditor-service-provider.svg?style=svg)](https://circleci.com/gh/kazupon/poeditor-service-provider)\n\nPOEditor service provider for [vue-i18n-locale-message](https://github.com/kazupon/vue-i18n-locale-message)\n\n\n## :cd: Installation\n\n```bash\n$ npm install -g poeditor-service-provider # or npm install --save-dev poeditor-service-provider\n```\n\ndue to use this provider, you need to install vue-i18n-locale-message beforehand.\n\n```bash\n$ npm install -g vue-i18n-locale-message\n```\n\n\n## :rocket: Usages\n\n### Configurations\n\nBefore you use this provider, you need to configure the following:\n\n```json5\n{\n  \"provider\": {\n    \"id\": \"12345\", // your POEditor project id\n    \"token\": \"xxx...\" // your POEditor API token, if it's ommitted, use the value of `POEDITOR_API_TOKEN` ENV\n  }\n}\n```\n\nAbout details, See the [`POEditorProviderConfiguration`](https://github.com/kazupon/poeditor-service-provider/blob/master/types/index.d.ts).\n\n### Push the locale messages to POEditor\n\n```bash\n$ vue-i18n-locale-message push --provider=poeditor-service-provider \\\n    --conf ./poeditor-service-provider-conf.json \\\n    --target-paths=./src/locales/*.json \\\n    --filename-match=^([\\\\w]*)\\\\.json\n```\n\n### Pull the locale messages from POEditor\n\n```bash\n$ vue-i18n-locale-message pull --provider=poeditor-service-provider \\\n    --conf ./poeditor-service-provider-conf.json \\\n    --output=./src/locales\n```\n\n### Indicate translation status from POEditor\n\n```bash\n$ vue-i18n-locale-message status --provider=poeditor-service-provider \\\n  --conf=poeditor-service-provider-conf.json\n```\n\n### Diff locale messages between local and POEditor\n\n```bash\nvue-i18n-locale-message diff --provider=poeditor-service-provider \\\n  --conf=poeditor-service-provider-conf.json \\\n  --target-paths=./src/locales/*.json \\\n  --filename-match=^([\\\\w]*)\\\\.json\n```\n\n### Import the locale messages to POEditor\n\n```bash\n$ vue-i18n-locale-message import --provider=poeditor-service-provider \\\n    --conf ./poeditor-service-provider-conf.json \\\n    --target=./src/locales/ja.json \\\n    --format=json\n```\n\n### Export the locale messages from POEditor\n\n```bash\n$ vue-i18n-locale-message export --provider=poeditor-service-provider \\\n    --conf ./poeditor-service-provider-conf.json \\\n    --output=./src/locales\n```\n\n\n## :warning: Do you have a hierarchical locale message?\n\nPOEditor will process locale messages with hierarchical structure as `context`.\n\nTherefore, we need to normalize with flat structure , and push it to POEditor.\n\n```bash\n$ vue-i18n-locale-message push --provider=poeditor-service-provider \\\n    --conf ./poeditor-service-provider-conf.json \\\n    --target-paths=./src/locales/*.json \\\n    --nomalize=flat \\\n    --filename-match=^([\\\\w]*)\\\\.json\n```\n\nAnd also, when pulling data from POEditor, it need to normalize from flat structure to hierarchical structure.\n\n```bash\n$ vue-i18n-locale-message pull --provider=poeditor-service-provider \\\n    --conf ./poeditor-service-provider-conf.json \\\n    --nomalize=hierarchy \\\n    --output=./src/locales\n```\n\n## :copyright: License\n\n[MIT](http://opensource.org/licenses/MIT)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintlify%2Fpoeditor-service-provider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintlify%2Fpoeditor-service-provider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintlify%2Fpoeditor-service-provider/lists"}