@lingui/conf 4.4.2 → 4.5.0

package/dist/index.cjs

@@ -6,6 +6,12 @@ const path = require('path');
 const fs = require('fs');
 const cosmiconfig = require('cosmiconfig');
 
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+const path__default = /*#__PURE__*/_interopDefaultCompat(path);
+const fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
 function replaceRootDir(config, rootDir) {
   return function replaceDeep(value, rootDir2) {
     const replace = (s) => s.replace("<rootDir>", rootDir2);
@@ -226,7 +232,7 @@ function getCldrParentLocale(sourceLocale) {
   }[sourceLocale];
 }
 
-const pathJoinPosix = (...values) => path.join(...values).split(path.sep).join("/");
+const pathJoinPosix = (...values) => path__default.join(...values).split(path__default.sep).join("/");
 
 const getSymbolSource = (defaults, config) => {
   const name = defaults[1];
@@ -339,7 +345,7 @@ const exampleConfig = {
   }
 };
 const extractBabelOptionsDeprecations = {
-  extractBabelOptions: () => ` Option ${chalk.bold("extractBabelOptions")} was removed. 
+  extractBabelOptions: () => ` Option ${chalk__default.bold("extractBabelOptions")} was removed. 
     
     Please remove it from your config file. 
 
@@ -357,9 +363,9 @@ function validateLocales(config) {
   if (!Array.isArray(config.locales) || !config.locales.length) {
     console.error("No locales defined!\n");
     console.error(
-      `Add ${chalk.yellow(
+      `Add ${chalk__default.yellow(
         "'locales'"
-      )} to your configuration. See ${chalk.underline(
+      )} to your configuration. See ${chalk__default.underline(
         "https://lingui.dev/ref/conf#locales"
       )}`
     );
@@ -368,7 +374,7 @@ function validateLocales(config) {
 const pipe = (...functions) => (args) => functions.reduce((arg, fn) => fn(arg), args);
 
 function configExists(path2) {
-  return path2 && fs.existsSync(path2);
+  return path2 && fs__default.existsSync(path2);
 }
 function JitiLoader() {
   return (filepath, content) => {
@@ -411,9 +417,9 @@ function getConfig({
   if (!result) {
     console.error("Lingui was unable to find a config!\n");
     console.error(
-      `Create ${chalk.bold(
+      `Create ${chalk__default.bold(
         "'lingui.config.js'"
-      )} file with LinguiJS configuration in root of your project (next to package.json). See ${chalk.underline(
+      )} file with LinguiJS configuration in root of your project (next to package.json). See ${chalk__default.underline(
         "https://lingui.dev/ref/conf"
       )}`
     );
@@ -422,7 +428,7 @@ function getConfig({
   const userConfig = result ? result.config : {};
   return makeConfig(
     {
-      rootDir: result ? path.dirname(result.filepath) : defaultRootDir,
+      rootDir: result ? path__default.dirname(result.filepath) : defaultRootDir,
       ...userConfig
     },
     { skipValidation }

package/dist/index.d.cts

@@ -0,0 +1,211 @@
+/**
+ * @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.
+     * Check the https://github.com/mozilla/source-map#new-sourcemapconsumerrawsourcemap
+     */
+    sourceMaps?: any;
+    linguiConfig: LinguiConfigNormalized;
+};
+type CatalogExtra = Record<string, unknown>;
+type MessageOrigin = [filename: string, line?: number];
+type ExtractedMessageType<Extra = CatalogExtra> = {
+    message?: string;
+    origin?: MessageOrigin[];
+    comments?: string[];
+    obsolete?: boolean;
+    context?: string;
+    /**
+     * the generic field where
+     * formatters can store additional data
+     */
+    extra?: Extra;
+};
+type MessageType<Extra = CatalogExtra> = ExtractedMessageType<Extra> & {
+    translation: string;
+};
+type ExtractedCatalogType<Extra = CatalogExtra> = {
+    [msgId: string]: ExtractedMessageType<Extra>;
+};
+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;
+};
+type CatalogFormatter = {
+    catalogExtension: string;
+    /**
+     * Set extension used when extract to template
+     * Omit if the extension is the same as catalogExtension
+     */
+    templateExtension?: string;
+    parse(content: string, ctx: {
+        locale: string | null;
+        sourceLocale: string;
+        filename: string;
+    }): Promise<CatalogType> | CatalogType;
+    serialize(catalog: CatalogType, ctx: {
+        locale: string | null;
+        sourceLocale: string;
+        filename: string;
+        existing: string | null;
+    }): Promise<string> | string;
+};
+type ExtractedMessage = {
+    id: string;
+    message?: string;
+    context?: string;
+    origin?: [filename: string, line: number, column?: number];
+    comment?: string;
+};
+type CatalogFormatOptions = {
+    origins?: boolean;
+    lineNumbers?: boolean;
+    disableSelectWarning?: boolean;
+};
+type OrderBy = "messageId" | "message" | "origin";
+type CatalogConfig = {
+    name?: string;
+    path: string;
+    include: string[];
+    exclude?: string[];
+};
+type LocaleObject = {
+    [locale: string]: string[] | string;
+    default?: string;
+};
+type FallbackLocales = LocaleObject;
+type ModuleSource = [string, string?];
+type CatalogService = {
+    name: string;
+    apiKey: string;
+};
+type ExperimentalExtractorOptions = {
+    /**
+     * Entries to start extracting from.
+     * Each separate resolved entry would create a separate catalog.
+     *
+     * Example for MPA application like Next.js
+     * ```
+     * <rootDir>/pages/**\/*.ts
+     * <rootDir>/pages/**\/*.page.ts
+     * ```
+     *
+     * With this config you would have a separate
+     * catalog for every page file in your app.
+     */
+    entries: string[];
+    /**
+     * Explicitly include some dependency for extraction.
+     * For example, you can include all monorepo's packages as
+     * ["@mycompany/"]
+     */
+    includeDeps?: string[];
+    /**
+     * By default all dependencies from package.json would be ecxluded from analyzing.
+     * If something was not properly discovered you can add it here.
+     *
+     * Note: it automatically matches also sub imports
+     *
+     * "next" would match "next" and "next/head"
+     */
+    excludeDeps?: string[];
+    /**
+     * svg, jpg and other files which might be imported in application should be exluded from analysis.
+     * By default extractor provides a comprehensive list of extensions. If you feel like somthing is missing in this list please fill an issue on GitHub
+     *
+     * NOTE: changing this param will override default list of extensions.
+     */
+    excludeExtensions?: string[];
+    /**
+     * output path for extracted catalogs.
+     *
+     * Supported placeholders for entry: /pages/about/index.page.ts
+     *  - {entryName} = index.page
+     *  - {locale} = en
+     *  - {entryDir} = pages/about/
+     *
+     * Examples:
+     *
+     * ```
+     * <rootDir>/locales/{entryName}.{locale} -> /locales/index.page/en.po
+     * <rootDir>/{entryDir}/locales/{locale} -> /pages/about/locales/en.po
+     * ```
+     */
+    output: string;
+    resolveEsbuildOptions?: (options: any) => any;
+};
+type LinguiConfig = {
+    catalogs?: CatalogConfig[];
+    compileNamespace?: "es" | "ts" | "cjs" | string;
+    extractorParserOptions?: {
+        /**
+         * default false
+         *
+         * By default, standard decorators (Stage3) are applied for TS files
+         * Enable this if you want to use TypesScript's experimental decorators.
+         */
+        tsExperimentalDecorators?: boolean;
+        /**
+         * Enable if you use flow. This will apply Flow syntax to js files
+         */
+        flow?: boolean;
+    };
+    compilerBabelOptions?: any;
+    fallbackLocales?: FallbackLocales | false;
+    extractors?: (string | ExtractorType)[];
+    prevFormat?: CatalogFormat;
+    localeDir?: string;
+    format?: CatalogFormat | CatalogFormatter;
+    formatOptions?: CatalogFormatOptions;
+    locales: string[];
+    catalogsMergePath?: string;
+    orderBy?: OrderBy;
+    pseudoLocale?: string;
+    rootDir?: string;
+    runtimeConfigModule?: ModuleSource | {
+        [symbolName: string]: ModuleSource;
+    };
+    sourceLocale?: string;
+    service?: CatalogService;
+    experimental?: {
+        extractor?: ExperimentalExtractorOptions;
+    };
+};
+type LinguiConfigNormalized = Omit<LinguiConfig, "runtimeConfigModule"> & {
+    fallbackLocales?: FallbackLocales;
+    runtimeConfigModule: {
+        i18nImportModule: string;
+        i18nImportName: string;
+        TransImportModule: string;
+        TransImportName: string;
+    };
+};
+
+declare function makeConfig(userConfig: Partial<LinguiConfig>, opts?: {
+    skipValidation?: boolean;
+}): LinguiConfigNormalized;
+
+declare function getConfig({ cwd, configPath, skipValidation, }?: {
+    cwd?: string;
+    configPath?: string;
+    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, getConfig, makeConfig };

package/dist/index.d.mts

@@ -0,0 +1,211 @@
+/**
+ * @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.
+     * Check the https://github.com/mozilla/source-map#new-sourcemapconsumerrawsourcemap
+     */
+    sourceMaps?: any;
+    linguiConfig: LinguiConfigNormalized;
+};
+type CatalogExtra = Record<string, unknown>;
+type MessageOrigin = [filename: string, line?: number];
+type ExtractedMessageType<Extra = CatalogExtra> = {
+    message?: string;
+    origin?: MessageOrigin[];
+    comments?: string[];
+    obsolete?: boolean;
+    context?: string;
+    /**
+     * the generic field where
+     * formatters can store additional data
+     */
+    extra?: Extra;
+};
+type MessageType<Extra = CatalogExtra> = ExtractedMessageType<Extra> & {
+    translation: string;
+};
+type ExtractedCatalogType<Extra = CatalogExtra> = {
+    [msgId: string]: ExtractedMessageType<Extra>;
+};
+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;
+};
+type CatalogFormatter = {
+    catalogExtension: string;
+    /**
+     * Set extension used when extract to template
+     * Omit if the extension is the same as catalogExtension
+     */
+    templateExtension?: string;
+    parse(content: string, ctx: {
+        locale: string | null;
+        sourceLocale: string;
+        filename: string;
+    }): Promise<CatalogType> | CatalogType;
+    serialize(catalog: CatalogType, ctx: {
+        locale: string | null;
+        sourceLocale: string;
+        filename: string;
+        existing: string | null;
+    }): Promise<string> | string;
+};
+type ExtractedMessage = {
+    id: string;
+    message?: string;
+    context?: string;
+    origin?: [filename: string, line: number, column?: number];
+    comment?: string;
+};
+type CatalogFormatOptions = {
+    origins?: boolean;
+    lineNumbers?: boolean;
+    disableSelectWarning?: boolean;
+};
+type OrderBy = "messageId" | "message" | "origin";
+type CatalogConfig = {
+    name?: string;
+    path: string;
+    include: string[];
+    exclude?: string[];
+};
+type LocaleObject = {
+    [locale: string]: string[] | string;
+    default?: string;
+};
+type FallbackLocales = LocaleObject;
+type ModuleSource = [string, string?];
+type CatalogService = {
+    name: string;
+    apiKey: string;
+};
+type ExperimentalExtractorOptions = {
+    /**
+     * Entries to start extracting from.
+     * Each separate resolved entry would create a separate catalog.
+     *
+     * Example for MPA application like Next.js
+     * ```
+     * <rootDir>/pages/**\/*.ts
+     * <rootDir>/pages/**\/*.page.ts
+     * ```
+     *
+     * With this config you would have a separate
+     * catalog for every page file in your app.
+     */
+    entries: string[];
+    /**
+     * Explicitly include some dependency for extraction.
+     * For example, you can include all monorepo's packages as
+     * ["@mycompany/"]
+     */
+    includeDeps?: string[];
+    /**
+     * By default all dependencies from package.json would be ecxluded from analyzing.
+     * If something was not properly discovered you can add it here.
+     *
+     * Note: it automatically matches also sub imports
+     *
+     * "next" would match "next" and "next/head"
+     */
+    excludeDeps?: string[];
+    /**
+     * svg, jpg and other files which might be imported in application should be exluded from analysis.
+     * By default extractor provides a comprehensive list of extensions. If you feel like somthing is missing in this list please fill an issue on GitHub
+     *
+     * NOTE: changing this param will override default list of extensions.
+     */
+    excludeExtensions?: string[];
+    /**
+     * output path for extracted catalogs.
+     *
+     * Supported placeholders for entry: /pages/about/index.page.ts
+     *  - {entryName} = index.page
+     *  - {locale} = en
+     *  - {entryDir} = pages/about/
+     *
+     * Examples:
+     *
+     * ```
+     * <rootDir>/locales/{entryName}.{locale} -> /locales/index.page/en.po
+     * <rootDir>/{entryDir}/locales/{locale} -> /pages/about/locales/en.po
+     * ```
+     */
+    output: string;
+    resolveEsbuildOptions?: (options: any) => any;
+};
+type LinguiConfig = {
+    catalogs?: CatalogConfig[];
+    compileNamespace?: "es" | "ts" | "cjs" | string;
+    extractorParserOptions?: {
+        /**
+         * default false
+         *
+         * By default, standard decorators (Stage3) are applied for TS files
+         * Enable this if you want to use TypesScript's experimental decorators.
+         */
+        tsExperimentalDecorators?: boolean;
+        /**
+         * Enable if you use flow. This will apply Flow syntax to js files
+         */
+        flow?: boolean;
+    };
+    compilerBabelOptions?: any;
+    fallbackLocales?: FallbackLocales | false;
+    extractors?: (string | ExtractorType)[];
+    prevFormat?: CatalogFormat;
+    localeDir?: string;
+    format?: CatalogFormat | CatalogFormatter;
+    formatOptions?: CatalogFormatOptions;
+    locales: string[];
+    catalogsMergePath?: string;
+    orderBy?: OrderBy;
+    pseudoLocale?: string;
+    rootDir?: string;
+    runtimeConfigModule?: ModuleSource | {
+        [symbolName: string]: ModuleSource;
+    };
+    sourceLocale?: string;
+    service?: CatalogService;
+    experimental?: {
+        extractor?: ExperimentalExtractorOptions;
+    };
+};
+type LinguiConfigNormalized = Omit<LinguiConfig, "runtimeConfigModule"> & {
+    fallbackLocales?: FallbackLocales;
+    runtimeConfigModule: {
+        i18nImportModule: string;
+        i18nImportName: string;
+        TransImportModule: string;
+        TransImportName: string;
+    };
+};
+
+declare function makeConfig(userConfig: Partial<LinguiConfig>, opts?: {
+    skipValidation?: boolean;
+}): LinguiConfigNormalized;
+
+declare function getConfig({ cwd, configPath, skipValidation, }?: {
+    cwd?: string;
+    configPath?: string;
+    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, getConfig, makeConfig };

package/dist/index.d.ts

@@ -208,4 +208,4 @@ declare function getConfig({ cwd, configPath, skipValidation, }?: {
     skipValidation?: boolean;
 }): LinguiConfigNormalized;
 
-export { CatalogConfig, CatalogFormat, CatalogFormatOptions, CatalogFormatter, CatalogType, ExperimentalExtractorOptions, ExtractedCatalogType, ExtractedMessage, ExtractedMessageType, ExtractorCtx, ExtractorType, FallbackLocales, LinguiConfig, LinguiConfigNormalized, MessageOrigin, MessageType, OrderBy, getConfig, makeConfig };
+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, getConfig, makeConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/conf",
-  "version": "4.4.2",
+  "version": "4.5.0",
   "sideEffects": false,
   "description": "Get lingui configuration from package.json",
   "keywords": [
@@ -40,7 +40,7 @@
   "devDependencies": {
     "@lingui/jest-mocks": "*",
     "tsd": "^0.26.1",
-    "unbuild": "^1.1.2"
+    "unbuild": "^2.0.0"
   },
-  "gitHead": "316a004ec82721fcceb8f3c4a5aeb4a48d367927"
+  "gitHead": "62c92d1f8c60b3890bdda870f307fa780d423080"
 }