Repository navigation
docs: document the Nix dev shell and lint rule gotchas for agents - #886
Merged
Merged
Conversation
AGENTS.md now explains how to run builds and codegen through `nix develop -c` in a non-interactive shell, that `just format` needs `bun install` first, and a few things that are easy to miss when writing lint rules. CONTRIBUTING.md still showed the spec expectation syntax from before the flat rule ids.
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.
Makes the repo easier for coding agents to work with, based on the friction from porting the Squawk rules in #885.
AGENTS.md
Unable to find libclangoutside the Nix shell, and in a non-interactive shellnix developalone just opens a subshell. The new section shows how to wrap commands withnix develop -c ..., warns that the first run takes minutes, says to runbun installbeforejust format/just gen-lint(otherwiseoxfmtis missing and the generated TS stays unformatted), and notes thatsqlx::testtests need the docker database.gen-lintfor each one,version: "next", how spec expectations are counted, the one-diagnostic rule for doc examples, the Postgres 17 libpg_query bindings, identifiers truncated to 63 bytes in the AST,ctx.stmt().iter()for nested nodes, and how to dump an AST.INSTA_UPDATE=alwaysto accept snapshots without the interactive review.CONTRIBUTING.md
The spec example still used
-- expect_lint/<group>/<ruleName>, which no longer matches since the flat rule ids (#815). It now uses-- expect_lint/<ruleName>and explains that only the number of diagnostics per rule is checked.