@lingui/conf 5.2.0 → 5.3.0

package/dist/index.cjs

@@ -271,7 +271,11 @@ function normalizeRuntimeConfigModule(config) {
 function makeConfig(userConfig, opts = {}) {
   let config = {
     ...defaultConfig,
-    ...userConfig
+    ...userConfig,
+    macro: {
+      ...defaultConfig.macro,
+      ...userConfig.macro
+    }
   };
   if (!opts.skipValidation) {
     jestValidate.validate(config, configValidation);
@@ -312,6 +316,10 @@ const defaultConfig = {
   pseudoLocale: "",
   rootDir: ".",
   runtimeConfigModule: ["@lingui/core", "i18n"],
+  macro: {
+    corePackage: ["@lingui/macro", "@lingui/core/macro"],
+    jsxPackage: ["@lingui/macro", "@lingui/react/macro"]
+  },
   sourceLocale: "",
   service: { name: "", apiKey: "" }
 };

package/dist/index.d.cts

@@ -154,8 +154,17 @@ type ExperimentalExtractorOptions = {
     resolveEsbuildOptions?: (options: any) => any;
 };
 type LinguiConfig = {
+    /**
+     * The catalogs configuration defines the location of message catalogs and specifies
+     * which files are included when the extract command scans for messages.
+     *
+     * https://lingui.dev/ref/conf#catalogs
+     */
     catalogs?: CatalogConfig[];
     compileNamespace?: "es" | "ts" | "cjs" | string;
+    /**
+     * Specify additional options used to parse source files when extracting messages.
+     */
     extractorParserOptions?: {
         /**
          * default false
@@ -171,19 +180,130 @@ type LinguiConfig = {
     };
     compilerBabelOptions?: any;
     fallbackLocales?: FallbackLocales | false;
+    /**
+     * Specifies custom message extractor implementations
+     *
+     * https://lingui.dev/guides/custom-extractor
+     */
     extractors?: ExtractorType[];
     prevFormat?: CatalogFormat;
-    localeDir?: string;
+    /**
+     * Message catalog format. The po formatter is used by default. Other formatters are available as separate packages.
+     *
+     * @default "po"
+     */
     format?: CatalogFormat | CatalogFormatter;
     formatOptions?: CatalogFormatOptions;
+    /**
+     * The locale tags used in the project. The `extract` and `compile` commands write a catalog for each locale specified.
+     *
+     * Each locale should be a valid BCP-47 code:
+     * @example
+     *
+     * ```js
+     * locales: ["en", "cs"]
+     * ```
+     */
     locales: string[];
+    /**
+     * Define the path where translated catalogs are merged into a single file per locale during the compile process.
+     *
+     * https://lingui.dev/ref/conf#catalogsmergepath
+     */
     catalogsMergePath?: string;
+    /**
+     * Order of messages in catalog
+     *
+     * @default "message"
+     */
     orderBy?: OrderBy;
+    /**
+     * Locale used for pseudolocalization. For example, when you set `pseudoLocale: "en"`, all messages in the en catalog will be pseudo-localized.
+     * The locale must be included in the locales config.
+     *
+     * https://lingui.dev/guides/pseudolocalization
+     */
     pseudoLocale?: string;
+    /**
+     * This is the directory where the Lingui CLI scans for messages in your source files during the extraction process.
+     *
+     * Note that using <rootDir> as a string token in any other path-based config settings will refer back to this value.
+     *
+     * @defaul: The root of the directory containing your Lingui configuration file or the package.json.
+     */
     rootDir?: string;
+    /**
+     * This setting specifies the module path for the exported `i18n` object and `Trans` component.
+     *
+     * @example
+     *
+     * ```js
+     * {
+     *   "runtimeConfigModule": {
+     *     "Trans": ["./myTrans", "Trans"],
+     *     "useLingui": ["./myUseLingui", "useLingui"]
+     *     "i18n": ["./nyI18n", "I18n"]
+     *   }
+     * }
+     * ```
+     */
     runtimeConfigModule?: ModuleSource | Partial<Record<"useLingui" | "Trans" | "i18n", ModuleSource>>;
+    /**
+     * Specifies the default language of message IDs in your source files.
+     *
+     * The catalog for sourceLocale doesn't need actual translations since message IDs are used as-is by default.
+     * However, you can still override any message ID by providing a custom translation.
+     *
+     * The main difference between `sourceLocale` and `fallbackLocales` is their purpose: `sourceLocale` defines the language used for message IDs,
+     * while `fallbackLocales` provides alternative translations when specific messages are missing for a particular locale.
+     */
     sourceLocale?: string;
     service?: CatalogService;
+    /**
+     * Allow you to set macro options
+     */
+    macro?: {
+        /**
+         * Allows customizing the Core Macro package name that the Lingui macro detects.
+         *
+         * ```ts
+         * // lingui.config
+         * {
+         *   macro: {
+         *    corePackage: ['@lingui/myMacro']
+         *   }
+         * }
+         *
+         * // app.tsx
+         * import { msg } from '@lingui/myMacro'
+         *
+         * msg`Hello` // <-- would be correctly picked up by macro
+         * ```
+         *
+         * @default ["@lingui/macro", "@lingui/core/macro"]
+         */
+        corePackage?: string[];
+        /**
+         * Allows customizing the JSX Macro package name that the Lingui macro detects.
+         *
+         * ```ts
+         * // lingui.config
+         * {
+         *   macro: {
+         *     jsxPackage: ["@lingui/myMacro"];
+         *   }
+         * }
+         *
+         * // app.tsx
+         * import { Trans } from '@lingui/myMacro'
+         *
+         * <Trans>Hello</Trans> // <-- would be correctly picked up by macro
+         * ```
+         *
+         * @default ["@lingui/macro", "@lingui/react/macro"]
+         */
+        jsxPackage?: string[];
+    };
     experimental?: {
         extractor?: ExperimentalExtractorOptions;
     };

package/dist/index.d.mts

@@ -154,8 +154,17 @@ type ExperimentalExtractorOptions = {
     resolveEsbuildOptions?: (options: any) => any;
 };
 type LinguiConfig = {
+    /**
+     * The catalogs configuration defines the location of message catalogs and specifies
+     * which files are included when the extract command scans for messages.
+     *
+     * https://lingui.dev/ref/conf#catalogs
+     */
     catalogs?: CatalogConfig[];
     compileNamespace?: "es" | "ts" | "cjs" | string;
+    /**
+     * Specify additional options used to parse source files when extracting messages.
+     */
     extractorParserOptions?: {
         /**
          * default false
@@ -171,19 +180,130 @@ type LinguiConfig = {
     };
     compilerBabelOptions?: any;
     fallbackLocales?: FallbackLocales | false;
+    /**
+     * Specifies custom message extractor implementations
+     *
+     * https://lingui.dev/guides/custom-extractor
+     */
     extractors?: ExtractorType[];
     prevFormat?: CatalogFormat;
-    localeDir?: string;
+    /**
+     * Message catalog format. The po formatter is used by default. Other formatters are available as separate packages.
+     *
+     * @default "po"
+     */
     format?: CatalogFormat | CatalogFormatter;
     formatOptions?: CatalogFormatOptions;
+    /**
+     * The locale tags used in the project. The `extract` and `compile` commands write a catalog for each locale specified.
+     *
+     * Each locale should be a valid BCP-47 code:
+     * @example
+     *
+     * ```js
+     * locales: ["en", "cs"]
+     * ```
+     */
     locales: string[];
+    /**
+     * Define the path where translated catalogs are merged into a single file per locale during the compile process.
+     *
+     * https://lingui.dev/ref/conf#catalogsmergepath
+     */
     catalogsMergePath?: string;
+    /**
+     * Order of messages in catalog
+     *
+     * @default "message"
+     */
     orderBy?: OrderBy;
+    /**
+     * Locale used for pseudolocalization. For example, when you set `pseudoLocale: "en"`, all messages in the en catalog will be pseudo-localized.
+     * The locale must be included in the locales config.
+     *
+     * https://lingui.dev/guides/pseudolocalization
+     */
     pseudoLocale?: string;
+    /**
+     * This is the directory where the Lingui CLI scans for messages in your source files during the extraction process.
+     *
+     * Note that using <rootDir> as a string token in any other path-based config settings will refer back to this value.
+     *
+     * @defaul: The root of the directory containing your Lingui configuration file or the package.json.
+     */
     rootDir?: string;
+    /**
+     * This setting specifies the module path for the exported `i18n` object and `Trans` component.
+     *
+     * @example
+     *
+     * ```js
+     * {
+     *   "runtimeConfigModule": {
+     *     "Trans": ["./myTrans", "Trans"],
+     *     "useLingui": ["./myUseLingui", "useLingui"]
+     *     "i18n": ["./nyI18n", "I18n"]
+     *   }
+     * }
+     * ```
+     */
     runtimeConfigModule?: ModuleSource | Partial<Record<"useLingui" | "Trans" | "i18n", ModuleSource>>;
+    /**
+     * Specifies the default language of message IDs in your source files.
+     *
+     * The catalog for sourceLocale doesn't need actual translations since message IDs are used as-is by default.
+     * However, you can still override any message ID by providing a custom translation.
+     *
+     * The main difference between `sourceLocale` and `fallbackLocales` is their purpose: `sourceLocale` defines the language used for message IDs,
+     * while `fallbackLocales` provides alternative translations when specific messages are missing for a particular locale.
+     */
     sourceLocale?: string;
     service?: CatalogService;
+    /**
+     * Allow you to set macro options
+     */
+    macro?: {
+        /**
+         * Allows customizing the Core Macro package name that the Lingui macro detects.
+         *
+         * ```ts
+         * // lingui.config
+         * {
+         *   macro: {
+         *    corePackage: ['@lingui/myMacro']
+         *   }
+         * }
+         *
+         * // app.tsx
+         * import { msg } from '@lingui/myMacro'
+         *
+         * msg`Hello` // <-- would be correctly picked up by macro
+         * ```
+         *
+         * @default ["@lingui/macro", "@lingui/core/macro"]
+         */
+        corePackage?: string[];
+        /**
+         * Allows customizing the JSX Macro package name that the Lingui macro detects.
+         *
+         * ```ts
+         * // lingui.config
+         * {
+         *   macro: {
+         *     jsxPackage: ["@lingui/myMacro"];
+         *   }
+         * }
+         *
+         * // app.tsx
+         * import { Trans } from '@lingui/myMacro'
+         *
+         * <Trans>Hello</Trans> // <-- would be correctly picked up by macro
+         * ```
+         *
+         * @default ["@lingui/macro", "@lingui/react/macro"]
+         */
+        jsxPackage?: string[];
+    };
     experimental?: {
         extractor?: ExperimentalExtractorOptions;
     };

package/dist/index.d.ts

@@ -154,8 +154,17 @@ type ExperimentalExtractorOptions = {
     resolveEsbuildOptions?: (options: any) => any;
 };
 type LinguiConfig = {
+    /**
+     * The catalogs configuration defines the location of message catalogs and specifies
+     * which files are included when the extract command scans for messages.
+     *
+     * https://lingui.dev/ref/conf#catalogs
+     */
     catalogs?: CatalogConfig[];
     compileNamespace?: "es" | "ts" | "cjs" | string;
+    /**
+     * Specify additional options used to parse source files when extracting messages.
+     */
     extractorParserOptions?: {
         /**
          * default false
@@ -171,19 +180,130 @@ type LinguiConfig = {
     };
     compilerBabelOptions?: any;
     fallbackLocales?: FallbackLocales | false;
+    /**
+     * Specifies custom message extractor implementations
+     *
+     * https://lingui.dev/guides/custom-extractor
+     */
     extractors?: ExtractorType[];
     prevFormat?: CatalogFormat;
-    localeDir?: string;
+    /**
+     * Message catalog format. The po formatter is used by default. Other formatters are available as separate packages.
+     *
+     * @default "po"
+     */
     format?: CatalogFormat | CatalogFormatter;
     formatOptions?: CatalogFormatOptions;
+    /**
+     * The locale tags used in the project. The `extract` and `compile` commands write a catalog for each locale specified.
+     *
+     * Each locale should be a valid BCP-47 code:
+     * @example
+     *
+     * ```js
+     * locales: ["en", "cs"]
+     * ```
+     */
     locales: string[];
+    /**
+     * Define the path where translated catalogs are merged into a single file per locale during the compile process.
+     *
+     * https://lingui.dev/ref/conf#catalogsmergepath
+     */
     catalogsMergePath?: string;
+    /**
+     * Order of messages in catalog
+     *
+     * @default "message"
+     */
     orderBy?: OrderBy;
+    /**
+     * Locale used for pseudolocalization. For example, when you set `pseudoLocale: "en"`, all messages in the en catalog will be pseudo-localized.
+     * The locale must be included in the locales config.
+     *
+     * https://lingui.dev/guides/pseudolocalization
+     */
     pseudoLocale?: string;
+    /**
+     * This is the directory where the Lingui CLI scans for messages in your source files during the extraction process.
+     *
+     * Note that using <rootDir> as a string token in any other path-based config settings will refer back to this value.
+     *
+     * @defaul: The root of the directory containing your Lingui configuration file or the package.json.
+     */
     rootDir?: string;
+    /**
+     * This setting specifies the module path for the exported `i18n` object and `Trans` component.
+     *
+     * @example
+     *
+     * ```js
+     * {
+     *   "runtimeConfigModule": {
+     *     "Trans": ["./myTrans", "Trans"],
+     *     "useLingui": ["./myUseLingui", "useLingui"]
+     *     "i18n": ["./nyI18n", "I18n"]
+     *   }
+     * }
+     * ```
+     */
     runtimeConfigModule?: ModuleSource | Partial<Record<"useLingui" | "Trans" | "i18n", ModuleSource>>;
+    /**
+     * Specifies the default language of message IDs in your source files.
+     *
+     * The catalog for sourceLocale doesn't need actual translations since message IDs are used as-is by default.
+     * However, you can still override any message ID by providing a custom translation.
+     *
+     * The main difference between `sourceLocale` and `fallbackLocales` is their purpose: `sourceLocale` defines the language used for message IDs,
+     * while `fallbackLocales` provides alternative translations when specific messages are missing for a particular locale.
+     */
     sourceLocale?: string;
     service?: CatalogService;
+    /**
+     * Allow you to set macro options
+     */
+    macro?: {
+        /**
+         * Allows customizing the Core Macro package name that the Lingui macro detects.
+         *
+         * ```ts
+         * // lingui.config
+         * {
+         *   macro: {
+         *    corePackage: ['@lingui/myMacro']
+         *   }
+         * }
+         *
+         * // app.tsx
+         * import { msg } from '@lingui/myMacro'
+         *
+         * msg`Hello` // <-- would be correctly picked up by macro
+         * ```
+         *
+         * @default ["@lingui/macro", "@lingui/core/macro"]
+         */
+        corePackage?: string[];
+        /**
+         * Allows customizing the JSX Macro package name that the Lingui macro detects.
+         *
+         * ```ts
+         * // lingui.config
+         * {
+         *   macro: {
+         *     jsxPackage: ["@lingui/myMacro"];
+         *   }
+         * }
+         *
+         * // app.tsx
+         * import { Trans } from '@lingui/myMacro'
+         *
+         * <Trans>Hello</Trans> // <-- would be correctly picked up by macro
+         * ```
+         *
+         * @default ["@lingui/macro", "@lingui/react/macro"]
+         */
+        jsxPackage?: string[];
+    };
     experimental?: {
         extractor?: ExperimentalExtractorOptions;
     };

package/dist/index.mjs

@@ -263,7 +263,11 @@ function normalizeRuntimeConfigModule(config) {
 function makeConfig(userConfig, opts = {}) {
   let config = {
     ...defaultConfig,
-    ...userConfig
+    ...userConfig,
+    macro: {
+      ...defaultConfig.macro,
+      ...userConfig.macro
+    }
   };
   if (!opts.skipValidation) {
     validate(config, configValidation);
@@ -304,6 +308,10 @@ const defaultConfig = {
   pseudoLocale: "",
   rootDir: ".",
   runtimeConfigModule: ["@lingui/core", "i18n"],
+  macro: {
+    corePackage: ["@lingui/macro", "@lingui/core/macro"],
+    jsxPackage: ["@lingui/macro", "@lingui/react/macro"]
+  },
   sourceLocale: "",
   service: { name: "", apiKey: "" }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/conf",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "sideEffects": false,
   "description": "Get lingui configuration from package.json",
   "keywords": [
@@ -42,5 +42,5 @@
     "tsd": "^0.26.1",
     "unbuild": "^2.0.0"
   },
-  "gitHead": "9c50b4877ca8b134d0d96c09a8055221ca70b095"
+  "gitHead": "ed491cce7e5209378922327e0e7b802fb7b5873d"
 }