Adding i18n initial support

[tankerkiller125]

What type of PR is this?

• feature

What this PR does / why we need it:

This is just the initial support for i18n, it's setup in the following way:

• Using https://vue-i18n.intlify.dev/
• Using the https://formatjs.io/docs/intl-messageformat/ package for actual string output (ICU format)
• Will load any file in the frontend/locales path, right now using JSON5 (comment supported JSON) but also supports YML, JSON, JS, and TS files

There are still things that need to be figured out:

• Switching the locale (user preference? Or somehow pass it forward from the backend?)
• All of the pages need converting to the i18n string output method (the initial index should be mostly done).

Which issue(s) this PR fixes:

Fixes: #32

Summary by CodeRabbit

• New Features

  • Introduced internationalization support for the password strength label and various UI text elements.
  • Added a new localization file for English strings, enhancing the user interface with dynamic translations.
  • Implemented a plugin for managing multilingual content and improved message formatting.

• Bug Fixes

  • Replaced static text with dynamic translations throughout the main page for better accessibility.

• Chores

  • Updated configuration to integrate i18n support and added necessary dependencies for localization.

[coderabbitai]

Walkthrough

Walkthrough

The recent changes enhance the application's internationalization capabilities by implementing support for multiple languages. Key modifications include the localization of text labels in the user interface, the introduction of an English localization file, and updates to the Nuxt configuration for i18n support. These improvements facilitate a more inclusive user experience, making it easier for users to engage with the application in their preferred language.

Changes

File	Summary of Changes
frontend/components/global/PasswordScore.vue frontend/pages/index.vue	Localization of text strings using the $t() function for dynamic translation, enhancing multilingual support.
frontend/locales/en.json5	New file added with English localization strings for various UI elements, improving user experience through language support.
frontend/nuxt.config.ts	Integrated i18n support with configurations for vue-i18n and Vite, enabling better handling of localization.
frontend/package.json	Added dependencies for @intlify/unplugin-vue-i18n, intl-messageformat, and vue-i18n to enhance localization features.
frontend/plugins/i18n.ts	New plugin created to initialize i18n with custom message formatting and error handling, improving multilingual content management.

Assessment against linked issues

Objective	Addressed	Explanation
Support Simplified Chinese (#32)	❓	While English localization has been implemented, it is unclear if Simplified Chinese support is included.

🎉 In code we weave, a language so bright,
With words that now dance, in day and in night.
From English to Chinese, let voices unite,
A global embrace, our future in sight! 🌍✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Caution

Inline review comments failed to post

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0bcb155 and 3540ce4.

Files ignored due to path filters (1)

• frontend/pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

Files selected for processing (6)

• frontend/components/global/PasswordScore.vue (1 hunks)
• frontend/locales/en.json5 (1 hunks)
• frontend/nuxt.config.ts (1 hunks)
• frontend/package.json (2 hunks)
• frontend/pages/index.vue (5 hunks)
• frontend/plugins/i18n.ts (1 hunks)

Files skipped from review due to trivial changes (1)

• frontend/locales/en.json5

Additional context used

Biome

frontend/plugins/i18n.ts

[error] 33-33: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

Additional comments not posted (18)

frontend/components/global/PasswordScore.vue (1)

3-3: Localization implemented successfully.

The label "Password Strength" has been successfully localized using the $t function. This change enhances the user interface by supporting multiple languages.

frontend/plugins/i18n.ts (1)

1-16: i18n plugin setup looks good.

The setup for the Vue I18n library and the integration with the Vue app is correctly implemented.

frontend/nuxt.config.ts (3)

1-1: Imports for i18n support are correctly added.

The necessary imports for the Vue I18n plugin and path resolution are correctly added.

---

9-11: Transpilation settings for vue-i18n are correctly configured.

The build configuration includes the vue-i18n library for transpilation, ensuring compatibility during the build process.

---

12-17: Vite plugin for i18n support is correctly configured.

The Vite configuration includes the Vue I18n plugin, with the correct path to the locale files.

frontend/package.json (3)

19-19: Addition of @intlify/unplugin-vue-i18n is appropriate.

This dependency is essential for integrating Vue I18n support into the project, facilitating internationalization.

---

31-31: Addition of intl-messageformat is appropriate.

This dependency is vital for handling internationalized message formatting, ensuring dynamic text rendering based on the user's locale.

---

39-39: Addition of vue-i18n is appropriate.

This dependency is fundamental for enabling internationalization in Vue applications, providing essential tools and functions.

frontend/pages/index.vue (10)

152-152: Dynamic translation of the tagline is appropriate.

This change ensures the tagline is rendered based on the user's language preference, enhancing accessibility.

---

177-177: Dynamic translation of the registration heading is appropriate.

This change ensures the registration heading is rendered based on the user's language preference, enhancing accessibility.

---

179-179: Dynamic translation of the email input label is appropriate.

This change ensures the label is rendered based on the user's language preference, enhancing accessibility.

---

182-182: Dynamic translation of the group joining text is appropriate.

This change ensures the text is rendered based on the user's language preference, enhancing accessibility.

---

184-184: Dynamic translation of the button text for not joining a group is appropriate.

This change ensures the button text is rendered based on the user's language preference, enhancing accessibility.

---

187-187: Dynamic translation of the password input label is appropriate.

This change ensures the label is rendered based on the user's language preference, enhancing accessibility.

---

196-196: Dynamic translation of the registration button text is appropriate.

This change ensures the button text is rendered based on the user's language preference, enhancing accessibility.

---

207-207: Dynamic translation of the login heading is appropriate.

This change ensures the login heading is rendered based on the user's language preference, enhancing accessibility.

---

211-211: Dynamic translation of the email label in the demo instance is appropriate.

This change ensures the email label is rendered based on the user's language preference, enhancing accessibility.

---

212-212: Dynamic translation of the password label in the demo instance is appropriate.

This change ensures the password label is rendered based on the user's language preference, enhancing accessibility.

Comments failed to post (1)

frontend/plugins/i18n.ts

18-36: Consider using optional chaining for error handling.

The static analysis tool suggests using optional chaining for better readability and safety.

-    onError && onError(new Error("not support for AST") as CompileError);
+    onError?.(new Error("not support for AST") as CompileError);

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

export const messageCompiler: MessageCompiler = (message, { locale, key, onError }) => {
  if (typeof message === "string") {
    /**
     * You can tune your message compiler performance more with your cache strategy or also memoization at here
     */
    const formatter = new IntlMessageFormat(message, locale);
    return (ctx: MessageContext) => {
      return formatter.format(ctx.values);
    };
  } else {
    /**
     * for AST.
     * If you would like to support it,
     * You need to transform locale messages such as `json`, `yaml`, etc. with the bundle plugin.
     */
    onError?.(new Error("not support for AST") as CompileError);
    return () => key;
  }
};

Tools

Biome

[error] 33-33: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)