Improve diagnostics

[Jack251970]

1. Support CouldNotFindPluginEntryClass & CouldNotFindContextProperty diagonostics

2. Improve diagnostics display

Use "`" to wrap class & method names to let users know it is from codes.

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request revises the validation logic in the GetValidPluginInfo method of the localization source generator. The method now separates the filtering of plugin classes into those implementing IPluginI18n and those with a non-null context property. It reports diagnostics if no valid implementations or context properties are found. Additionally, diagnostic messages in SourceGeneratorDiagnostics.cs are updated to include backticks around constants and placeholders for improved format clarity.

Changes

File(s)	Change Summary
Flow.Launcher.Localization.SourceGenerators/.../LocalizeSourceGenerator.cs	Revised filtering logic in GetValidPluginInfo: now separates checks for non-null plugin implementations and valid context properties; added diagnostic reporting for invalid cases.
Flow.Launcher.Localization.SourceGenerators/.../SourceGeneratorDiagnostics.cs	Updated diagnostic messages by including backticks around constants and placeholders in descriptors like CouldNotFindPluginEntryClass, CouldNotFindContextProperty, and others.

Sequence Diagram(s)

sequenceDiagram
    participant L as LocalizeSourceGenerator
    participant PC as PluginClasses
    participant D as Diagnostics
    Note over L: Start GetValidPluginInfo
    L->>PC: Filter for non-null IPluginI18n implementations (iPluginI18nClasses)
    alt No valid IPluginI18n classes
        L->>D: Report missing IPluginI18n diagnostic
    else Valid IPluginI18n classes found
        L->>PC: Further filter for valid context properties (iPluginI18nClassesWithContext)
        alt No classes with valid context properties
            L->>D: Report diagnostic for each missing context property
        else Valid classes with context found
            L->>PC: Validate each class for static/private/protected property issues
            L->>D: Report relevant diagnostics if issues found
        end
    end

Loading

Possibly related PRs

• Rewrite to IIncrementalGenerator and update NuGet package #6: The changes in the main PR, specifically the modifications to the GetValidPluginInfo method in LocalizeSourceGenerator.cs, are related to the updates in the LocalizeSourceGenerator class in the retrieved PR, which also involves significant changes to the same class, including its method signatures and logic.

Suggested labels

bug

Suggested reviewers

• Yusyuriv

Poem

I'm a rabbit hopping through lines of code,
Skipping over bugs on a joyful road.
With each new check and diagnostic delight,
I nibble on logic from morning to night.
Hop along with me, as our changes take flight!
🐇✨

---

📜 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 ed87111 and 5aebd62.

📒 Files selected for processing (1)

• Flow.Launcher.Localization.SourceGenerators/SourceGeneratorDiagnostics.cs (7 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• Flow.Launcher.Localization.SourceGenerators/SourceGeneratorDiagnostics.cs

---

🪧 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.