Replace more strings with constants

[Jack251970]

Use constants if available for code quality

[coderabbitai]

📝 Walkthrough

Walkthrough

This pull request updates various localization components to replace hardcoded string literals with constant references. Diagnostic messages, code fix providers, and source generators now use dynamic constants (e.g., Constants.ClassName, Constants.PluginContextTypeName, and XML-related constants) to improve maintainability. Additionally, a set of five new constants for XML elements and attributes has been added to the shared constants file. There are no changes to public APIs.

Changes

File(s)	Change Summary
Flow.Launcher.Localization.Analyzers/AnalyzerDiagnostics.cs	Updated diagnostic messages to use dynamic constants (e.g., Constants.ClassName, Constants.PluginContextTypeName) and added a new using directive for shared constants.
Flow.Launcher.Localization.Analyzers/.../ContextAvailabilityAnalyzerCodeFixProvider.cs Flow.Launcher.Localization.Analyzers/.../OldGetTranslateAnalyzerCodeFixProvider.cs	Modified code fix providers by replacing hardcoded type and class names with dynamic constant references; added necessary using directives.
Flow.Launcher.Localization.SourceGenerators/.../LocalizeSourceGenerator.cs	Replaced hardcoded XML element and attribute strings with constant references from the shared constants.
Flow.Launcher.Localization.SourceGenerators/SourceGeneratorDiagnostics.cs	Updated diagnostic error messages to refer to constants and added a using directive for the shared namespace.
Flow.Launcher.Localization.Shared/Constants.cs	Introduced five new constant strings for XML elements and attributes: SummaryElementName, ParamElementName, IndexAttribute, NameAttribute, and TypeAttribute.

Possibly related PRs

• Resolve namespace prefix dynamically #15: Involved modifications to constants usage within diagnostic messages.
• Mark generated code as generated to avoid analyzers working on it #4: Addressed improvements in the source generator by incorporating constant references.
• Rewrite to IIncrementalGenerator and update NuGet package #6: Updated localization components to reference Constants.ClassName and Constants.PluginContextTypeName for maintainability.

Suggested labels

enhancement

Suggested reviewers

• Yusyuriv

Poem

I’m a little rabbit, hopping through the code,
Constants guiding my path on this maintenance road.
Hardcoded strings now dance with grace,
Bringing clarity to every space.
With every hop, the changes glow — 🐇 so merry we go!

---

📜 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 61fed01 and fe4d8df.

📒 Files selected for processing (6)

• Flow.Launcher.Localization.Analyzers/AnalyzerDiagnostics.cs (3 hunks)
• Flow.Launcher.Localization.Analyzers/Localize/ContextAvailabilityAnalyzerCodeFixProvider.cs (2 hunks)
• Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzerCodeFixProvider.cs (4 hunks)
• Flow.Launcher.Localization.Shared/Constants.cs (1 hunks)
• Flow.Launcher.Localization.SourceGenerators/Localize/LocalizeSourceGenerator.cs (2 hunks)
• Flow.Launcher.Localization.SourceGenerators/SourceGeneratorDiagnostics.cs (4 hunks)

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

• GitHub Check: build

🔇 Additional comments (16)

Flow.Launcher.Localization.Shared/Constants.cs (1)

15-19: Good addition of XML element and attribute constants.

The introduction of constants for XML elements and attributes improves code maintainability and reduces the risk of typos when these strings are used across the codebase.

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

358-358: Well-implemented use of constants for XML element names.

Replacing the hardcoded string "summary" with Constants.SummaryElementName improves maintainability and consistency.

---

361-365: Great replacement of string literals with constants.

Properly using the newly defined constants for XML elements and attributes makes the code more maintainable and less prone to typos.

Flow.Launcher.Localization.SourceGenerators/SourceGeneratorDiagnostics.cs (4)

1-1: Good addition of required using directive.

Adding the using directive for Flow.Launcher.Localization.Shared to access the constants is necessary for the subsequent changes.

---

20-20: Well-implemented constants in diagnostic message.

Using Constants.PluginInterfaceName instead of a hardcoded string improves maintainability.

---

29-29: Proper use of constants in diagnostic message.

Replacing the hardcoded PluginInitContext string with Constants.PluginContextTypeName improves code consistency.

---

65-65: Good replacement of hardcoded class name.

Using Constants.ClassName instead of a hardcoded "Localize" string ensures consistency if the class name ever changes.

Flow.Launcher.Localization.Analyzers/AnalyzerDiagnostics.cs (3)

1-1: Good addition of required using directive.

Adding the using directive for Flow.Launcher.Localization.Shared enables access to the constants used below.

---

11-11: Effective use of constants in diagnostic message.

Using Constants.ClassName instead of a hardcoded value improves maintainability and consistency.

---

47-47: Proper use of constants for type names.

Replacing the hardcoded PluginInitContext string with Constants.PluginContextTypeName improves code consistency and maintainability.

Flow.Launcher.Localization.Analyzers/Localize/OldGetTranslateAnalyzerCodeFixProvider.cs (4)

5-5: Good addition of the shared constants namespace

Adding this namespace import provides access to the Constants class for string replacements.

---

32-32: Good replacement of hardcoded string with constant

Replacing the hardcoded "Localize" string with Constants.ClassName improves maintainability by centralizing the class name in a constants file.

---

79-79: Good use of Constants.ClassName instead of hardcoded string

Replacing the hardcoded string with the constant reference makes the code more maintainable and consistent.

---

108-108: Appropriate use of constant for class name

Consistently using Constants.ClassName instead of hardcoded "Localize" string aligns with the PR objectives and improves code maintainability.

Flow.Launcher.Localization.Analyzers/Localize/ContextAvailabilityAnalyzerCodeFixProvider.cs (2)

5-5: Good addition of the shared constants namespace

Adding this namespace import provides access to the Constants class needed for type name references.

---

87-87: Good replacement of hardcoded type name with constant

Replacing the hardcoded "PluginInitContext" type name with Constants.PluginContextTypeName improves maintainability by centralizing type references in a constants file.

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