@lingui/conf 5.6.1 → 5.8.0

package/dist/index.d.cts

@@ -81,7 +81,14 @@ type CatalogFormatOptions = {
     lineNumbers?: boolean;
     disableSelectWarning?: boolean;
 };
-type OrderBy = "messageId" | "message" | "origin";
+type OrderByFn = (a: {
+    messageId: string;
+    entry: ExtractedMessageType;
+}, b: {
+    messageId: string;
+    entry: ExtractedMessageType;
+}) => number;
+type OrderBy = "messageId" | "message" | "origin" | OrderByFn;
 type CatalogConfig = {
     name?: string;
     path: string;
@@ -213,6 +220,16 @@ type LinguiConfig = {
     catalogsMergePath?: string;
     /**
      * Order of messages in catalog
+     * You can choose one of: `"messageId" | "message" | "origin"`.
+     *
+     * - `messageId` — Sorts by the message key. Not recommended if you use the source
+     *   message as the key, as `messageId` is autogenerated and may lead to
+     *   unexpected results.
+     * - `message` — Sorts by the message text and its context. **Recommended**.
+     *   Messages are ordered alphabetically.
+     * - `origin` — Sorts by the location where the message was first defined.
+     *
+     * You can also provide a custom sorting function. See {@link OrderByFn} for the function signature.
      *
      * @default "message"
      */
@@ -335,4 +352,4 @@ 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, defineConfig, 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, type OrderByFn, defineConfig, getConfig, makeConfig };

package/dist/index.d.mts

@@ -81,7 +81,14 @@ type CatalogFormatOptions = {
     lineNumbers?: boolean;
     disableSelectWarning?: boolean;
 };
-type OrderBy = "messageId" | "message" | "origin";
+type OrderByFn = (a: {
+    messageId: string;
+    entry: ExtractedMessageType;
+}, b: {
+    messageId: string;
+    entry: ExtractedMessageType;
+}) => number;
+type OrderBy = "messageId" | "message" | "origin" | OrderByFn;
 type CatalogConfig = {
     name?: string;
     path: string;
@@ -213,6 +220,16 @@ type LinguiConfig = {
     catalogsMergePath?: string;
     /**
      * Order of messages in catalog
+     * You can choose one of: `"messageId" | "message" | "origin"`.
+     *
+     * - `messageId` — Sorts by the message key. Not recommended if you use the source
+     *   message as the key, as `messageId` is autogenerated and may lead to
+     *   unexpected results.
+     * - `message` — Sorts by the message text and its context. **Recommended**.
+     *   Messages are ordered alphabetically.
+     * - `origin` — Sorts by the location where the message was first defined.
+     *
+     * You can also provide a custom sorting function. See {@link OrderByFn} for the function signature.
      *
      * @default "message"
      */
@@ -335,4 +352,4 @@ 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, defineConfig, 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, type OrderByFn, defineConfig, getConfig, makeConfig };

package/dist/index.d.ts

@@ -81,7 +81,14 @@ type CatalogFormatOptions = {
     lineNumbers?: boolean;
     disableSelectWarning?: boolean;
 };
-type OrderBy = "messageId" | "message" | "origin";
+type OrderByFn = (a: {
+    messageId: string;
+    entry: ExtractedMessageType;
+}, b: {
+    messageId: string;
+    entry: ExtractedMessageType;
+}) => number;
+type OrderBy = "messageId" | "message" | "origin" | OrderByFn;
 type CatalogConfig = {
     name?: string;
     path: string;
@@ -213,6 +220,16 @@ type LinguiConfig = {
     catalogsMergePath?: string;
     /**
      * Order of messages in catalog
+     * You can choose one of: `"messageId" | "message" | "origin"`.
+     *
+     * - `messageId` — Sorts by the message key. Not recommended if you use the source
+     *   message as the key, as `messageId` is autogenerated and may lead to
+     *   unexpected results.
+     * - `message` — Sorts by the message text and its context. **Recommended**.
+     *   Messages are ordered alphabetically.
+     * - `origin` — Sorts by the location where the message was first defined.
+     *
+     * You can also provide a custom sorting function. See {@link OrderByFn} for the function signature.
      *
      * @default "message"
      */
@@ -335,4 +352,4 @@ 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, defineConfig, 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, type OrderByFn, defineConfig, getConfig, makeConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingui/conf",
-  "version": "5.6.1",
+  "version": "5.8.0",
   "sideEffects": false,
   "description": "Get lingui configuration from package.json",
   "keywords": [
@@ -45,5 +45,5 @@
     "@lingui/jest-mocks": "*",
     "unbuild": "^2.0.0"
   },
-  "gitHead": "eeab3720888fac544c3410f0148c5b13a0f0acff"
+  "gitHead": "83d0513bdda9ff14003a05d376c7fedf860dd7ee"
 }