@lingui/conf 5.9.3 → 6.0.0-next.1

package/dist/index.d.mts

@@ -1,18 +1,3 @@
-/**
- * @deprecated please pass formatter directly to `format`
- *
- * @example
- * ```js
- * // lingui.config.{js,ts}
- * import {formatter} from "@lingui/format-po"
- *
- * export default {
- *   [...]
- *   format: formatter({lineNumbers: false}),
- * }
- * ```
- */
-type CatalogFormat = "lingui" | "minimal" | "po" | "csv" | "po-gettext";
 type ExtractorCtx = {
     /**
      * Raw Sourcemaps object to mapping from.
@@ -23,7 +8,14 @@ type ExtractorCtx = {
 };
 type CatalogExtra = Record<string, unknown>;
 type MessageOrigin = [filename: string, line?: number];
-type ExtractedMessageType<Extra = CatalogExtra> = {
+type ExtractedMessageType = {
+    message?: string;
+    origin: MessageOrigin[];
+    comments: string[];
+    context?: string;
+    placeholders: Record<string, string[]>;
+};
+type MessageType<Extra = CatalogExtra> = {
     message?: string;
     origin?: MessageOrigin[];
     comments?: string[];
@@ -35,19 +27,17 @@ type ExtractedMessageType<Extra = CatalogExtra> = {
      */
     extra?: Extra;
     placeholders?: Record<string, string[]>;
+    translation?: string;
 };
