docs: add catalogsMergePath in Lingui Configuration (#1881)

lingui · Mar 11, 2024 · a7ead64 · a7ead64
1 parent 8d96c7d
commit a7ead64
Showing 1 changed file with 52 additions and 2 deletions.
diff --git a/website/docs/ref/conf.md b/website/docs/ref/conf.md
@@ -27,6 +27,7 @@ Default config:
       "exclude": ["**/node_modules/**"]
     }
   ],
+  "catalogsMergePath": "",
   "compileNamespace": "cjs",
   "extractorParserOptions": {},
   "compilerBabelOptions": {},
@@ -127,7 +128,7 @@ locales
   "catalogs": [
     {
       "path": "components/{name}/locale/{locale}",
-      "include": "components/{name}/"
+      "include": ["components/{name}/"]
     }
   ]
 }
@@ -156,7 +157,7 @@ components/
   "catalogs": [
     {
       "path": "locale/{locale}/{name}",
-      "include": "components/{name}/"
+      "include": ["components/{name}/"]
     }
   ]
 }
@@ -180,6 +181,55 @@ components/
         └── LoginForm.js
 ```
 
+## catalogsMergePath
+
+Default: `""`
+
+Specify the path to merge translated catalogs into a single file per locale during compile.
+
+#### Example
+
+Let's assume we have [separate catalogs for `locales: ["en", "cs"]` per component placed inside shared directory](#separate-catalogs-per-component-placed-inside-shared-directory).
+
+Using `catalogsMergePath`, separate catalogs can be merged during [`compile`](/docs/ref/cli.md#compile):
+
+```diff
+{
+  "catalogs": [
+    {
+      "path": "/locale/{locale}/{name}",
+      "include": ["components/{name}/"]
+    }
+  ],
++ "catalogsMergePath": "locales/{locale}"
+}
+```
+
+```diff
+.
+  ├── locale/
+  │   ├── en/
+  │   │   ├── RegistrationForm.po
+- │   │   ├── RegistrationForm.js
+  │   │   ├── LoginForm.po
+- │   │   └── LoginForm.js
+  │   └── cs/
+  │       ├── RegistrationForm.po
+- │       ├── RegistrationForm.js
+  │       ├── LoginForm.po
+- │       └── LoginForm.js
++ ├── locales/
++ │   ├── en.js
++ │   └── cs.js
+  └── components/
+      ├── RegistrationForm/
+      │   ├── RegistrationForm.test.js
+      │   └── RegistrationForm.js
+      └── LoginForm/
+          ├── LoginForm.test.js
+          └── LoginForm.js
+```
+
 ## compileNamespace
 
 Default: `cjs`