i18n Milestone 2: Framework and build tools #15502

ErisDS · 2022-09-29T14:50:19Z

This issue represents a single milestone within our i18n project. The full project is documented on the Ghost forum.

Expected structure

A new ghost/locales folder in the monorepo contains namespaced JSON files e.g. locales/es/common.json, /ocales/es/portal.json, locales/es/email.json
For Node.js/email-templates we do one of:
- (Preferred) The correct path is loaded from config based on environment
- ghost/locales gets copied into ghost/core somehow
Then for react:
- Use code-splitting to generate individual versions of portal for each supported locale.

Goals:

Get the basic pieces of i18next in place & configured according to the tech spec
Implement the expected structure (see above)
Figure out if we need to switch to vitejs in Portal to achieve the desired build (may need help from Ghost team)
Have 1 interpolated string in each of email and Portal
Tooling for extracting strings & generating files

Tasks:

Move Portal into the monorepo (Ghost team to complete soon)
Demo/spike of the build tool for Portal - I think this is the hardest part so we should do it first
Demo/spike of how locale files get pulled into Node.js for email templates
Demo/spike of i18next wiring so that there's one interpolated string in Portal and one in an email template
Demo/spike of a tooling that can grab the 2 interpolated strings e.g. yarn translate es would create /locales/es/portal.js and /locales/es/email.js each containing one string.

I'm hoping to find people interested in the different parts to do initial spike implementations - then we can figure out the tasks more clearly.

Notes on participating & Hacktoberfest:

We aren't going to merge half-baked spikes or wiring that doesn't match the spec yet - so if you're just trying to get through Hacktoberfest as fast as possible, this is not the issue for you! (There are plenty of small bugs though!)

However, if you're using Hacktoberfest as a vehicle to find a cool & meaningful project to work on, this should be well up your street :)

We'll do our best to ensure that those who actively contribute value to this project get something merged and appropriately labelled by the end of Hacktoberfest 🎃

👉 If you're interested, drop a note to say Hi and which part you're interested in before getting stuck in, just in case we end up with multiple people trying to get the same things merged.

The text was updated successfully, but these errors were encountered:

ErisDS · 2022-10-07T19:17:14Z

Portal is now officially part of the monorepo and the dev workflow is working really well.

By default yarn dev will pull the latest release of portal from jsDelivr. If you're actively working on Portal, you can run yarn dev --portal and you'll get your live local version of portal as well as Ghost & Ghost Admin 🙌

Would love to get some volunteers to start wiring up i18next.

refs #15502 - this is an early implementation of an i18n provider by exporting an instance of `i18next` - there's a lot more to be done here but baby steps :)

refs #15502 - plain JSON files are cleaner and less overwhelming than boilerplate JS files, and given they're going to be automatically generated, we probably won't be able to support comments anyway

refs #15502 - the amazing `i18next-parser` dependency will extract our translated strings from Portal and dump them into locale files, so we never have to add them manually

refs #15502 - prevent it from creating `_old` files - set JSON indentation to 4 spaces

refs #15502 - this will test if we have strings that aren't present in the JSON files in CI, so we don't miss out on translations

refs #15502 - needed to add the `i18n` tests so we don't lose the "Hello" test I wrote, and keeping everything under one command is easier

refs #15502 - this adds the package to Portal and integrates it into the state we pass around - note: I've currently left the detection of the language (`site.locale`) commented for now until we flesh more of the implementation out

refs #15502 - in the event the value is an empty string, we want to return the key - this config option enables that

refs #15502 - this allows use of the `t` function whilst running tests

refs #15502 - in order to use the translations, strings must be wrapped in the `t` function, which is passed through AppContext - whilst I haven't instrumented all public strings, the vast majority are done here and the strings have been brought into the JSON locale files using `yarn translate:generate`

refs #15502 - this adds support for namespaces to the i18n package so we can separate translations for different packages

refs #15502 - this adds the scaffolding for enabling i18n translations within Ghost core - also adds `yarn translate:ghost` as an option to the `i18n` package - the locale is currently hardcoded to `en` so we don't utilize the translations until we're ready

refs #15502 - this adds the i18n translation wrapper to the titles, plaintext versions and one HTML version of the member emails

refs #15502 - this commit migrates Portal from CRA to Vite, as it brings the package more inline with the direction we're going in terms of tooling for builds - the bulk of the changes here are just config related to get things working with Vite, and then cleaning up all the CRA boilerplate

refs #15502 - this adds the i18n translation wrapper to the titles, plaintext versions and one HTML version of the member emails

refs #15502 - this commit migrates Portal from CRA to Vite, as it brings the package more inline with the direction we're going in terms of tooling for builds - the bulk of the changes here are just config related to get things working with Vite, and then cleaning up all the CRA boilerplate

refs #15502 - this makes the translations files a lot nicer because they only contain one line per key

refs #15502 - these aren't going to change across languages so we can exclude them from the strings to simplify things

daniellockyer · 2023-03-20T07:37:20Z

Hi all! 👋🏻 The tasks above has been completed and milestone 2 is complete 🙂 We're doing some testing internally and then we'll look at opening it up to translations 🕺🏻

