feat: Improved localization API

[aklinker1]

This closes #327 . It adds a new module (that's auto-imported by default), wxt/i18n. To use the API:

# locales/en.yml
hello: Hello $1
items:
  1: 1 item
  n: $1 items

import { i18n } from 'wxt/i18n';

i18n.t("hello", ["Mark"]); // "Hello Mark"
i18n.tp("items", 2, ["1"]) // "2 items"
i18n.tp("items", 1, ["1"]) // "1 item"

• Implement conversion tools for mapping message files
• Implement client code
  • Plural support
    • Double check if plural logic works as expected for definitions without 0 or 1, just n
  • Substitutions
  • Overridable types
  • Non-overridden types work
  • Typed placeholders Will add this in a future PR, but the overidable types support defining types for the placeholders.
• Update type generation for browser.i18n.getMessage
• Generate types for new i18n variable
• Update tests
• Update docs
• Release test version
• Create PR to update i18n examples
• Check compatibility with i18next VS code plugin

[netlify]

✅ Deploy Preview for creative-fairy-df92c4 ready!

Name	Link
🔨 Latest commit	98bc1f2
🔍 Latest deploy log	https://app.netlify.com/sites/creative-fairy-df92c4/deploys/65a460e85fd1b30008c867c5
😎 Deploy Preview	https://deploy-preview-343--creative-fairy-df92c4.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.

[codecov]

Codecov Report

Attention: 25 lines in your changes are missing coverage. Please review.

Comparison is base (a329e24) 78.39% compared to head (98bc1f2) 78.69%.
Report is 1 commits behind head on main.

Files	Patch %	Lines
src/i18n/index.ts	0.00%	20 Missing and 1 partial ⚠️
src/i18n/node.ts	98.57%	3 Missing ⚠️
src/types/internal.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #343      +/-   ##
==========================================
+ Coverage   78.39%   78.69%   +0.30%     
==========================================
  Files         102      106       +4     
  Lines        7128     7469     +341     
  Branches      622      663      +41     
==========================================
+ Hits         5588     5878     +290     
- Misses       1523     1572      +49     
- Partials       17       19       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[aklinker1]

Revert before merging

[aklinker1]

@dvlden I've released v0.14.2-alpha2 for testing:

pnpm i wxt@next

[dvlden]

Amazing! I will definitely test it tomorrow. It's late now and I'm headed to bed. Giving you my feedback tomorrow, thanks man! 🤙

[aklinker1]

Alright, I've integrated the alpha release into one of my extensions to try it out. Everything works great at runtime, but there's some DX improvements I'd like to make:

1. I shouldn't have to cast a number to a string when passing it as a substitution:

   -i18n.tp("diffs_additionsText", count, [String(count)])
   +i18n.tp("diffs_additionsText", count, [count])

2. I don't like having plurals as a separate function. tp → t.

   -i18n.tp("diffs_additionsText", count, [count])
   +i18n.t("diffs_additionsText", count, [count])

3. For single substitutions, I shouldn't have to use an array.

   -i18n.tp("diffs_additionsText", count, [count])
   +i18n.t("diffs_additionsText", count, count)

4. The nested messages are hard to edit. I can't double click to select one "level" of the message name, like "description1" to quickly change it to "description2", because _ are not considered word breaks. Same with using ctrl+backspace or opt+delete to backspace an entire word.

   <p class="font-medium text-base-content">
     {{ t("options_customLists_description1") }}
   </p>

   Ideally, we would use periods to denote nested levels, like options.customLists.description1, but . is not a valid character for a message name in web extensions... So we would have to write them to the disk with _, and replace all . with underscores when grabbing the keys at runtime... I don't want to cause a performance issue when running .replaceAll(".", "_"), but it might be worth it for the convenience...
5. Log a warning and fail the build when a locales directory is present, but no default_locale is specified in the manifest, and vise-versa. If we kept the build going, Chrome would fail to load both these extensions, so it's better we catch this sooner.
6. Unlike the browser.runtime.getMessage API, I can't hover over the function to see the description and text. It's an easy, built-in way of quickly viewing what the translation text is.
   
   
7. Substitutions array is typed as any, it should be string[]

[dvlden]

Sorry for slower response. I just grabbed a chance to test this.

Notes (alpha):

• Running without locales dir

Failed to update .wxt directory: The "path" argument must be of type string or an instance of Buffer or URL. Received undefined

• Looks like we are not utilising arrays in locales. Assuming that browser.i18n does not support it natively (did not research)

# Not working
state:
  - Normal
  - Upscale
  - Stretch

• Does not seem to support multiple nesting levels. Not sure why, cause in your example it looks like it does?

activity:
  # ...
  state:
    active: On
    inactive: Off

// Shows autocompletion, but renders as empty string
i18n.t('activity_state_active')

• Does not trigger hot-reload if locales/xx.yaml is changed (new properties or editing existing ones)

I think I found it most annoying, not being able to click on the property key to edit the locale message. You said it doesn't let you do it for nested properties, but I can't do it with a non-nested property either. Not sure if I need an extension for that, but native browser.i18n.getMessage('xxx') is also not editable through VSCode with CMD + Click on the argument.

[aklinker1]

Good feedback, missed all that. I'll try and get an improved version released next weekend

[aklinker1]

This PR is way out of date, closing in favor of #758. Will be copying over a lot of code from this PR instead of dealing with merge conflicts.