@lingui/conf 4.0.0-next.1 → 4.0.0-next.2

package/build/makeConfig.d.ts

@@ -18,14 +18,24 @@ export declare const exampleConfig: {
     };
     extractorParserOptions: {
         flow: boolean;
-        decoratorsBeforeExport: boolean;
+        tsExperimentalDecorators: boolean;
+    };
+    experimental: {
+        extractor: {
+            entries: any[];
+            includeDeps: any[];
+            excludeDeps: any[];
+            excludeExtensions: any[];
+            output: string;
+            resolveEsbuildOptions: FunctionConstructor;
+        };
     };
     catalogs?: import("./types").CatalogConfig[];
     compileNamespace?: string;
     compilerBabelOptions?: import("@babel/generator").GeneratorOptions;
     prevFormat?: import("./types").CatalogFormat;
     localeDir?: string;
-    format?: import("./types").CatalogFormat;
+    format?: import("./types").CatalogFormat | import("./types").CatalogFormatter;
     formatOptions?: import("./types").CatalogFormatOptions;
     locales: string[];
     catalogsMergePath?: string;

package/build/makeConfig.js

@@ -44,13 +44,13 @@ exports.defaultConfig = {
     },
     extractorParserOptions: {
         flow: false,
-        decoratorsBeforeExport: false,
+        tsExperimentalDecorators: false,
     },
     fallbackLocales: {},
     format: "po",
     formatOptions: { origins: true, lineNumbers: true },
     locales: [],
-    orderBy: "messageId",
+    orderBy: "message",
     pseudoLocale: "",
     rootDir: ".",
     runtimeConfigModule: ["@lingui/core", "i18n"],
