enhance: add detailed documentation for InitIcon function and update …

[yorukot]

#878

Improved on what we did here with disable nerdfont and made it handle it in a more concise way.

Summary by CodeRabbit

• Refactor
  • Improved and expanded documentation for icon configuration and usage.
  • Simplified prompt headline assignment by removing unnecessary conditional logic and helper function.
• Style
  • Enhanced code comments for better clarity and maintainability.

[coderabbitai]

Walkthrough

The changes update documentation and comments in the icon configuration function to clarify its behavior and add detail. In the prompt UI model, the getHeadLine() helper function is removed, and headline assignment is simplified to always include the terminal icon and space, regardless of configuration.

Changes

File(s)	Change Summary
src/config/icon/function.go	Expanded documentation and comments in InitIcon; added initialization for Terminal in ASCII block. No functional changes.
src/internal/ui/prompt/model.go	Removed getHeadLine(); simplified headline assignment in GenerateModel to always include terminal icon and space.

Sequence Diagram(s)

sequenceDiagram
    participant Config as Config
    participant Icon as Icon
    participant PromptModel as PromptModel

    Config->>Icon: InitIcon(nerdfont, directoryIconColor)
    Note right of Icon: Sets icon variables based on nerdfont flag

    PromptModel->>Icon: Access Terminal and Space icons
    PromptModel->>PromptModel: headline = Terminal + Space + headlineText

Loading

Possibly related PRs

• fix icon displayed on spf prompt when nerdfont disabled #878: Removes conditional logic for the prompt headline and adds the getHeadLine() function, which is now reversed in this PR.

Poem

A headline now shines, no matter the font,
With icons and spaces, it’s just what we want.
The comments are clearer, the code is concise,
The rabbit approves—this change is quite nice!
🐰✨

✨ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/config/icon/function.go (1)

3-18: Use idiomatic GoDoc formatting for parameter descriptions

The detailed comment is helpful, but documenting parameters in a bulleted list is unusual for GoDoc and can trigger revive/golint warnings. Prefer a single descriptive paragraph or the “Parameters:” pattern without indentation.

-// Parameters:
-//   - nerdfont: boolean flag …
-//     When false, …
-//     When true, …
-//   - directoryIconColor: string …
-//     If empty, …
+// InitIcon takes two parameters:
+//   nerdfont determines whether Nerd Fonts are enabled.
+//   directoryIconColor sets the folder icon colour; if empty, "NONE" is used.

This keeps the comment concise and consistent with standard tooling.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 14f551e and c8b7265.

📒 Files selected for processing (2)

• src/config/icon/function.go (2 hunks)
• src/internal/ui/prompt/model.go (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

src/internal/ui/prompt/model.go (1)

src/config/icon/icon.go (2)

• Terminal (42-42)
• Space (10-10)

src/config/icon/function.go (1)

src/config/icon/icon.go (1)

• Terminal (42-42)

🔇 Additional comments (2)

src/config/icon/function.go (1)

22-59: Package-level mutability could lead to data races – document or guard usage

InitIcon mutates a large set of exported vars (Space, Terminal, etc.). If this function is ever called twice (for example in tests run in parallel) or invoked concurrently, these writes are not synchronised and will race. At minimum, add a note in the comment stating that InitIcon must be called once at program start and never again, or protect the critical section with sync.Once.

 func InitIcon(nerdfont bool, directoryIconColor string) {
+    // NOTE: This function is expected to be called exactly once
+    // during program start-up. It is not concurrency-safe.

Failing to call it first could also leave icon.Terminal at its default value, which the prompt model now depends on.

src/internal/ui/prompt/model.go (1)

23-24: Ensure icon.InitIcon is invoked before GenerateModel

headline now unconditionally concatenates icon.Terminal and icon.Space. If InitIcon was not executed (or executed after model creation) the values might still be their package defaults (" " / Nerd-font glyph), producing incorrect rendering. Please verify the call order in main/tests; consider guarding GenerateModel with a sanity check:

if icon.Terminal == "" && icon.Space == "" && !common.Config.Nerdfont {
    slog.Warn("icon.InitIcon appears to have been skipped")
}

This helps catch mis-ordering early, especially in unit tests that construct models directly.

[lazysegtree]

Looks good.