Exclude type-checking for i18n & Add workflow for full check

[zyf722]

What type of PR is this? (check all applicable)

• ✨ Feature
• 🐛 Bug Fix
• 📝 Documentation Update
• 🎨 Style
• ♻️ Code Refactor
• 🔥 Performance Improvements
• ✅ Test
• 🤖 Build
• 🔁 CI
• 📦 Chore (Release)
• ⏩ Revert
• 🌐 Internationalization / Translation

Description

This PR solves the build performance bottleneck raised in #707, which was caused by type-checking the entire codebase (including i18n locale objects) during building.

A new tsconfig.noI18n.json file that extends the base tsconfig is added to exclude the src/livecodes/i18n/locales directory for building types. A new workflow to perform full type-checking (triggered by PRs and pushes) is also included.

Related Tickets & Documents

• Closes i18n types performance #707.

Added tests?

• 👍 yes
• 🙅 no, because they aren't needed
• 🙋 no, because I need help

Added to documentations?

• 📓 docs (./docs)
• 📕 storybook (./storybook)
• 📜 README.md
• 🙅 no documentation needed

[netlify]

✅ Deploy Preview for livecodes ready!

Name	Link
🔨 Latest commit	4fa8db7
🔍 Latest deploy log	https://app.netlify.com/sites/livecodes/deploys/6792f22dc0cf550008330d5d
😎 Deploy Preview	https://deploy-preview-718--livecodes.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[zyf722]

Hi @hatemhosny ,

Could you please take a review on this when you have time?

The workflow for type-checking seems to be working as expected now.

It reports that there are some i18n source changes for Code to Image feature, and translation key in other languages are inconsistent with English. We might want to fix them on Lokalise.

[hatemhosny]

Thank you @zyf722

The type check is indeed a lot faster now.

I suggest to use the opposite approach.
Let's make the exclusion in the default tsconfig file. This is used for:

• the build:ts script.
• the typedoc docusaurus plugin: this can make npm run docs and npm run build:docs a lot faster.
• this is probably used by the IDE. So this might also make types in the IDE a lot faster.

We can then remove this exclusion in the other tsconfig file used by the CI workflow.

What do you think?

It reports that there are some i18n source changes for Code to Image feature, and translation key in other languages are inconsistent with English. We might want to fix them on Lokalise.

Is that related to this PR?
Can you also please check there. I think it wants to remove many keys that are actually being used.

Edit:
The type errors are now fixed after adding the missing translations and pulling from lokalise.

[zyf722]

Sorry for being a bit late to respond. I was kind of busy this week 😵‍💫

Let's make the exclusion in the default tsconfig file. This is used for:

• the build:ts script.
• the typedoc docusaurus plugin: this can make npm run docs and npm run build:docs a lot faster.
• this is probably used by the IDE. So this might also make types in the IDE a lot faster.

We can then remove this exclusion in the other tsconfig file used by the CI workflow.

Done.

I did not think of directly exclude them in the base tsconfig, as I subconsciously thought that these files would be used by the IDE's Intellisense. But now I realize that only English, our base language, is needed for this purpose and it will be included anyway. So it makes sense to exclude other languages - thanks for pointing this out.

Is that related to this PR? Can you also please check there. I think it wants to remove many keys that are actually being used.

Edit: The type errors are now fixed after adding the missing translations and pulling from lokalise.

I haven't had a chance to thoroughly check this PR yet. Is the weekly workflow working as we expected?

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[hatemhosny]

Thank you @zyf722
This is very nice. Much faster!

I haven't had a chance to thoroughly check this PR yet. Is the weekly workflow working as we expected?

Yes. It is working well. Overall, the whole i18n workflow is great. Thank you.

[livecodes-ci]

i18n Actions

Source PR has been merged into the default branch.

Maintainers can comment .i18n-update-push to trigger the i18n update workflow and push the changes to Lokalise.