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

Tell users unused keys & Generate all strings #32

Merged
merged 1 commit into from
Mar 15, 2025
Merged

Conversation

Jack251970
Copy link
Collaborator

I believe we should retain strings with unused keys for the following reasons:

  • Minor Impact: Unused strings likely make up a small portion of the total strings, so removing them would have minimal impact on the overall file size or performance.

  • Initial Generation Issue: Since the check relies on Localize.localize_key(arg...) which are accessible after generation, removing unused keys could result in blank generated files during the first run. This would create confusion and hinder usability.

  • Diagnostic Retention: I have kept the diagnostic in place so users are still aware of unused strings, allowing them to address them as needed without losing data.

@Jack251970 Jack251970 added bug Something isn't working enhancement New feature or request labels Mar 14, 2025
Copy link
Contributor

coderabbitai bot commented Mar 14, 2025

📝 Walkthrough

Walkthrough

The changes streamline the localization key handling in the source generator by removing references to usedKeys and eliminating the optimizationLevel parameter. The modifications simplify the logic in the Execute method by directly computing unused keys from localized strings and invocation keys. Additionally, related comments and conditional branches tied to the optimization level have been removed to maintain a more direct flow of key processing.

Changes

File Change Summary
Flow.Launcher.Localization.SourceGenerators/.../LocalizeSourceGenerator.cs Removed references to usedKeys and the optimizationLevel parameter; eliminated related comments and conditional diagnostic reporting; simplified the unused keys computation and localization method generation.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Generator as LocalizeSourceGenerator
    Caller ->> Generator: Call Execute(data)
    Generator ->> Generator: Compute localization keys from localizedStrings & invocationKeys
    Generator ->> Generator: Determine unused keys (removed optimizationLevel check)
    Generator ->> Generator: Generate localization methods
    Generator -->> Caller: Return processed localization data
Loading

Possibly related PRs

Suggested labels

enhancement

Suggested reviewers

  • Yusyuriv

Poem

I'm a rabbit, hopping through code so neat,
Cleaning up keys with every beat.
Removed the clutter, the checks set aside,
Simpler paths now show the ride.
Hop along, for clean code is truly sweet! 🐇
Happy coding, with a joyful leap!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f9a5720 and 20035ed.

📒 Files selected for processing (1)
  • Flow.Launcher.Localization.SourceGenerators/Localize/LocalizeSourceGenerator.cs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: gitStream.cm
  • GitHub Check: build
🔇 Additional comments (1)
Flow.Launcher.Localization.SourceGenerators/Localize/LocalizeSourceGenerator.cs (1)

552-563: Changes align with retention of unused strings while maintaining diagnostics

The code now properly computes unused keys and reports them as diagnostics without removing them from generation. This implementation matches the PR objectives perfectly by keeping all strings (even unused ones) in the output while still informing users about which strings are unused.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Jack251970 Jack251970 requested a review from Yusyuriv March 14, 2025 15:25
@Jack251970 Jack251970 merged commit 36c7395 into main Mar 15, 2025
3 checks passed
@Jack251970 Jack251970 deleted the unused_keys branch March 15, 2025 06:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants