Resolve namespace prefix dynamically

[Jack251970]

Resolve namespace prefix dynamically

If we do not use default prefix, the source generator cannot work.

Like this

<ResourceDictionary
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:a="clr-namespace:System;assembly=mscorlib"
    xmlns:b="http://schemas.microsoft.com/winfx/2006/xaml">

    <a:String b:Key="flowlauncher_plugin_caculator_plugin_name">Calculator</a:String>
    <a:String b:Key="flowlauncher_plugin_caculator_plugin_description">Allows to do mathematical calculations</a:String>
    <a:String b:Key="flowlauncher_plugin_caculator_plugin_unused">This is unused string {0}!!</a:String>

</ResourceDictionary>

Tested the xaml file above.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the localization source generator by replacing hardcoded strings with constants for URI prefixes and keys. It modifies the regex field to be static and introduces empty immutable arrays for error scenarios. Additionally, changes in the XAML parsing method now include enhanced null checks and namespace attribute validations, ensuring a more robust control flow within the parsing logic.

Changes

File Path	Summary of Changes
Flow.Launcher.Localization.SourceGenerators/Localize/LocalizeSourceGenerator.cs	- Replaced the hardcoded XamlPrefix with systemPrefixUri and xamlPrefixUri constants. - Added a new constant KeyTag to replace the literal "Key". - Changed _languagesXamlRegex from readonly to static readonly. - Added static readonly fields for empty immutable arrays. - Updated null and error handling in the ParseXamlFile method.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Parser as LocalizeSourceGenerator
    participant Document as XDocument

    Caller->>Parser: Invoke ParseXamlFile(content)
    Parser->>Document: Parse XAML content
    Document-->>Parser: Return Root element (or null)
    alt Content or root is null
        Parser->>Caller: Return _emptyLocalizableStrings
    else Valid XAML
        Parser->>Parser: Loop through root attributes<br/>Determine namespace prefixes (using URI constants)
        Parser->>Parser: Extract Key attribute (using KeyTag constant)
        Parser->>Caller: Return parsed localizable strings or parameters
    end

Loading

Possibly related PRs

• Rewrite to IIncrementalGenerator and update NuGet package #6: Modifications in the same LocalizeSourceGenerator class, including changes to method signatures and structure, indicate a strong connection to the current changes.

Suggested reviewers

• Yusyuriv

Poem

I'm a little rabbit, leaping through code,
Hoping past hardcoded strings on a smooth load.
New constants lead my bounding spree,
Clearing nulls and regex with glee.
In the field of XAML, I proudly roam—
A bunny celebrating a cleaner home!
🐰🌟

---

📜 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 f8b14b4 and 273d3b7.

📒 Files selected for processing (1)

• Flow.Launcher.Localization.SourceGenerators/Localize/LocalizeSourceGenerator.cs (4 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: build

🔇 Additional comments (8)

Flow.Launcher.Localization.SourceGenerators/Localize/LocalizeSourceGenerator.cs (8)

30-33: Good addition of named constants

Using named constants instead of hardcoded string literals improves code readability and maintainability. It centralizes URI definitions and makes the code more robust against typos.

---

35-35: Appropriate use of static field

Making the regex pattern static is a good optimization since regular expressions are expensive to compile and this pattern doesn't depend on instance state.

---

39-40: Performance improvement with empty immutable arrays

Using shared empty immutable arrays instead of creating new empty arrays reduces unnecessary allocations.

---

136-136: Using shared empty array improves memory usage

Replacing new ImmutableArray<LocalizableString>() with the shared empty array reduces allocations.

---

140-144: Good defensive programming with null checks

Adding null checks for the root element prevents potential NullReferenceExceptions.

---

146-176: Robust namespace prefix resolution implementation

The dynamic namespace prefix resolution addresses the core PR objective effectively. The code now properly handles different prefix names for the same namespaces across different XAML files.

This is a significant improvement over hardcoded prefix assumptions. The code now:

1. Iterates through all namespace declarations in the root element
2. Identifies which prefixes correspond to the system and XAML namespaces
3. Properly handles cases where prefixes aren't found

---

189-189: Using constant for key attribute name

Using the KeyTag constant instead of a hardcoded string is more maintainable.

---

212-212: Consistent use of shared empty arrays

Using the pre-defined _emptyLocalizableStringParams in both error cases ensures consistency and reduces allocations.

Also applies to: 229-229

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

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