mirror of
https://github.com/Chocobozzz/PeerTube.git
synced 2025-10-04 02:09:37 +02:00
3a4992633e
Sorry for the very big commit that may lead to git log issues and merge
conflicts, but it's a major step forward:
* Server can be faster at startup because imports() are async and we can
easily lazy import big modules
* Angular doesn't seem to support ES import (with .js extension), so we
had to correctly organize peertube into a monorepo:
* Use yarn workspace feature
* Use typescript reference projects for dependencies
* Shared projects have been moved into "packages", each one is now a
node module (with a dedicated package.json/tsconfig.json)
* server/tools have been moved into apps/ and is now a dedicated app
bundled and published on NPM so users don't have to build peertube
cli tools manually
* server/tests have been moved into packages/ so we don't compile
them every time we want to run the server
* Use isolatedModule option:
* Had to move from const enum to const
(https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums)
* Had to explictely specify "type" imports when used in decorators
* Prefer tsx (that uses esbuild under the hood) instead of ts-node to
load typescript files (tests with mocha or scripts):
* To reduce test complexity as esbuild doesn't support decorator
metadata, we only test server files that do not import server
models
* We still build tests files into js files for a faster CI
* Remove unmaintained peertube CLI import script
* Removed some barrels to speed up execution (less imports)
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
# Application localization documentation
|
|
|
|
Source files are in `client/src/locale` and translated files merged from [Weblate](https://weblate.framasoft.org/translate/peertube).
|
|
|
|
|
|
## Generation
|
|
|
|
Will generate XLIFF base files for Angular (`angular.xlf`) and JSON files for the player (`player.en-US.json`) and the server (`server.en-US.json`).
|
|
Then, it will merge new translation keys into localized Angular files (`angular.fr-FR.xlf` etc).
|
|
|
|
```
|
|
npm run i18n:update
|
|
```
|
|
|
|
|
|
## Upload on Weblate
|
|
|
|
Nothing to do here, Github will automatically send a webhook to Weblate that will pull changes.
|
|
|
|
|
|
## Pull translation
|
|
|
|
* First, save translations on Weblate so it commits changes.
|
|
* Then, fetch these commits: `git fetch weblate && git merge weblate/develop`
|
|
|
|
|
|
## Support a new language
|
|
|
|
* Add it to [/packages/models/i18n/i18n.ts](/packages/models/i18n/i18n.ts)
|
|
* Add it to [/scripts/build/client.sh](/scripts/build/client.sh)
|
|
* Add it to [/client/angular.json](/client/angular.json)
|
|
* Add it to [/scripts/i18n/update.sh](/scripts/i18n/update.sh)
|
|
* Lock [weblate project](https://weblate.framasoft.org/projects/peertube)
|
|
* Run `npm run i18n:update`
|
|
* Build the application and check the new language correctly works
|