-type MessageType<Extra = CatalogExtra> = ExtractedMessageType<Extra> & {
-    translation: string;
-};
-type ExtractedCatalogType<Extra = CatalogExtra> = {
-    [msgId: string]: ExtractedMessageType<Extra>;
+type ExtractedCatalogType = {
+    [msgId: string]: ExtractedMessageType;
 };
 type CatalogType<Extra = CatalogExtra> = {
     [msgId: string]: MessageType<Extra>;
 };
 type ExtractorType = {
     match(filename: string): boolean;
-    extract(filename: string, code: string, onMessageExtracted: (msg: ExtractedMessage) => void, ctx?: ExtractorCtx): Promise<void> | void;
+    extract(filename: string, code: string, onMessageExtracted: (msg: ExtractedMessage) => void, ctx: ExtractorCtx): Promise<void> | void;
 };
 type CatalogFormatter = {
     catalogExtension: string;
@@ -57,15 +47,15 @@ type CatalogFormatter = {
      */
     templateExtension?: string;
     parse(content: string, ctx: {
-        locale: string | null;
+        locale: string | undefined;
         sourceLocale: string;
         filename: string;
     }): Promise<CatalogType> | CatalogType;
     serialize(catalog: CatalogType, ctx: {
-        locale: string | null;
+        locale: string | undefined;
         sourceLocale: string;
         filename: string;
-        existing: string | null;
+        existing: string | undefined;
     }): Promise<string> | string;
 };
 type ExtractedMessage = {
@@ -76,17 +66,12 @@ type ExtractedMessage = {
     comment?: string;
     placeholders?: Record<string, string>;
 };
-type CatalogFormatOptions = {
-    origins?: boolean;
-    lineNumbers?: boolean;
-    disableSelectWarning?: boolean;
-};
 type OrderByFn = (a: {
     messageId: string;
-    entry: ExtractedMessageType;
+    entry: MessageType;
 }, b: {
     messageId: string;
-    entry: ExtractedMessageType;
+    entry: MessageType;
 }) => number;
 type OrderBy = "messageId" | "message" | "origin" | OrderByFn;
 type CatalogConfig = {
@@ -171,6 +156,19 @@ type LinguiConfig = {
     compileNamespace?: "es" | "ts" | "cjs" | string;
     /**
      * Specify additional options used to parse source files when extracting messages.
+     *
+     * @deprecated please pass options directly to the extractor implementation
+     *
+     * @example
+     * ```ts
+     * import { createBabelExtractor } from '@lingui/cli/api/extractors/babel'
+     *
+     * export default {
+     *   [...]
+     *   extractors: [createBabelExtractor({parserOptions: { tsExperimentalDecorators: true }})],
+     * }
+     * ```
+     * https://lingui.dev/guides/custom-extractor
      */
     extractorParserOptions?: {
         /**
@@ -193,14 +191,26 @@ type LinguiConfig = {
      * https://lingui.dev/guides/custom-extractor
      */
     extractors?: ExtractorType[];
-    prevFormat?: CatalogFormat;
     /**
-     * Message catalog format. The po formatter is used by default. Other formatters are available as separate packages.
+     * Message catalog format. If not set, po formatter would be used.
+     *
+     * Other formatters are available as separate packages.
+     *
+     * If you want to set additional options for po formatter you need to
+     * install it as a separate package and provide in config:
+     *
+     * @example
+     * ```js
+     * import {formatter} from "@lingui/format-po"
+     *
+     * export default {
+     *   [...]
+     *   format: formatter({lineNumbers: false}),
+     * }
+     * ```
      *
-     * @default "po"
      */
-    format?: CatalogFormat | CatalogFormatter;
-    formatOptions?: CatalogFormatOptions;
+    format?: CatalogFormatter;
     /**
      * The locale tags used in the project. The `extract` and `compile` commands write a catalog for each locale specified.
      *
@@ -297,7 +307,7 @@ type LinguiConfig = {
          * msg`Hello` // <-- would be correctly picked up by macro
          * ```
          *
-         * @default ["@lingui/macro", "@lingui/core/macro"]
+         * @default [ "@lingui/core/macro"]
          */
         corePackage?: string[];
         /**
@@ -317,7 +327,7 @@ type LinguiConfig = {
          * <Trans>Hello</Trans> // <-- would be correctly picked up by macro
          * ```
          *
-         * @default ["@lingui/macro", "@lingui/react/macro"]
+         * @default ["@lingui/react/macro"]
          */
         jsxPackage?: string[];
     };
@@ -326,9 +336,8 @@ type LinguiConfig = {
     };
 };
 type ModuleSourceNormalized = readonly [module: string, specifier: string];
-type LinguiConfigNormalized = Omit<LinguiConfig, "runtimeConfigModule"> & {
+type LinguiConfigNormalized = Omit<LinguiConfig & typeof defaultConfig, "runtimeConfigModule"> & {
     resolvedConfigPath?: string;
-    fallbackLocales?: FallbackLocales;
     runtimeConfigModule: {
         i18n: ModuleSourceNormalized;
         useLingui: ModuleSourceNormalized;
@@ -340,6 +349,32 @@ declare function makeConfig(userConfig: Partial<LinguiConfig>, opts?: {
     skipValidation?: boolean;
     resolvedConfigPath?: string;
 }): LinguiConfigNormalized;
+declare const defaultConfig: {
+    catalogs: {
+        path: string;
+        include: string[];
+        exclude: string[];
+    }[];
+    catalogsMergePath: string;
+    compileNamespace: string;
+    compilerBabelOptions: {
+        minified: boolean;
+        jsescOption: {
+            minimal: boolean;
+        };
+    };
+    fallbackLocales: FallbackLocales;
+    locales: never[];
+    orderBy: "message";
+    pseudoLocale: string;
+    rootDir: string;
+    runtimeConfigModule: [string, string];
+    macro: {
+        corePackage: string[];
+        jsxPackage: string[];
+    };
+    sourceLocale: string;
+};
 
 /**
  * Type helper for lingui.config.ts, returns {@link LinguiConfig} object
@@ -352,4 +387,5 @@ declare function getConfig({ cwd, configPath, skipValidation, }?: {
     skipValidation?: boolean;
 }): LinguiConfigNormalized;
 
-export { type CatalogConfig, type CatalogFormat, type CatalogFormatOptions, type CatalogFormatter, type CatalogType, type ExperimentalExtractorOptions, type ExtractedCatalogType, type ExtractedMessage, type ExtractedMessageType, type ExtractorCtx, type ExtractorType, type FallbackLocales, type LinguiConfig, type LinguiConfigNormalized, type MessageOrigin, type MessageType, type OrderBy, type OrderByFn, defineConfig, getConfig, makeConfig };
+export { defineConfig, getConfig, makeConfig };
+export type { CatalogConfig, CatalogFormatter, CatalogType, ExperimentalExtractorOptions, ExtractedCatalogType, ExtractedMessage, ExtractedMessageType, ExtractorCtx, ExtractorType, FallbackLocales, LinguiConfig, LinguiConfigNormalized, MessageOrigin, MessageType, OrderBy, OrderByFn };

package/dist/index.mjs

@@ -1,15 +1,16 @@
-import pico from 'picocolors';
+import { styleText } from 'node:util';
 import { validate, multipleValidOptions } from 'jest-validate';
 import path from 'path';
 import fs from 'fs';
-import { cosmiconfigSync } from 'cosmiconfig';
+import { lilconfigSync } from 'lilconfig';
 import { createJiti } from 'jiti';
+import normalizePath from 'normalize-path';
 
 function replaceRootDir(config, rootDir) {
   if (!rootDir) {
     return config;
   }
-  return function replaceDeep(value, rootDir2) {
+  return (function replaceDeep(value, rootDir2) {
     const replace = (s) => s.replace("<rootDir>", rootDir2);
     if (value == null) {
       return value;
@@ -21,12 +22,11 @@ function replaceRootDir(config, rootDir) {
       Object.keys(value).forEach((key) => {
         const newKey = replaceDeep(key, rootDir2);
         value[newKey] = replaceDeep(value[key], rootDir2);
-        if (key !== newKey)
-          delete value[key];
+        if (key !== newKey) delete value[key];
       });
     }
     return value;
-  }(config, rootDir);
+  })(config, rootDir);
 }
 
 function setCldrParentLocales(config) {
@@ -274,8 +274,10 @@ function makeConfig(userConfig, opts = {}) {
     }
   };
   if (!opts.skipValidation) {
+    validateFormat(config);
     validate(config, configValidation);
     validateLocales(config);
+    deprecateParserOptions(config);
   }
   config = setCldrParentLocales(config);
   config = normalizeRuntimeConfigModule(config);
@@ -304,28 +306,21 @@ const defaultConfig = {
       minimal: true
     }
   },
-  extractorParserOptions: {
-    flow: false,
-    tsExperimentalDecorators: false
-  },
   fallbackLocales: {},
-  format: "po",
-  formatOptions: { origins: true, lineNumbers: true },
   locales: [],
   orderBy: "message",
   pseudoLocale: "",
   rootDir: ".",
   runtimeConfigModule: ["@lingui/core", "i18n"],
   macro: {
-    corePackage: ["@lingui/macro", "@lingui/core/macro"],
-    jsxPackage: ["@lingui/macro", "@lingui/react/macro"]
+    corePackage: ["@lingui/core/macro"],
+    jsxPackage: ["@lingui/react/macro"]
   },
-  sourceLocale: "",
-  service: { name: "", apiKey: "" }
+  sourceLocale: ""
 };
 const exampleConfig = {
   ...defaultConfig,
-  format: multipleValidOptions({}, "po"),
+  format: multipleValidOptions({}, {}),
   extractors: multipleValidOptions([], ["babel"], [Object]),
   runtimeConfigModule: multipleValidOptions(
     { i18n: ["@lingui/core", "i18n"], Trans: ["@lingui/react", "Trans"] },
@@ -342,6 +337,10 @@ const exampleConfig = {
     flow: false,
     tsExperimentalDecorators: false
   },
+  service: {
+    apiKey: "",
+    name: ""
+  },
   experimental: {
     extractor: {
       entries: [],
@@ -357,13 +356,49 @@ const configValidation = {
   exampleConfig,
   comment: "Documentation: https://lingui.dev/ref/conf"
 };
+function deprecateParserOptions(config) {
+  if (config.extractorParserOptions) {
+    console.error(
+      `\`extractorParserOptions\` config option is deprecated.
+      
+Please pass options directly to the extractor implementation:
+      
+import { createBabelExtractor } from '@lingui/cli/api/extractors/babel'
+
+export default {
+  [...]
+  extractors: [createBabelExtractor({parserOptions: { tsExperimentalDecorators: true }})],
+}
+`.trim()
+    );
+  }
+}
+function validateFormat(config) {
+  if (typeof config.format === "string") {
+    throw new Error(
+      `String formats like \`{format: ${config.format}}\` are no longer supported.
+      
+Formatters must now be installed as separate packages and provided via format in lingui config:
+        
+import { formatter } from "@lingui/format-po"
+
+export default {
+  [...]
+  format: formatter({lineNumbers: false}),
+}
+`.trim()
+    );
+  }
+}
 function validateLocales(config) {
   if (!Array.isArray(config.locales) || !config.locales.length) {
     console.error("No locales defined!\n");
     console.error(
-      `Add ${pico.yellow(
+      `Add ${styleText(
+        "yellow",
         "'locales'"
-      )} to your configuration. See ${pico.underline(
+      )} to your configuration. See ${styleText(
+        "underline",
         "https://lingui.dev/ref/conf#locales"
       )}`
     );
@@ -379,13 +414,13 @@ function configExists(path2) {
 }
 function JitiLoader() {
   return (filepath) => {
-    const jiti = createJiti(__filename);
+    const jiti = createJiti(import.meta.url);
     const mod = jiti(filepath);
     return mod?.default ?? mod;
   };
 }
 const moduleName = "lingui";
-const configExplorer = cosmiconfigSync(moduleName, {
+const configExplorer = lilconfigSync(moduleName, {
   searchPlaces: [
     `${moduleName}.config.js`,
     `${moduleName}.config.cjs`,
@@ -394,8 +429,6 @@ const configExplorer = cosmiconfigSync(moduleName, {
     "package.json",
     `.${moduleName}rc`,
     `.${moduleName}rc.json`,
-    `.${moduleName}rc.yaml`,
-    `.${moduleName}rc.yml`,
     `.${moduleName}rc.ts`,
     `.${moduleName}rc.js`
   ],
@@ -412,23 +445,29 @@ function getConfig({
 } = {}) {
   const defaultRootDir = cwd || process.cwd();
   configPath = configPath || process.env.LINGUI_CONFIG;
-  const result = configExists(configPath) ? configExplorer.load(configPath) : configExplorer.search(defaultRootDir);
+  let result;
+  try {
+    result = configExists(configPath) ? configExplorer.load(configPath) : configExplorer.search(defaultRootDir);
+  } catch (error) {
+    result = null;
+  }
   if (!result) {
     console.error("Lingui was unable to find a config!\n");
     console.error(
-      `Create ${pico.bold(
+      `Create ${styleText(
+        "bold",
         "'lingui.config.js'"
-      )} file with LinguiJS configuration in root of your project (next to package.json). See ${pico.underline(
+      )} file with LinguiJS configuration in root of your project (next to package.json). See ${styleText(
+        "underline",
         "https://lingui.dev/ref/conf"
       )}`
     );
     throw new Error("No Lingui config found");
   }
-  const userConfig = result ? result.config : {};
   return makeConfig(
     {
-      rootDir: result ? path.dirname(result.filepath) : defaultRootDir,
-      ...userConfig
+      rootDir: result ? normalizePath(path.dirname(result.filepath)) : defaultRootDir,
+      ...result.config
     },
     { skipValidation, resolvedConfigPath: result.filepath }
   );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/conf",
-  "version": "5.9.3",
+  "version": "6.0.0-next.1",
   "sideEffects": false,
   "description": "Get lingui configuration from package.json",
   "keywords": [
@@ -19,22 +19,22 @@
     "name": "Tomáš Ehrlich",
     "email": "tomas.ehrlich@gmail.com"
   },
-  "main": "dist/index.cjs",
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
+  "type": "module",
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=22.19.0"
   },
   "scripts": {
-    "build": "rimraf ./dist && unbuild",
-    "stub": "unbuild --stub"
+    "build": "unbuild",
+    "check-types": "tsc --noEmit"
+  },
+  "exports": {
+    ".": "./dist/index.mjs"
   },
   "dependencies": {
-    "@babel/runtime": "^7.20.13",
-    "cosmiconfig": "^8.0.0",
     "jest-validate": "^29.4.3",
     "jiti": "^2.5.1",
-    "picocolors": "^1.1.1"
+    "lilconfig": "^3.1.3",
+    "normalize-path": "^3.0.0"
   },
   "files": [
     "LICENSE",
@@ -42,8 +42,13 @@
     "/dist"
   ],
   "devDependencies": {
-    "@lingui/jest-mocks": "*",
-    "unbuild": "^2.0.0"
+    "@lingui/test-utils": "3.0.3",
+    "@types/normalize-path": "^3.0.0",
+    "unbuild": "3.6.1",
+    "vitest": "4.0.18"
+  },
+  "unbuild": {
+    "declaration": "node16"
   },
-  "gitHead": "67be09ce3416ebd662822bf0689454dbb5e3261a"
+  "gitHead": "783af0c0371c7795e1fc43316f49dd253e161221"
 }