Skip to content

Add ctxlint — linter for .cursorrules files#234

Open
jeffyaw wants to merge 1 commit intoPatrickJS:mainfrom
jeffyaw:add-ctxlint
Open

Add ctxlint — linter for .cursorrules files#234
jeffyaw wants to merge 1 commit intoPatrickJS:mainfrom
jeffyaw:add-ctxlint

Conversation

@jeffyaw
Copy link
Copy Markdown

@jeffyaw jeffyaw commented Apr 6, 2026

Summary

ctxlint is an open-source linter for AI context files including .cursorrules, CLAUDE.md, and copilot-instructions.md. It validates file paths, shell commands, and references against your actual codebase to catch broken paths, wrong commands, and stale context.

Added to the Utilities section in alphabetical order.

Summary by CodeRabbit

  • Documentation
    • Added ctxlint utility reference to the README, a linter for .cursorrules and AI context files that detects broken paths, incorrect commands, and stale context.

ctxlint is an open-source linter for AI context files (.cursorrules, CLAUDE.md, copilot-instructions.md).
It validates paths, commands, and references against the actual codebase.

GitHub: https://github.com/YawLabs/ctxlint
npm: @yawlabs/ctxlint
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 6, 2026

📝 Walkthrough

Walkthrough

A new entry is added to the Utilities section of README.md, linking to ctxlint, a linter tool for .cursorrules and AI context files designed to detect broken paths, incorrect commands, and stale context.

Changes

Cohort / File(s) Summary
Documentation Addition
README.md
Added ctxlint utility entry in the Utilities section with description of its linting capabilities for AI context files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A linter hops into our tools today,
To check the paths that stray astray,
Ctxlint keeps cursorrules so bright,
No broken links, no context blight! ✨

🚥 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 ctxlint — linter for .cursorrules files' accurately and specifically describes the main change: adding a new utility entry to the README for ctxlint.
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

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.

Warning

⚠️ This pull request might be slop. It has been flagged by CodeRabbit slop detection and should be reviewed carefully.

Copy link
Copy Markdown
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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 288: The README entry for "ctxlint" uses an absolute URL; change it to
the repository's relative-link format by replacing the absolute link with a
relative path to the ctxlint README (replace
"https://github.com/YawLabs/ctxlint" with the appropriate relative markdown link
pointing into the repo, keeping the link text "ctxlint" intact) so the line for
the ctxlint bullet uses a relative link and remains otherwise unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6692e5f6-c320-4e55-b0fb-679a5a1da9bb

📥 Commits

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

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


### Utilities

- [ctxlint](https://github.com/YawLabs/ctxlint) - Lints .cursorrules and other AI context files against your codebase. Catches broken paths, wrong commands, and stale context.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use a relative link format for this new README entry.

On Line 288, the new ctxlint link is absolute (https://...), but this repository’s README guideline requires links to be relative and correct. Please switch to the project’s expected relative-link format for this entry.

As per coding guidelines: "Ensure all links in the README.md file are relative and correct."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 288, The README entry for "ctxlint" uses an absolute URL;
change it to the repository's relative-link format by replacing the absolute
link with a relative path to the ctxlint README (replace
"https://github.com/YawLabs/ctxlint" with the appropriate relative markdown link
pointing into the repo, keeping the link text "ctxlint" intact) so the line for
the ctxlint bullet uses a relative link and remains otherwise unchanged.

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