lighthouse 13.6.0-dev.20261027 → 13.6.0-dev.20261028

package/core/config/config-helpers.js

@@ -349,6 +349,11 @@ async function mergePlugins(config, configDir, flags) {
   const flagPlugins = flags?.plugins || [];
   const pluginNames = new Set([...configPlugins, ...flagPlugins]);
 
+  const configLocales = config.locales;
+  if (configLocales) {
+    delete config.locales;
+  }
+
   for (const pluginName of pluginNames) {
     validation.assertValidPluginName(config, pluginName);
 
@@ -362,6 +367,10 @@ async function mergePlugins(config, configDir, flags) {
     config = mergeConfigFragment(config, pluginJson);
   }
 
+  if (configLocales) {
+    config.locales = mergeConfigFragment(config.locales, configLocales);
+  }
+
   return config;
 }
 

package/core/config/config-plugin.d.ts

@@ -34,6 +34,13 @@ declare class ConfigPlugin {
      * @return {Record<string, LH.Config.GroupJson>|undefined}
      */
     static _parseGroups(groupsJson: unknown, pluginName: string): Record<string, LH.Config.GroupJson> | undefined;
+    /**
+     * Extract and validate locales JSON added by the plugin.
+     * @param {unknown} localesJson
+     * @param {string} pluginName
+     * @return {NonNullable<LH.Config['locales']>|undefined}
+     */
+    static _parseLocales(localesJson: unknown, pluginName: string): NonNullable<LH.Config["locales"]> | undefined;
     /**
      * Extracts and validates a config from the provided plugin input, throwing
      * if it deviates from the expected object shape.

package/core/config/config-plugin.js

@@ -215,6 +215,53 @@ class ConfigPlugin {
     return parsedGroupsJson;
   }
 
+  /**
+   * Extract and validate locales JSON added by the plugin.
+   * @param {unknown} localesJson
+   * @param {string} pluginName
+   * @return {NonNullable<LH.Config['locales']>|undefined}
+   */
+  static _parseLocales(localesJson, pluginName) {
+    if (localesJson === undefined) {
+      return undefined;
+    }
+
+    if (!isObjectOfUnknownProperties(localesJson)) {
+      throw new Error(`${pluginName} locales json is not defined as an object.`);
+    }
+
+    /** @type {NonNullable<LH.Config['locales']>} */
+    const parsedLocalesJson = {};
+    for (const [locale, localeMessagesJson] of Object.entries(localesJson)) {
+      if (!isObjectOfUnknownProperties(localeMessagesJson)) {
+        throw new Error(`${pluginName} has a locale (${locale}) not defined as an object.`);
+      }
+
+      /** @type {Record<string, {message: string}>} */
+      const parsedMessages = {};
+      for (const [icuMessageId, messageEntry] of Object.entries(localeMessagesJson)) {
+        if (!isObjectOfUnknownProperties(messageEntry)) {
+          throw new Error(
+            `${pluginName} has a locale message (${icuMessageId}) not defined as an object.`
+          );
+        }
+
+        const {message, ...invalidRest} = messageEntry;
+        assertNoExcessProperties(invalidRest, pluginName, 'locale message');
+
+        if (typeof message !== 'string') {
+          throw new Error(`${pluginName} has an invalid locale message (${icuMessageId}).`);
+        }
+
+        parsedMessages[icuMessageId] = {message};
+      }
+
+      parsedLocalesJson[/** @type {LH.Locale} */ (locale)] = parsedMessages;
+    }
+
+    return parsedLocalesJson;
+  }
+
   /**
    * Extracts and validates a config from the provided plugin input, throwing
    * if it deviates from the expected object shape.
@@ -233,6 +280,7 @@ class ConfigPlugin {
       audits: pluginAuditsJson,
       category: pluginCategoryJson,
       groups: pluginGroupsJson,
+      locales: pluginLocalesJson,
       ...invalidRest
     } = pluginJson;
 
@@ -244,6 +292,7 @@ class ConfigPlugin {
         [pluginName]: ConfigPlugin._parseCategory(pluginCategoryJson, pluginName),
       },
       groups: ConfigPlugin._parseGroups(pluginGroupsJson, pluginName),
+      locales: ConfigPlugin._parseLocales(pluginLocalesJson, pluginName),
     };
   }
 }

package/core/config/config.js

@@ -163,6 +163,7 @@ async function resolveArtifactsToDefns(artifacts, configDir) {
       id: artifactJson.id,
       gatherer,
       dependencies: resolveArtifactDependencies(artifactJson, gatherer, artifactDefnsBySymbol),
+      alwaysGather: artifactJson.alwaysGather,
     };
 
     const symbol = artifact.gatherer.instance.meta.symbol;
@@ -229,6 +230,14 @@ async function initializeConfig(gatherMode, config, flags = {}) {
   configWorkingCopy = resolveExtensions(configWorkingCopy);
   configWorkingCopy = await mergePlugins(configWorkingCopy, configDir, flags);
 
+  if (configWorkingCopy.locales) {
+    for (const [locale, lhlMessages] of Object.entries(configWorkingCopy.locales)) {
+      if (lhlMessages) {
+        format.registerLocaleData(/** @type {LH.Locale} */ (locale), lhlMessages);
+      }
+    }
+  }
+
   const settings = resolveSettings(configWorkingCopy.settings || {}, flags);
   overrideSettingsForGatherMode(settings, gatherMode);
   overrideThrottlingWindows(settings);

