docs: add catalogsMergePath in Lingui Configuration

[aseerkt]

Description

Include catalogsMergePath in Lingui Configuration reference section in docs

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update
• Examples update

Fixes #1879

Checklist

• I have read the CONTRIBUTING and CODE_OF_CONDUCT docs
• I have added tests that prove my fix is effective or that my feature works
• I have added the necessary documentation (if appropriate)

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
js-lingui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 11, 2024 2:51pm

[github-actions]

size-limit report 📦

Path	Size
./packages/core/dist/index.mjs	2.86 KB (0%)
./packages/detect-locale/dist/index.mjs	723 B (0%)
./packages/react/dist/index.mjs	1.67 KB (0%)
./packages/remote-loader/dist/index.mjs	7.26 KB (0%)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.63%. Comparing base (93204b9) to head (008c7b7).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1881      +/-   ##
==========================================
- Coverage   76.66%   76.63%   -0.03%     
==========================================
  Files          81       81              
  Lines        2083     2089       +6     
  Branches      532      534       +2     
==========================================
+ Hits         1597     1601       +4     
  Misses        375      375              
- Partials      111      113       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[timofei-iatsenko]

BTW it still not clear from the docs what actually it does. Maybe add some examples with files tree before and after?

[aseerkt]

Thanks for the suggestion 🤗.
I have updated the example. Please have a look.

[andrii-bodnar]

@aseerkt Thanks! I would suggest making the example more compact: use the code diff highlight to show what the file structure is before the merge (-) and after the merge (+) on a single block of code.

[andrii-bodnar]

Also, we can reference our input data by the #separate-catalogs-per-component-placed-inside-component-dir hash, just to not copy-paste the initial config and files structure.

[aseerkt]

Thanks for the suggestion.
PTAL @andrii-bodnar

[timofei-iatsenko]

maybe weird question, but, anyone tested this "Separate catalogs per component, placed inside component dir"? i don't remember this working from the code perspective..

[aseerkt]

It seems working @thekip . https://stackblitz.com/edit/vitejs-vite-rkaqac?file=lingui.config.ts

[aseerkt]

We need to fix the catalogs configuration in the docs in couple of places, where include is typed as string[]

{
  "catalogs": [
    {
      "path": "/locale/{locale}/{name}",
-     "include": "components/{name}/"
+     "include": ["components/{name}/"]
    }
  ],
 }

Should I account for these changes in this PR?

[andrii-bodnar]

@aseerkt could you please fix this within the current PR?

[andrii-bodnar]

@aseerkt thank you!