@@ -64,7 +64,17 @@ exports.exampleConfig = {
     fallbackLocales: (0, jest_validate_1.multipleValidOptions)({}, { "en-US": "en" }, { "en-US": ["en"] }, { default: "en" }, false),
     extractorParserOptions: {
         flow: false,
-        decoratorsBeforeExport: false,
+        tsExperimentalDecorators: false,
+    },
+    experimental: {
+        extractor: {
+            entries: [],
+            includeDeps: [],
+            excludeDeps: [],
+            excludeExtensions: [],
+            output: "",
+            resolveEsbuildOptions: Function,
+        },
     },
 };
 /**

package/build/makeConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"makeConfig.js","sourceRoot":"","sources":["../src/makeConfig.ts"],"names":[],"mappings":";;;;;;AACA,kDAAyB;AACzB,2DAAuD;AACvD,iDAA8D;AAC9D,4EAAwE;AACxE,yDAAqD;AACrD,4FAAwF;AAExF,SAAgB,UAAU,CACxB,UAAiC,EACjC,OAEI,EAAE;IAEN,IAAI,MAAM,GAAiB;QACzB,GAAG,qBAAa;QAChB,GAAG,UAAU;KACd,CAAA;IAED,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;QACxB,IAAA,wBAAQ,EAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;QAClC,eAAe,CAAC,MAAM,CAAC,CAAA;KACxB;IAED,MAAM,GAAG,IAAI;IACX,+CAA+C;IAC/C,2CAAoB,EACpB,2DAA4B,CAC7B,CAAC,MAAM,CAAC,CAAA;IAET,6CAA6C;IAC7C,OAAO,IAAA,+BAAc,EACnB,MAAM,EACN,MAAM,CAAC,OAAO,CACsB,CAAA;AACxC,CAAC;AA3BD,gCA2BC;AAEY,QAAA,aAAa,GAAiB;IACzC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,IAAA,6BAAa,EAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC;YAClE,OAAO,EAAE,CAAC,WAAW,CAAC;YACtB,OAAO,EAAE,CAAC,kBAAkB,CAAC;SAC9B;KACF;IACD,iBAAiB,EAAE,EAAE;IACrB,gBAAgB,EAAE,KAAK;IACvB,oBAAoB,EAAE;QACpB,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE;YACX,OAAO,EAAE,IAAI;SACd;KACF;IACD,sBAAsB,EAAE;QACtB,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,KAAK;KAC9B;IACD,eAAe,EAAE,EAAqB;IACtC,MAAM,EAAE,IAAI;IACZ,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE;IACnD,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,WAAW;IACpB,YAAY,EAAE,EAAE;IAChB,OAAO,EAAE,GAAG;IACZ,mBAAmB,EAAE,CAAC,cAAc,EAAE,MAAM,CAAC;IAC7C,YAAY,EAAE,EAAE;IAChB,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;CAClC,CAAA;AACY,QAAA,aAAa,GAAG;IAC3B,GAAG,qBAAa;IAChB,UAAU,EAAE,IAAA,oCAAoB,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACzD,mBAAmB,EAAE,IAAA,oCAAoB,EACvC,EAAE,IAAI,EAAE,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,EACrE,CAAC,cAAc,EAAE,MAAM,CAAC,CACzB;IACD,eAAe,EAAE,IAAA,oCAAoB,EACnC,EAAE,EACF,EAAE,OAAO,EAAE,IAAI,EAAE,EACjB,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,EACnB,EAAE,OAAO,EAAE,IAAI,EAAE,EACjB,KAAK,CACN;IACD,sBAAsB,EAAE;QACtB,IAAI,EAAE,KAAK;QACX,sBAAsB,EAAE,KAAK;KAC9B;CACF,CAAA;AAED;;GAEG;AACH,MAAM,+BAA+B,GAAG;IACtC,mBAAmB,EAAE,GAAG,EAAE,CACxB,WAAW,eAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC;;;;;KAK3C;CACJ,CAAA;AAED,MAAM,gBAAgB,GAAG;IACvB,aAAa,EAAb,qBAAa;IACb,gBAAgB,EAAE;QAChB,GAAG,+BAA+B;KACnC;IACD,OAAO,EAAE,4CAA4C;CACtD,CAAA;AAED,SAAS,eAAe,CAAC,MAAoB;IAC3C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE;QAC5D,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;QACtC,OAAO,CAAC,KAAK,CACX,OAAO,eAAK,CAAC,MAAM,CACjB,WAAW,CACZ,+BAA+B,eAAK,CAAC,SAAS,CAC7C,qCAAqC,CACtC,EAAE,CACJ,CAAA;KACF;AACH,CAAC;AAED,MAAM,IAAI,GACR,CAAC,GAAG,SAA0B,EAAE,EAAE,CAClC,CAAC,IAAS,EAAO,EAAE,CACjB,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA"}
+{"version":3,"file":"makeConfig.js","sourceRoot":"","sources":["../src/makeConfig.ts"],"names":[],"mappings":";;;;;;AACA,kDAAyB;AACzB,2DAAuD;AACvD,iDAA8D;AAC9D,4EAAwE;AACxE,yDAAqD;AACrD,4FAAwF;AAExF,SAAgB,UAAU,CACxB,UAAiC,EACjC,OAEI,EAAE;IAEN,IAAI,MAAM,GAAiB;QACzB,GAAG,qBAAa;QAChB,GAAG,UAAU;KACd,CAAA;IAED,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;QACxB,IAAA,wBAAQ,EAAC,MAAM,EAAE,gBAAgB,CAAC,CAAA;QAClC,eAAe,CAAC,MAAM,CAAC,CAAA;KACxB;IAED,MAAM,GAAG,IAAI;IACX,+CAA+C;IAC/C,2CAAoB,EACpB,2DAA4B,CAC7B,CAAC,MAAM,CAAC,CAAA;IAET,6CAA6C;IAC7C,OAAO,IAAA,+BAAc,EACnB,MAAM,EACN,MAAM,CAAC,OAAO,CACsB,CAAA;AACxC,CAAC;AA3BD,gCA2BC;AAEY,QAAA,aAAa,GAAiB;IACzC,QAAQ,EAAE;QACR;YACE,IAAI,EAAE,IAAA,6BAAa,EAAC,WAAW,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC;YAClE,OAAO,EAAE,CAAC,WAAW,CAAC;YACtB,OAAO,EAAE,CAAC,kBAAkB,CAAC;SAC9B;KACF;IACD,iBAAiB,EAAE,EAAE;IACrB,gBAAgB,EAAE,KAAK;IACvB,oBAAoB,EAAE;QACpB,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE;YACX,OAAO,EAAE,IAAI;SACd;KACF;IACD,sBAAsB,EAAE;QACtB,IAAI,EAAE,KAAK;QACX,wBAAwB,EAAE,KAAK;KAChC;IACD,eAAe,EAAE,EAAqB;IACtC,MAAM,EAAE,IAAI;IACZ,aAAa,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE;IACnD,OAAO,EAAE,EAAE;IACX,OAAO,EAAE,SAAS;IAClB,YAAY,EAAE,EAAE;IAChB,OAAO,EAAE,GAAG;IACZ,mBAAmB,EAAE,CAAC,cAAc,EAAE,MAAM,CAAC;IAC7C,YAAY,EAAE,EAAE;IAChB,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;CAClC,CAAA;AACY,QAAA,aAAa,GAAG;IAC3B,GAAG,qBAAa;IAChB,UAAU,EAAE,IAAA,oCAAoB,EAAC,EAAE,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC;IACzD,mBAAmB,EAAE,IAAA,oCAAoB,EACvC,EAAE,IAAI,EAAE,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,eAAe,EAAE,OAAO,CAAC,EAAE,EACrE,CAAC,cAAc,EAAE,MAAM,CAAC,CACzB;IACD,eAAe,EAAE,IAAA,oCAAoB,EACnC,EAAE,EACF,EAAE,OAAO,EAAE,IAAI,EAAE,EACjB,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC,EAAE,EACnB,EAAE,OAAO,EAAE,IAAI,EAAE,EACjB,KAAK,CACN;IACD,sBAAsB,EAAE;QACtB,IAAI,EAAE,KAAK;QACX,wBAAwB,EAAE,KAAK;KAChC;IAED,YAAY,EAAE;QACZ,SAAS,EAAE;YACT,OAAO,EAAE,EAAE;YACX,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,EAAE;YACf,iBAAiB,EAAE,EAAE;YACrB,MAAM,EAAE,EAAE;YACV,qBAAqB,EAAE,QAAQ;SAChC;KACF;CACF,CAAA;AAED;;GAEG;AACH,MAAM,+BAA+B,GAAG;IACtC,mBAAmB,EAAE,GAAG,EAAE,CACxB,WAAW,eAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC;;;;;KAK3C;CACJ,CAAA;AAED,MAAM,gBAAgB,GAAG;IACvB,aAAa,EAAb,qBAAa;IACb,gBAAgB,EAAE;QAChB,GAAG,+BAA+B;KACnC;IACD,OAAO,EAAE,4CAA4C;CACtD,CAAA;AAED,SAAS,eAAe,CAAC,MAAoB;IAC3C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE;QAC5D,OAAO,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAA;QACtC,OAAO,CAAC,KAAK,CACX,OAAO,eAAK,CAAC,MAAM,CACjB,WAAW,CACZ,+BAA+B,eAAK,CAAC,SAAS,CAC7C,qCAAqC,CACtC,EAAE,CACJ,CAAA;KACF;AACH,CAAC;AAED,MAAM,IAAI,GACR,CAAC,GAAG,SAA0B,EAAE,EAAE,CAClC,CAAC,IAAS,EAAO,EAAE,CACjB,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAA"}

package/build/types.d.ts

@@ -1,4 +1,4 @@
-import { GeneratorOptions } from "@babel/core";
+import type { GeneratorOptions } from "@babel/core";
 export type CatalogFormat = "lingui" | "minimal" | "po" | "csv" | "po-gettext";
 export type ExtractorCtx = {
     /**
@@ -8,10 +8,46 @@ export type ExtractorCtx = {
     sourceMaps?: any;
     linguiConfig: LinguiConfigNormalized;
 };
+export type MessageOrigin = [filename: string, line?: number];
+export type ExtractedMessageType = {
+    message?: string;
+    origin?: MessageOrigin[];
+    comments?: string[];
+    extractedComments?: string[];
+    obsolete?: boolean;
+    flags?: string[];
+    context?: string;
+};
+export type MessageType = ExtractedMessageType & {
+    translation: string;
+};
+export type ExtractedCatalogType = {
+    [msgId: string]: ExtractedMessageType;
+};
+export type CatalogType = {
+    [msgId: string]: MessageType;
+};
 export type ExtractorType = {
     match(filename: string): boolean;
     extract(filename: string, code: string, onMessageExtracted: (msg: ExtractedMessage) => void, ctx?: ExtractorCtx): Promise<void> | void;
 };
+export 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;
+        filename: string;
+    }): Promise<CatalogType> | CatalogType;
+    serialize(catalog: CatalogType, ctx: {
+        locale: string | null;
+        filename: string;
+        existing: string | null;
+    }): Promise<string> | string;
+};
 export type ExtractedMessage = {
     id: string;
     message?: string;
@@ -24,7 +60,7 @@ export type CatalogFormatOptions = {
     lineNumbers?: boolean;
     disableSelectWarning?: boolean;
 };
-export type OrderBy = "messageId" | "origin";
+export type OrderBy = "messageId" | "message" | "origin";
 export type CatalogConfig = {
     name?: string;
     path: string;
@@ -41,14 +77,72 @@ type CatalogService = {
     name: string;
     apiKey: string;
 };
+export 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;
+};
 export type LinguiConfig = {
     catalogs?: CatalogConfig[];
     compileNamespace?: "es" | "ts" | "cjs" | string;
     extractorParserOptions?: {
         /**
-         * default true
+         * default false
+         *
+         * By default, standard decorators (Stage3) are applied for TS files
+         * Enable this if you want to use TypesScript's experimental decorators.
          */
