feat: add Zoxide support for path resolution in initial configuration

[yorukot]

Add basic zoxide integration for path search on Superfile launch

This PR introduces initial support for using zoxide to search for directories when launching superfile. While it doesn't fully implement the complete z command functionality as proposed in #657, it offers a practical starting point that enhances usability for zoxide users.

Summary by CodeRabbit

• New Features
  • Added support for Zoxide to enable faster directory navigation when enabled in the configuration.
• Documentation
  • Clarified comments regarding plugin requirements and external dependencies in the configuration and code comments.
• Style
  • Improved formatting for plugin section headers in the configuration file for consistency.

[coderabbitai]

Walkthrough

The changes introduce a new configuration option, ZoxideSupport, to enable integration with the Zoxide tool for faster directory navigation. Relevant code now conditionally utilizes Zoxide to resolve directory paths when this option is enabled, with appropriate fallbacks and error handling. Documentation and configuration files were updated to reflect these changes.

Changes

File(s)	Change Summary
src/internal/common/config_type.go	Expanded comment for Metadata field; added ZoxideSupport boolean field to ConfigType struct
src/internal/config_function.go	Updated logic to use Zoxide for path resolution if ZoxideSupport is enabled; added error handling
src/superfile_config/config.toml	Added zoxide_support config option (default false); clarified plugin dependency comments

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ConfigLoader
    participant Zoxide
    participant Utils

    User->>ConfigLoader: Load directories
    alt ZoxideSupport enabled
        ConfigLoader->>Zoxide: Query directory path
        alt Zoxide returns valid path
            Zoxide-->>ConfigLoader: Absolute path
        else Zoxide fails or returns empty
            ConfigLoader->>Utils: ResolveAbsPath(directory)
            Utils-->>ConfigLoader: Absolute path
        end
    else ZoxideSupport disabled
        ConfigLoader->>Utils: ResolveAbsPath(directory)
        Utils-->>ConfigLoader: Absolute path
    end
    ConfigLoader-->>User: Resolved directory paths

Loading

Poem

In the warren of code, a new path appears,
Zoxide hops in, dispelling old fears.
With swift navigation, our journeys are bright,
Configs updated, everything feels right.
Plugins and comments, all tidy and neat—
Faster than ever, our work is complete!
🐇✨

✨ 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/internal/config_function.go (1)

69-88: Well-implemented zoxide integration with proper error handling.

The conditional logic effectively integrates zoxide while maintaining backward compatibility. The implementation includes:

• Proper feature flag checking
• Comprehensive error handling with logging
• Graceful fallback to original path resolution
• Correct output processing with whitespace trimming

Consider adding a timeout to prevent potential hanging:

-		out, err := exec.Command("zoxide", "query", firstFilePanelDirs[i]).Output()
+		ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+		defer cancel()
+		out, err := exec.CommandContext(ctx, "zoxide", "query", firstFilePanelDirs[i]).Output()

Don't forget to import context and time if implementing this suggestion.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5d8a841 and 292df2b.

📒 Files selected for processing (3)

• src/internal/common/config_type.go (1 hunks)
• src/internal/config_function.go (2 hunks)
• src/superfile_config/config.toml (1 hunks)

🔇 Additional comments (4)

src/internal/common/config_type.go (1)

100-102: LGTM! Well-documented configuration addition.

The enhanced documentation for plugin dependencies and the new ZoxideSupport field are properly implemented with consistent naming conventions and appropriate TOML tags.

src/internal/config_function.go (1)

6-6: LGTM! Appropriate imports added.

The os/exec and strings imports are correctly added to support the zoxide command execution and output processing.

Also applies to: 9-9

src/superfile_config/config.toml (2)

79-80: LGTM! Improved plugin section documentation.

The formatting consistency and clarifying comment about external dependencies enhance the configuration file's usability.

---

87-89: LGTM! Safe and well-documented configuration option.

The new zoxide_support option is properly configured with:

• Safe default value of false to prevent unexpected behavior
• Clear documentation explaining the feature purpose
• Consistent formatting with existing options

[lazysegtree]

Looks good. For later, lets make sure to have to zioxide code in a separate package. and include unit tests.