docs: document check commands and headless nvim invocation in CLAUDE.md#89
Open
ooloth wants to merge 1 commit into
Open
docs: document check commands and headless nvim invocation in CLAUDE.md#89ooloth wants to merge 1 commit into
ooloth wants to merge 1 commit into
Conversation
#28 CLAUDE.md previously had no documented way for an agent to verify its changes. An agent editing plugin specs, keymaps, or LSP config had no feedback loop — no formatting check, no load test. Add a Checks section listing `stylua --check .` as the formatting check and `nvim --headless -c "lua require('config')" -c "qa"` as a way to exercise real Lua code paths without an interactive session. Also note `stylua .` as the fix command for formatting violations.
There was a problem hiding this comment.
Pull request overview
Adds a new “Checks” section to CLAUDE.md so contributors/agents know how to validate formatting and sanity-check that Neovim can load the config in a non-interactive session.
Changes:
- Documented
stylua --check .as the formatting verification command andstylua .as the fix command. - Added a documented
nvim --headless ...invocation intended to catch Lua load errors.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| stylua --check . | ||
|
|
||
| # Load the config headlessly to catch Lua errors and plugin spec issues | ||
| nvim --headless -c "lua require('config')" -c "qa" |
| # Check formatting (must pass before committing) | ||
| stylua --check . | ||
|
|
||
| # Load the config headlessly to catch Lua errors and plugin spec issues |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
✅ What
CLAUDE.mdlistingstylua --check .as the formatting check andnvim --headless -c "lua require('config')" -c "qa"as a way to load the config and catch Lua errors without an interactive sessionstylua .as the fix command for formatting violations🤔 Why
👩🔬 How to validate
CLAUDE.md— expect a Checks section withstylua --check .listedCLAUDE.md— expectnvim --headless -c "lua require('config')" -c "qa"listedstylua --check .from the repo root — expect it exits 0 (no formatting violations)nvim --headless -c "lua require('config')" -c "qa"— expect it exits without errors🔖 Related links
Closes #28
Generated by Claude Code