-        decoratorsBeforeExport?: boolean;
+        tsExperimentalDecorators?: boolean;
         /**
          * Enable if you use flow. This will apply Flow syntax to js files
          */
@@ -59,7 +153,7 @@ export type LinguiConfig = {
     extractors?: (string | ExtractorType)[];
     prevFormat?: CatalogFormat;
     localeDir?: string;
-    format?: CatalogFormat;
+    format?: CatalogFormat | CatalogFormatter;
     formatOptions?: CatalogFormatOptions;
     locales: string[];
     catalogsMergePath?: string;
@@ -71,6 +165,9 @@ export type LinguiConfig = {
     };
     sourceLocale?: string;
     service?: CatalogService;
+    experimental?: {
+        extractor?: ExperimentalExtractorOptions;
+    };
 };
 export type LinguiConfigNormalized = Omit<LinguiConfig, "runtimeConfigModule"> & {
     fallbackLocales?: FallbackLocales;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/conf",
-  "version": "4.0.0-next.1",
+  "version": "4.0.0-next.2",
   "sideEffects": false,
   "description": "Get lingui configuration from package.json",
   "keywords": [
@@ -40,5 +40,5 @@
     "@lingui/jest-mocks": "^3.0.3",
     "tsd": "^0.26.1"
   },
-  "gitHead": "27ee8e213ff6d0c7a0cd2b21c573d7f6da43fd85"
+  "gitHead": "556ab57e20c2ac9d384a22424c6a90c2ba0dd133"
 }