ErisDS added help wanted [triage] Ideal issues for contributors to help with feature [triage] New features we're planning or working on Hacktoberfest Issues suitable for hacktoberfest participants labels Sep 29, 2022

ErisDS mentioned this issue Sep 29, 2022

Hacktoberfest 2022 #15503

Closed

This was referenced Oct 13, 2022

🐛 Fixed redirects with special characters #15533

Merged

🐛 Fixed embedded cards for non-utf8 content #15578

Merged

illiteratewriter mentioned this issue Oct 21, 2022

Added e2e tests for member.edited webhook #15620

Merged

daniellockyer self-assigned this Jan 16, 2023

daniellockyer mentioned this issue Jan 18, 2023

Added i18n package #16145

Merged

daniellockyer added a commit that referenced this issue Jan 18, 2023

Added i18n package

6c1e6eb

refs #15502 - this is an early implementation of an i18n provider by exporting an instance of `i18next` - there's a lot more to be done here but baby steps :)

daniellockyer added a commit that referenced this issue Jan 18, 2023

Added i18n package

0d9268a

refs #15502 - this is an early implementation of an i18n provider by exporting an instance of `i18next` - there's a lot more to be done here but baby steps :)

daniellockyer added a commit that referenced this issue Jan 18, 2023

Added yarn translate:portal command

2cf1611

refs #15502 - the amazing `i18next-parser` dependency will extract our translated strings from Portal and dump them into locale files, so we never have to add them manually

daniellockyer added a commit that referenced this issue Jan 18, 2023

Configured i18next-parser settings

fbbea1c

refs #15502 - prevent it from creating `_old` files - set JSON indentation to 4 spaces

daniellockyer added a commit that referenced this issue Jan 19, 2023

Added CI test to ensure i18n strings are extracted out

1f32a7b

refs #15502 - this will test if we have strings that aren't present in the JSON files in CI, so we don't miss out on translations

daniellockyer added a commit that referenced this issue Feb 20, 2023

Renamed yarn translate:portal to yarn translate:generate

badbdbb

refs #15502 - needed to add the `i18n` tests so we don't lose the "Hello" test I wrote, and keeping everything under one command is easier

daniellockyer added a commit that referenced this issue Feb 27, 2023

Fixed returning key when value is empty string

2804445

refs #15502 - in the event the value is an empty string, we want to return the key - this config option enables that

daniellockyer added a commit that referenced this issue Feb 27, 2023

Added i18n translate function to test context

e630acd

refs #15502 - this allows use of the `t` function whilst running tests

daniellockyer mentioned this issue Feb 27, 2023

Added translation wrapper to public-facing strings in Portal #16336

Merged

daniellockyer added a commit that referenced this issue Mar 1, 2023

Added support for namespaces to i18n package

6d8ca23

refs #15502 - this adds support for namespaces to the i18n package so we can separate translations for different packages

daniellockyer mentioned this issue Mar 16, 2023

Added i18n service to Ghost core #16422

Merged

daniellockyer added a commit that referenced this issue Mar 16, 2023

Added example translation for emails within Ghost

8d7a8ff

refs #15502 - this adds the i18n translation wrapper to the titles, plaintext versions and one HTML version of the member emails

daniellockyer mentioned this issue Mar 16, 2023

Added example translation for emails within Ghost #16424

Merged

daniellockyer added a commit that referenced this issue Mar 16, 2023

Added example translation for emails within Ghost

330e869

refs #15502 - this adds the i18n translation wrapper to the titles, plaintext versions and one HTML version of the member emails

daniellockyer mentioned this issue Mar 16, 2023

Refactored i18n plaintext email translations to split on newline #16428

Merged

daniellockyer added a commit that referenced this issue Mar 16, 2023

Refactored i18n plaintext email translations to split on newline

89bf6af

refs #15502 - this makes the translations files a lot nicer because they only contain one line per key

daniellockyer added a commit that referenced this issue Mar 16, 2023

Refactored i18n plaintext email translations to split on newline

dc0f021

refs #15502 - this makes the translations files a lot nicer because they only contain one line per key

daniellockyer mentioned this issue Mar 16, 2023

Removed emojis from i18n strings #16429

Merged

daniellockyer added a commit that referenced this issue Mar 16, 2023

Removed emojis from i18n strings

7a1f08e

refs #15502 - these aren't going to change across languages so we can exclude them from the strings to simplify things

daniellockyer added a commit that referenced this issue Mar 16, 2023

Removed emojis from i18n strings

dda1d7c

refs #15502 - these aren't going to change across languages so we can exclude them from the strings to simplify things

daniellockyer closed this as completed Mar 20, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

i18n Milestone 2: Framework and build tools #15502

i18n Milestone 2: Framework and build tools #15502

ErisDS commented Sep 29, 2022 •

edited by daniellockyer

Loading

ErisDS commented Oct 7, 2022

daniellockyer commented Mar 20, 2023

i18n Milestone 2: Framework and build tools #15502

i18n Milestone 2: Framework and build tools #15502

Comments

ErisDS commented Sep 29, 2022 • edited by daniellockyer Loading

Tasks:

ErisDS commented Oct 7, 2022

daniellockyer commented Mar 20, 2023

ErisDS commented Sep 29, 2022 •

edited by daniellockyer

Loading