Skip to content

Add rule-gen to Utilities section#182

Open
nedcodes-ok wants to merge 1 commit intoPatrickJS:mainfrom
nedcodes-ok:add-rule-gen
Open

Add rule-gen to Utilities section#182
nedcodes-ok wants to merge 1 commit intoPatrickJS:mainfrom
nedcodes-ok:add-rule-gen

Conversation

@nedcodes-ok
Copy link

@nedcodes-ok nedcodes-ok commented Feb 28, 2026

rule-gen generates AI coding rules from your actual codebase using Google Gemini's 1M token context window.

Unlike template-based generators that just read package.json, rule-gen sends your source files to Gemini and produces rules based on patterns it finds in your code.

Summary by CodeRabbit

  • Documentation
    • Added documentation for a new utility tool that generates AI-powered coding rules from codebases with support for multiple output formats.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 28, 2026

📝 Walkthrough

Walkthrough

A new utility link named "rule-gen" was added to the README.md file, describing an AI-powered tool that generates coding rules from codebases using Google Gemini, supporting multiple output formats without external dependencies.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added utility link entry for "rule-gen" tool with description of AI coding rule generation capabilities.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A new utility hops into our nest,
Rule-gen sparkles—truly the best!
Gemini whispers AI wisdom so fine,
With formats galore and zero confine,
Our README now shines, a delight! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Add rule-gen to Utilities section' accurately describes the main change in the pull request, which adds a single utility link to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

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

289-289: Consider adding npm package information.

The npm package name is "rulegen-ai" while the GitHub repo is "rule-gen". This naming difference might make it harder for users to find and install the package. Consider either mentioning the npm package name in the description or adding a link to the npm package page alongside the GitHub link.

🔗 Suggested improvements

Option 1: Add npm package name to description

-- [rule-gen](https://github.com/nedcodes-ok/rule-gen) - Generate AI coding rules from your actual codebase using Google Gemini. Feeds your source files into Gemini's 1M token context window and produces project-specific .mdc rules. Supports Cursor, Claude Code, Copilot, and Windsurf output formats. Zero dependencies.
+- [rule-gen](https://github.com/nedcodes-ok/rule-gen) - Generate AI coding rules from your actual codebase using Google Gemini. Feeds your source files into Gemini's 1M token context window and produces project-specific .mdc rules. Supports Cursor, Claude Code, Copilot, and Windsurf output formats. Zero dependencies. (`npm install -g rulegen-ai`)

Option 2: Add npm package link

-- [rule-gen](https://github.com/nedcodes-ok/rule-gen) - Generate AI coding rules from your actual codebase using Google Gemini. Feeds your source files into Gemini's 1M token context window and produces project-specific .mdc rules. Supports Cursor, Claude Code, Copilot, and Windsurf output formats. Zero dependencies.
+- [rule-gen](https://github.com/nedcodes-ok/rule-gen) ([npm](https://www.npmjs.com/package/rulegen-ai)) - Generate AI coding rules from your actual codebase using Google Gemini. Feeds your source files into Gemini's 1M token context window and produces project-specific .mdc rules. Supports Cursor, Claude Code, Copilot, and Windsurf output formats. Zero dependencies.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 289, Update the README list entry that currently
references "[rule-gen]" to also surface the npm package name and link: add the
npm package name "rulegen-ai" in the description next to "rule-gen" and include
a link to its npm page (e.g., https://www.npmjs.com/package/rulegen-ai) so users
can find installation info; locate the list item containing the "[rule-gen]"
text and append the npm name/link and a short install hint.

289-289: Clarify output format names for accuracy.

The description mentions "Claude Code" but based on the PR objectives, the tool generates specific file formats: CLAUDE.md and AGENTS.md (in addition to .mdc for Cursor). Consider being more specific about the actual output file formats to help users understand what the tool produces.

📝 Suggested improvement for clarity
-- [rule-gen](https://github.com/nedcodes-ok/rule-gen) - Generate AI coding rules from your actual codebase using Google Gemini. Feeds your source files into Gemini's 1M token context window and produces project-specific .mdc rules. Supports Cursor, Claude Code, Copilot, and Windsurf output formats. Zero dependencies.
+- [rule-gen](https://github.com/nedcodes-ok/rule-gen) - Generate AI coding rules from your actual codebase using Google Gemini. Feeds your source files into Gemini's 1M token context window and produces project-specific rules. Supports multiple output formats: .mdc (Cursor), CLAUDE.md, AGENTS.md, Copilot, and Windsurf. Zero dependencies.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 289, Update the README description for rule-gen to list
the actual output file formats rather than the ambiguous "Claude Code" term:
change the sentence that currently mentions "Claude Code" to explicitly state
the generated files (.mdc for Cursor, CLAUDE.md, and AGENTS.md) and keep the
rest of the sentence about supported output formats (Cursor, Copilot, Windsurf)
and zero dependencies intact so users know exactly which files the tool
produces.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 289: Update the README list entry that currently references "[rule-gen]"
to also surface the npm package name and link: add the npm package name
"rulegen-ai" in the description next to "rule-gen" and include a link to its npm
page (e.g., https://www.npmjs.com/package/rulegen-ai) so users can find
installation info; locate the list item containing the "[rule-gen]" text and
append the npm name/link and a short install hint.
- Line 289: Update the README description for rule-gen to list the actual output
file formats rather than the ambiguous "Claude Code" term: change the sentence
that currently mentions "Claude Code" to explicitly state the generated files
(.mdc for Cursor, CLAUDE.md, and AGENTS.md) and keep the rest of the sentence
about supported output formats (Cursor, Copilot, Windsurf) and zero dependencies
intact so users know exactly which files the tool produces.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fc2ce04 and 58a92d8.

📒 Files selected for processing (1)
  • README.md

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.

1 participant