js-lingui icon indicating copy to clipboard operation
js-lingui copied to clipboard

docs: update lingui.config.js to use ES modules for consistency and specify namespace

Open kardwen opened this issue 1 year ago • 5 comments

Description

When following the tutorial, I encountered an issue where the messages compiled with Lingui used the default CommonJS syntax, while the rest of my Vite React project used ES modules. To resolve my import issues, I edited lingui.config.js accordingly. However, I'm unsure about removing the JSDoc string.

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)
  • [x] Documentation update
  • [x] Examples update

Fixes # (issue)

Checklist

  • [x] 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)

kardwen avatar May 24 '24 11:05 kardwen

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 May 24, 2024 0:17am

vercel[bot] avatar May 24 '24 11:05 vercel[bot]

size-limit report 📦

Path Size
./packages/core/dist/index.mjs 2.88 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%)

github-actions[bot] avatar May 24 '24 11:05 github-actions[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 76.07%. Comparing base (d6b9698) to head (fb7f025). Report is 26 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1941      +/-   ##
==========================================
- Coverage   76.65%   76.07%   -0.58%     
==========================================
  Files          81       85       +4     
  Lines        2090     2115      +25     
  Branches      533      543      +10     
==========================================
+ Hits         1602     1609       +7     
- Misses        375      393      +18     
  Partials      113      113              

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar May 24 '24 11:05 codecov[bot]

Yes, please leave the jsdoc comment, it should help with autocomplete support in IDE

timofei-iatsenko avatar May 24 '24 12:05 timofei-iatsenko

Sorry, recommitted with the comment in place

kardwen avatar May 24 '24 12:05 kardwen