刘宇飞
6e0a1fbcbb
Includes scratch-gui, scratch-vm, scratch-blocks, scratch-render, scratch-l10n, and deployment config. Co-authored-by: Cursor <cursoragent@cursor.com>
69 lines
2.5 KiB
Markdown
69 lines
2.5 KiB
Markdown
# @turbowarp/scratch-l10n
|
|
|
|
This is a modified version of scratch-l10n with translations that aren't used by TurboWarp removed.
|
|
|
|
## Scripts
|
|
|
|
This repository also contains scripts that we use to maintain TurboWarp's translations. They assume you have a directory laid out with `scratch-l10n`, `scratch-gui`, `turbowarp-desktop`, and `packager` in the same parent folder.
|
|
|
|
Download all translations from Transifex:
|
|
|
|
```bash
|
|
npm run tw:pull
|
|
```
|
|
|
|
Upload scratch-gui to Transifex:
|
|
|
|
```bash
|
|
npm run tw:push
|
|
```
|
|
|
|
Publish minified scratch-l10n to npm:
|
|
|
|
```bash
|
|
npm run tw:publish
|
|
```
|
|
|
|
Transifex API token can either be stored in the `TX_TOKEN` environment variable or the `.tx_token` file (ignored by git).
|
|
|
|
<!--
|
|
Translation of all Scratch projects is managed on the Transifex service: https://www.transifex.com/llk/public
|
|
|
|
This repository collects translations submitted to the Scratch projects on Transifex. **Please do not submit PRs. If
|
|
you would like to contribute translations, please sign up to translate on Transifex.**
|
|
|
|
## Using scratch-l10n in development
|
|
|
|
### Basic Use
|
|
|
|
```js
|
|
import locales, {localeData, isRtl} from 'scratch-l10n';
|
|
import editorMessages from 'scratch-l10n/locales/editor-messages';
|
|
```
|
|
|
|
* `locales`: currently supported locales for the Scratch project
|
|
* `isRtl`: function that returns true if the locale is one that is written right-to-left
|
|
* `localeData`: locale data for the supported locales, in the format accepted by `addLocaleData` required by `react-intl`
|
|
* `editorMessages`: the actual message strings for all supported locales for a particular resource. `editorMessages`
|
|
collects all the strings for the interface, extensions and paint-editor.
|
|
|
|
### Useful Scripts
|
|
|
|
scratch-l10n provides:
|
|
|
|
* `build-i18n-src`: script that uses babel and plugins to extract all `FormattedMessage` strings for translation.
|
|
Combines the message from all the source files into one `en.json`
|
|
* `tx-push-src`: script to push the `en.json` file to Transifex. Requires that the environment variable `TX_TOKEN` is
|
|
set with a value that has developer access to the Scratch projects on Transifex (i.e. Scratch Team only)
|
|
|
|
### Versioning
|
|
|
|
`scratch-l10n` uses semantic versioning - breaking changes will increment the major version number, and new features
|
|
(e.g. a new language) will increment the minor version number. Pulling new translations from Transifex is automated
|
|
and will increase the patch version.
|
|
|
|
### Deprecations
|
|
|
|
We are moving away from using the `tx` cli, so the `.tx/config` file will eventually be deprecated.
|
|
-->
|