package/core/config/filters.js

@@ -69,6 +69,7 @@ function filterArtifactsByAvailableAudits(artifacts, audits) {
   /** @type {Set<string>} */
   const artifactIdsToKeep = new Set([
     ...filterResistantArtifactIds,
+    ...artifacts.filter(artifact => artifact.alwaysGather).map(artifact => artifact.id),
     ...audits.flatMap(audit => audit.implementation.meta.requiredArtifacts),
   ]);
 

package/core/index.d.ts

@@ -68,6 +68,8 @@ export function auditFlowArtifacts(flowArtifacts: LH.UserFlow.FlowArtifacts, con
 }>;
 export function getAuditList(): string[];
 export const traceCategories: string[];
+import * as i18n from './lib/i18n/i18n.js';
 import * as LH from '../types/lh.js';
 import { UserFlow } from './user-flow.js';
+export { i18n };
 //# sourceMappingURL=index.d.ts.map

package/core/index.js

@@ -11,6 +11,7 @@ import {ReportGenerator} from '../report/generator/report-generator.js';
 import {startTimespanGather} from './gather/timespan-runner.js';
 import {snapshotGather} from './gather/snapshot-runner.js';
 import {navigationGather} from './gather/navigation-runner.js';
+import * as i18n from './lib/i18n/i18n.js';
 import * as LH from '../types/lh.js';
 
 /*
@@ -131,4 +132,5 @@ export {
   auditFlowArtifacts,
   getAuditList,
   traceCategories,
+  i18n,
 };

package/core/lib/i18n/i18n.d.ts

@@ -77,4 +77,6 @@ export function createIcuMessageFn(filename: string, fileStrings?: Record<string
  * @return {value is string|LH.IcuMessage}
  */
 export function isStringOrIcuMessage(value: unknown): value is string | LH.IcuMessage;
+import { registerLocaleData } from '../../../shared/localization/format.js';
+export { registerLocaleData };
 //# sourceMappingURL=i18n.d.ts.map

package/core/lib/i18n/i18n.js

@@ -9,9 +9,14 @@ import url from 'url';
 
 import log from 'lighthouse-logger';
 
-import {getAvailableLocales} from '../../../shared/localization/format.js';
+import {
+  getAvailableLocales,
+  isIcuMessage,
+  formatMessage,
+  registerLocaleData,
+  DEFAULT_LOCALE,
+} from '../../../shared/localization/format.js';
 import {LH_ROOT} from '../../../shared/root.js';
-import {isIcuMessage, formatMessage, DEFAULT_LOCALE} from '../../../shared/localization/format.js';
 
 const UIStrings = {
   /** Used to show the duration in milliseconds that something lasted. The `{timeInMs}` placeholder will be replaced with the time duration, shown in milliseconds (e.g. 63 ms) */
@@ -232,4 +237,5 @@ export {
   lookupLocale,
   createIcuMessageFn,
   isStringOrIcuMessage,
+  registerLocaleData,
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "13.6.0-dev.20261027",
+  "version": "13.6.0-dev.20261028",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {

package/shared/localization/format.js

@@ -466,7 +466,10 @@ function getAvailableLocales() {
  * @param {import('./locales').LhlMessages} lhlMessages
  */
 function registerLocaleData(locale, lhlMessages) {
-  LOCALE_MESSAGES[locale] = lhlMessages;
+  LOCALE_MESSAGES[locale] = {
+    ...LOCALE_MESSAGES[locale],
+    ...lhlMessages,
+  };
 }
 
 /**

package/types/config.d.ts

@@ -6,7 +6,7 @@
  */
 
 import {Audit} from '../core/audits/audit.js';
-import {SharedFlagsSettings, ConfigSettings} from './lhr/settings.js';
+import {SharedFlagsSettings, ConfigSettings, Locale} from './lhr/settings.js';
 import Gatherer from './gatherer.js';
 import {IcuMessage} from './lhr/i18n.js';
 import Result from './lhr/lhr.js';
@@ -26,6 +26,7 @@ interface Config {
   categories?: Record<string, Config.CategoryJson> | null;
   groups?: Record<string, Config.GroupJson> | null;
   plugins?: Array<string>;
+  locales?: Partial<Record<Locale, Record<string, {message: string}>>> | null;
 }
 
 declare namespace Config {
@@ -43,6 +44,7 @@ declare namespace Config {
   interface ArtifactJson {
     id: string;
     gatherer: GathererJson;
+    alwaysGather?: boolean;
   }
 
   type GathererJson = {
@@ -94,6 +96,7 @@ declare namespace Config {
     dependencies?: TDependencies extends Gatherer.DefaultDependenciesKey ?
       undefined :
       Record<Exclude<TDependencies, Gatherer.DefaultDependenciesKey>, {id: string}>;
+    alwaysGather?: boolean;
   }
 
   type ArtifactDefnExpander<TDependencies extends Gatherer.DependencyKey> =
@@ -136,6 +139,8 @@ declare namespace Config {
     category: Config.Category;
     /** Optionally provide more groups in addition to those specified by the base config. */
     groups?: Record<string, Config.GroupJson>;
+    /** Optionally provide locale messages for translating plugin strings. */
+    locales?: Partial<Record<Locale, Record<string, {message: string}>>>;
   }
 
   type Merge = {