Skip to content

feat(i18n): dependency-free i18n foundation + Simplified Chinese (zh-CN) - #72

Draft
Brent (lizheng220) wants to merge 1 commit into
microsoft:release/0.6.0from
lizheng220:feat/i18n-foundation-zh-cn
Draft

feat(i18n): dependency-free i18n foundation + Simplified Chinese (zh-CN)#72
Brent (lizheng220) wants to merge 1 commit into
microsoft:release/0.6.0from
lizheng220:feat/i18n-foundation-zh-cn

Conversation

@lizheng220

Copy link
Copy Markdown

Closes nothing yet — opening this as a draft proposal for #64, which is still awaiting maintainer guidance on the preferred i18n architecture. I'd rather put something concrete on the table than ask in the abstract. Happy to reshape it, split it, or close it if you'd prefer a different direction.

Credit where it's due: #64 was filed by YouLin (@q438241zy), who offered to review Simplified Chinese terminology, contribute translations, and test on Windows 11 zh-CN. This PR deliberately leaves the bulk of the translation work open for exactly that.

Why

Narration transcription already supports 99 languages, but the UI, dialogs, error messages and accessibility labels are English-only. This adds the foundation for translating them, plus Simplified Chinese as the first locale.

Why no i18n library

The app ships a reviewed third-party manifest — scripts/compliance.mjs, THIRD-PARTY-NOTICES.md, per-package license archival, verify-packaged-compliance.mjs at pack time. Adding i18next/react-i18next would put a compliance review in the path of behaviour that fits in ~40 lines. So src/i18n/translate.ts is the whole engine: catalogue lookup, per-message English fallback, {name} interpolation. No new dependency, package-lock.json untouched.

What's here

  • common/locale.ts — supported UI locales and resolveUiLocale(), mapping the tags app.getLocale()/navigator.language actually emit (zh, zh-CN, zh_CN, zh-Hans-CN, en-GB) onto one. Script beats region, so zh-Hant-CN isn't read as Simplified; zh-TW/zh-HK fall back to English until a Traditional catalogue exists.
  • electron/ui-locale.tsUiLocaleStore: an explicit stored choice, else the OS locale. Takes its dependencies as arguments rather than importing electron, so it tests under plain Node with no changes to evals/electron-stub.mjs. A missing, malformed or unsupported preference file resolves to the OS locale instead of failing startup; an unwritable userData still applies the choice for the session and logs.
  • src/i18n/ — the English catalogue is the source of truth and its keys form MessageKey, so t() with an unknown key fails the build. zh-CN is typed Partial<Record<MessageKey, string>> on purpose: a translation is allowed to lag English, and anything missing or blank falls back per message rather than blocking a change to the source language.
  • IPC (ui:locale / ui:set-locale / ui:locale-changed) — the recorder, controls, library and terminal each mount their own React root in their own window, so a language change is broadcast from main rather than shared through renderer state.
  • An "App language" picker at the top of the existing recording-settings panel.

UI language stays independent of the narration transcription language and of the generated Skill/Automation language, per the issue.

Scope

Foundation + RecordingControls.tsx migrated in full (43 messages) as the proof surface — it exercises text nodes, aria-label, title and interpolation together. The remaining surfaces (Library.tsx is the big one at ~80 strings, then Recorder.tsx, plan-edit.tsx, WhatsRecorded.tsx, SensitiveReview.tsx, RecordingPrivacyWarning.tsx) would follow one PR per surface, so each stays reviewable. English output is unchanged at every step.

Verification

Workflow runs on fork PRs sit at action_required until a maintainer approves them, so here is what I ran locally (Windows 11, Node 24):

  • npm run typecheck — clean
  • npm test188/188 pass, 12 of them new; no existing test modified
  • npm run build:vite — builds (the >500 kB chunk warning is pre-existing: the renderer chunk is 701 kB, this adds ~5 kB)
  • Mutation check on the guard that matters: dropping {device} from one zh-CN message makes zh-CN keeps every placeholder its English message uses fail as intended, then passes again once restored — the test isn't decorative.

New tests cover locale resolution (including Traditional-vs-Simplified), store persistence, a corrupt preference file, an unwritable directory, fallback and interpolation, and two catalogue-integrity checks: that zh-CN defines no key English lacks, and that a translation preserves every placeholder its English message uses (a dropped {device} would otherwise silently lose the device name).

Two things I'd like your call on

  1. The settings panel now shows App language (UI) directly above the existing Language (narration transcription). Would you like the existing label changed to something like "Narration language", or left alone to keep the diff surgical? I left it alone.
  2. narrationLanguageLabel() returns English names for all 99 Whisper languages, so that picker stays English under zh-CN. Localizing those is a separate and much larger job — follow-up, or out of scope?

Based on release/0.6.0 per .github/copilot-instructions.md.

The UI, dialogs, errors and accessibility labels are English-only even
though narration transcription already supports 99 languages. Add the
foundation for translating them, and Simplified Chinese as the first
locale.

The app ships a reviewed third-party manifest, so a runtime i18n library
would put a compliance review in the path of behaviour that fits in a
few lines: `translate()` does catalogue lookup, per-message English
fallback and `{name}` interpolation, and the English catalogue's keys
type every `t()` call.

The interface language is an explicit stored choice, else the OS locale.
`resolveUiLocale()` maps the tags `app.getLocale()` actually emits, with
script beating region so `zh-Hant-CN` is not read as Simplified. A
malformed preference file or an unwritable userData degrades instead of
failing. Because the recorder, controls, library and terminal each own a
React root in their own window, a change is broadcast from main.

Migrates RecordingControls as the proof surface; the remaining surfaces
follow separately. English output is unchanged.

Refs microsoft#64
@microsoft-github-policy-service

Copy link
Copy Markdown

Brent (@lizheng220) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant