Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve Tooling and API Reference sections #2065

Merged
merged 5 commits into from
Nov 4, 2024

Conversation

andrii-bodnar
Copy link
Contributor

@andrii-bodnar andrii-bodnar commented Oct 25, 2024

Description

Part of the Lingui v5 docs polishing initiative.

API Reference:

  • Configuration
  • Macros
  • Catalog Formats
  • @lingui/core
  • @lingui/react
  • @lingui/cli
  • @lingui/detect-locale
  • @lingui/loader
  • @lingui/metro-transformer
  • @lingui/extractor-vue
  • Custom Extractor
  • Custom Formatter

Tooling:

  • SWC Plugin
  • Vite Plugin
  • ESLint Plugin

🖼️ Deployment Preview

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

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)

@andrii-bodnar andrii-bodnar added this to the v5 milestone Oct 25, 2024
Copy link

vercel bot commented Oct 25, 2024

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

Name Status Preview Updated (UTC)
js-lingui ✅ Ready (Inspect) Visit Preview Nov 1, 2024 10:08am

Copy link

github-actions bot commented Oct 25, 2024

size-limit report 📦

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

Comment on lines 78 to 80
Hello: "Hello",
"Good bye": "Good bye",

// Just an example how catalog looks internally.
// Formatting of string messages works in development only.
// See note below.
"My name is {name}": "My name is {name}",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Values should be arrays?

```

### Catalogs
## AllMessages
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not 100% sure about these types

@andrii-bodnar andrii-bodnar merged commit 82809c8 into next Nov 4, 2024
9 of 10 checks passed
@andrii-bodnar andrii-bodnar deleted the docs/tooling-and-api branch November 4, 2024 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant