Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings
This repository was archived by the owner on Jul 15, 2024. It is now read-only.

mollie/crowdin-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

176 Commits

Repository files navigation

Crowdin CLI

A little helper to sync messages with Crowdin. It uses @formatjs/cli to extract messages from your application.

Installation

npm install @mollie/crowdin-cli
# or
yarn add @mollie/crowdin-cli

Usage

In your project, create a .env file and add the following environment-variables:

CROWDIN_PERSONAL_ACCESS_TOKEN={your-access-token}
CROWDIN_PROJECT_ID={your-project-id}
CROWDIN_LANGUAGES=nl,en-US,fr,fr-BE # Comma-separated list of languages

In your package.json, add these scripts:

"crowdin:download": "mollie-crowdin download",
"crowdin:upload": "mollie-crowdin upload './src/**/!(*.{d,test})*.ts*'", // Adjust glob-pattern if necessary
"crowdin:delete-branch": "mollie-crowdin delete-branch"

Extract all messages from your application by using:

$ mollie-crowdin collect './src/**/!(*.{d,test})*.ts*'

Crowdin branch name

By default, @mollie/crowdin-cli will create a branch in Crowdin with the same name as the currently checked out branch in Git. It is possible to override this behaviour by passing a --branch-name option (or -b ) to the upload, download and delete-branch commands. For example, the following command will collect and upload messages to a branch named custom-branch-name in Crowdin.

$ mollie-crowdin upload './src/**/!(*.{d,test})*.ts*' --branch-name 'custom-branch-name'

TypeScript

To write the downloaded messages to TypeScript (.ts) files, pass the --typescript flag to the download command.

"crowdin:download": "mollie-crowdin download --typescript"

Development

Install the dependencies:

 nvm install
 yarn install

About

A Crowdin CLI tool to collect, upload, and download translations from a Crowdin project.

Resources

Security policy

Stars

Watchers

Forks

Packages

Contributors

AltStyle によって変換されたページ (->オリジナル) /