fix(packages/i18n): improve readability of code

Author: PatrykKuniczak

packages/i18n/src/build.ts

@@ -6,7 +6,7 @@
  */
 
 import { mkdir, readFile, writeFile } from 'node:fs/promises';
-import { parseYAML, parseJSON5, parseTOML } from 'confbox';
+import { parseJSON5, parseTOML, parseYAML } from 'confbox';
 import { dirname, extname } from 'node:path';
 import { applyChromeMessagePlaceholders, getSubstitutionCount } from './utils';
 
@@ -118,6 +118,7 @@ export async function parseMessagesFile(
 ): Promise<ParsedMessage[]> {
   const text = await readFile(file, 'utf8');
   const ext = extname(file).toLowerCase();
+
   return parseMessagesText(text, EXT_FORMATS_MAP[ext] ?? 'JSON5');
 }
 
@@ -173,13 +174,16 @@ function _parseMessagesObject(
           `Messages file should not contain \`${object}\` (found at "${path.join('.')}")`,
         );
       }
+
       if (Array.isArray(object))
         return object.flatMap((item, i) =>
           _parseMessagesObject(path.concat(String(i)), item, depth + 1),
         );
+
       if (isPluralMessage(object)) {
         const message = Object.values(object).join('|');
         const substitutions = getSubstitutionCount(message);
+
         return [
           {
             type: 'plural',
@@ -189,9 +193,11 @@ function _parseMessagesObject(
           },
         ];
       }
+
       if (depth === 1 && isChromeMessage(object)) {
         const message = applyChromeMessagePlaceholders(object);
         const substitutions = getSubstitutionCount(message);
+
         return [
           {
             type: 'chrome',
@@ -227,7 +233,7 @@ function isChromeMessage(object: any): object is ChromeMessage {
 
 export function generateTypeText(messages: ParsedMessage[]): string {
   const renderMessageEntry = (message: ParsedMessage): string => {
-    // Use . for deep keys at runtime and types
+    // Use '.' for deep keys at runtime and types
     const key = message.key.join('.');
 
     const features = [

packages/i18n/src/index.ts

@@ -2,9 +2,9 @@
  * @module @wxt-dev/i18n
  */
 import {
-  I18nStructure,
   DefaultI18nStructure,
   I18n,
+  I18nStructure,
   Substitution,
 } from './types';
 import { browser } from '@wxt-dev/browser';
@@ -16,6 +16,7 @@ export function createI18n<
     // Resolve args
     let sub: Substitution[] | undefined;
     let count: number | undefined;
+
     args.forEach((arg, i) => {
       if (arg == null) {
         // ignore nullish args
@@ -37,16 +38,19 @@ export function createI18n<
 
     // Load the localization
     let message: string;
+
     if (sub?.length) {
       // Convert all substitutions to strings
       const stringSubs = sub?.map((sub) => String(sub));
       message = browser.i18n.getMessage(key.replaceAll('.', '_'), stringSubs);
     } else {
       message = browser.i18n.getMessage(key.replaceAll('.', '_'));
     }
+
     if (!message) {
       console.warn(`[i18n] Message not found: "${key}"`);
     }
+
     if (count == null) return message;
 
     // Apply pluralization

packages/i18n/src/module.ts

@@ -14,8 +14,8 @@ import 'wxt';
 import { addAlias, defineWxtModule } from 'wxt/modules';
 import {
   generateChromeMessagesText,
-  parseMessagesFile,
   generateTypeText,
+  parseMessagesFile,
   SUPPORTED_LOCALES,
 } from './build';
 import glob from 'fast-glob';
@@ -70,6 +70,7 @@ export default defineWxtModule<I18nOptions>({
       GeneratedPublicFile[]
     > => {
       const files = await getLocalizationFiles();
+
       return await Promise.all(
         files.map(async ({ file, locale }) => {
           const messages = await parseMessagesFile(file);
@@ -86,13 +87,15 @@ export default defineWxtModule<I18nOptions>({
       const defaultLocaleFile = files.find(
         ({ locale }) => locale === wxt.config.manifest.default_locale,
       )!;
-      if (defaultLocaleFile == null) {
+
+      if (defaultLocaleFile === null) {
         throw Error(
           `\`[i18n]\` Required localization file does not exist: \`<localesDir>/${wxt.config.manifest.default_locale}.{json|json5|yml|yaml|toml}\``,
         );
       }
 
       const messages = await parseMessagesFile(defaultLocaleFile.file);
+
       return {
         path: typesPath,
         text: generateTypeText(messages),
@@ -152,7 +155,7 @@ export { type GeneratedI18nStructure }
 
     addAlias(wxt, '#i18n', sourcePath);
 
-    // Generate separate declaration file containing types - this prevents
+    // Generate a separate declaration file containing types - this prevents
     // firing the dev server's default file watcher when updating the types,
     // which would cause a full rebuild and reload of the extension.
 

packages/i18n/src/utils.ts

@@ -1,7 +1,7 @@
 import { ChromeMessage } from './build';
 
 export function applyChromeMessagePlaceholders(message: ChromeMessage): string {
-  if (message.placeholders == null) return message.message;
+  if (message.placeholders === null) return message.message;
 
   return Object.entries(message.placeholders ?? {}).reduce(
     (text, [name, value]) => {
@@ -28,6 +28,7 @@ export function standardizeLocale(locale: string): string {
 
   const [is_match, prefix, suffix] =
     locale.match(/^([a-z]{2})[-_]([a-z]{2,3})$/i) ?? [];
+
   if (is_match) {
     return `${prefix.toLowerCase()}_${suffix.toUpperCase()}`;
   }