Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: Mention the f2c alternative written in Go #340

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

cristim
Copy link

@cristim cristim commented Feb 7, 2025

I just heard about repomix, a while ago I built a very similar tool in Go for my own use cases (funnily started working on it 10 days before the repomix first commit), mainly focusing on the clipboard operation, which is particularly useful for interactive use.

I recently also updated it to make it aware of Go projects using the Go AST package, copying recursively all the function and type definition dependencies of a given Go function to the clipboard.

Checklist

No, since this is just a readme change.

  • Run npm run test
  • Run npm run lint

I just heard about repomix, a while ago I built a very similar tool in Go for my own use cases, mainly focusing on the clipboard operation. 

I recently updated it to make it aware of Go projects using the Go AST package, copying recursively all the function and type definition dependencies of a given Go function to the clipboard.
Copy link
Contributor

coderabbitai bot commented Feb 7, 2025

📝 Walkthrough

Walkthrough

This pull request updates the README.md file by adding a new section under "Alternative Tools." The documentation now includes information about a tool called f2c, described as a lightweight alternative written in Go. f2c supports clipboard functionality without generating files and, for Go projects, it can use the Go AST to recursively identify and copy a function’s dependencies to the clipboard. These changes extend the current documentation without modifying existing content.

Possibly related PRs


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
README.md (1)

126-126: Punctuation Improvement for f2c Tool Description
The added description for the f2c tool is clear and appropriately detailed. However, inserting a comma after “For Go projects” would improve the sentence’s readability by clearly demarcating the introductory phrase.

Consider this diff:

-For Go projects it supports recursively looking into the current Go package using the Go AST to copy only a function's dependencies to the clipboard.
+For Go projects, it supports recursively looking into the current Go package using the Go AST to copy only a function's dependencies to the clipboard.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~126-~126: Possible missing comma found.
Context: ...board, without generating files. For Go projects it supports recursively looking into th...

(AI_HYDRA_LEO_MISSING_COMMA)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 836abcd and 424ca0f.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md

[uncategorized] ~126-~126: Possible missing comma found.
Context: ...board, without generating files. For Go projects it supports recursively looking into th...

(AI_HYDRA_LEO_MISSING_COMMA)

@yamadashy
Copy link
Owner

Hi @cristim,

Thank you for sharing about f2c! I appreciate you taking the time to contribute this information.

I want to clarify why we currently list only Gitingest in our Alternative Tools section. We've received many requests from Python users looking for a Python-based solution, while Gitingest users have been asking for a JavaScript/TypeScript alternative. This mutual need led us to establish a collaboration where we can each address these user requests by recommending each other's tools.

While f2c looks like an interesting tool with its own unique features around Go AST handling, I currently want to maintain this focused approach based on our users' specific needs. That said, I'm always open to discussing potential collaborations if you see similar complementary opportunities between our user bases!

Thanks again for the suggestion and for sharing your work!
It's great to see others building interesting tools in this space.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants