From 9d63f6efb5e2ca6a2cd4dc33bf26b67590b9e9ed Mon Sep 17 00:00:00 2001 From: Julian Noble Date: Mon, 22 Jun 2026 01:50:12 +1000 Subject: [PATCH] Update AGENTS.md re line endings and tclint --- AGENTS.md | 9 +++++---- src/modules/AGENTS.md | 3 ++- src/modules/punk/AGENTS.md | 2 +- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index 6416bf5b..30a29a68 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -124,7 +124,7 @@ if conflict with CLAUDE.md, AGENTS.md wins. - Confirm Windows-friendly Tcl toolchain (8.6+ required, 9.0 supported). - Run `tclsh src/make.tcl packages` once after cloning to populate generated assets. - Keep edits within the scoped instructions of any nested `AGENTS.md`. -- Use `tclint` before submitting code to align formatting and structure for any new agent-produced code, but do not use it to reformat existing code. +- Review VS Code Tcl lint diagnostics before submitting new agent-produced Tcl code, but do not use lint tooling to reformat existing code. - Execute at least one relevant test script (`tclsh src/tests//.tcl`). - Document changes impacting build, tooling, or developer workflow. @@ -142,7 +142,7 @@ if conflict with CLAUDE.md, AGENTS.md wins. - **Failure triage**: Capture stderr logs; prefer `try/on error` blocks inside tests for clearer diagnostics. ## Linting & Formatting -- **Command**: N/A - tclint is currently only available as a plugin in vscode (configured via `tclint.toml` in repo root). +- **Command**: None. Tcl linting is currently only available through the VS Code tclint plugin, configured via `tclint.toml`; do not try to run `tclint` or `tcllint` as shell commands. - **Files covered**: `.tcl`, `.tm` extend config if new extensions appear. - **Line length**: Hard cap at 400 characters; wrap pipelines thoughtfully instead of exceeding. - **Blank lines**: No more than 10 consecutive blanks. @@ -455,13 +455,14 @@ Ensure module filenames include the magic version (`punk//- ## Agent Workflow Tips - No `.cursor/rules/`, `.cursorrules`, or `.github/copilot-instructions.md` files exist as of this update. If they appear later, integrate their instructions here. -- Always re-run `tclint` and the most specific test affected by your changes before committing. +- Review VS Code Tcl lint diagnostics and run the most specific test affected by your changes before committing. +- When a tool summary reports cleanup issues such as `git diff --check` whitespace errors, verify against the exact command output and exit code before running secondary scans or reporting the issue. - When touching VFS payloads, describe regeneration steps inside commit messages and this guide if persistent. - Favor incremental commits tied to logical units of work; avoid monolithic diffs mixing tooling and feature changes. ## Final Submission Checklist - [ ] Nested `AGENTS.md` files checked for scope-specific rules. -- [ ] `tcllint` (and `tcllint --fix` if needed) executed with clean results. +- [ ] VS Code Tcl lint diagnostics reviewed when available; no `tclint`/`tcllint` CLI is expected. - [ ] Relevant tests (`tclsh src/tests/runtests.tcl`) executed and passing, or more specific `tclsh src/tests/modules//tests/all.tcl` passing - [ ] Build step (`tclsh make.tcl packages`) verified when touching build-critical code. - [ ] Documentation/comments updated for new behavior or flags. diff --git a/src/modules/AGENTS.md b/src/modules/AGENTS.md index 2b8b2f8a..1e79113d 100644 --- a/src/modules/AGENTS.md +++ b/src/modules/AGENTS.md @@ -22,13 +22,14 @@ Source of truth for all editable Punk project modules. This is where agents shou - Treat `src/modules/` as the source of truth for generic editable Punk modules. - Expect the literal suffix `-999999.0a1.0.tm`. +- Prefer Unix-style LF line endings for `.tm` source files in this tree. - If the same proc exists in both `src/modules/` and `src/modules_tcl/`, prefer `src/modules/` unless version-specific behavior is relevant or only the version-specific file is active. - Use `deck module.new ` or `punk::mix::commandset::module::new` to scaffold new modules. - Run `tclsh src/make.tcl modules` to build modules, or `tclsh src/make.tcl project` for a full build. ## Verification -- `tclint` passes on modified `.tm` files. +- VS Code Tcl lint diagnostics are clean for modified `.tm` files when available. - `tclsh src/make.tcl modules` completes without errors. - Module tests pass: `tclsh src/tests/modules//tests/all.tcl` diff --git a/src/modules/punk/AGENTS.md b/src/modules/punk/AGENTS.md index c4ac3b5c..7d4a3cc0 100644 --- a/src/modules/punk/AGENTS.md +++ b/src/modules/punk/AGENTS.md @@ -35,7 +35,7 @@ Source of truth for all modules under the `punk::*` namespace. This is the prima ## Verification -- `tclint` passes on modified `.tm` files. +- VS Code Tcl lint diagnostics are clean for modified `.tm` files when available. - `tclsh src/tests/modules/punk//tests/all.tcl` passes for relevant tests. ## Child DOX Index