@staff0rd/assist 0.370.1 → 0.372.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -199,7 +199,7 @@ The first backlog command in a repository that still has a local `.assist/backlo
199
199
  - `assist cli-hook deny add <pattern> <message>` - Add a deny rule for a command pattern
200
200
  - `assist cli-hook deny remove <pattern>` - Remove a deny rule by pattern
201
201
  - `assist edit-hook` - PreToolUse hook that blocks `Edit`/`Write`/`MultiEdit` calls from adding, changing, or removing a `// assist-maintainability-override` marker, or from introducing a code comment (use `code-comment set`/`confirm` for the rare comment that belongs)
202
- - `assist code-comment set <file> <line> <text>` - Validate a single-line comment (max 50 chars; no block comments for `.ts`/`.js`) and issue a pin authorising its insertion; inserts `#` for `.yml`/`.yaml` files and `//` otherwise
202
+ - `assist code-comment set <file> <line> <text>` - Validate a single-line comment (max 50 chars; no block comments for `.ts`/`.js`) and issue a pin authorising its insertion; inserts `#` for `#`-comment files (`.yml`/`.yaml`, Dockerfile, `*.env`, `*.sh`) and `//` otherwise
203
203
  - `assist code-comment confirm <pin>` - Insert the pinned comment at its file/line and clear the pin state
204
204
  - `assist update` - Update assist to the latest version and sync commands
205
205
  - `assist vscode init` - Add VS Code configuration files
@@ -21,7 +21,9 @@ Write self-documenting code. Do not add comments that restate what the code alre
21
21
 
22
22
  ## Step 2: Enumerate tracked source files
23
23
 
24
- List git-tracked source files with `git ls-files`. Restrict to source files (e.g. `.ts`, `.tsx`, `.js`, `.jsx`, `.cs`, `.py`, `.go`, `.rs`, `.java`, `.kt`, `.rb`, `.c`, `.h`, `.cpp`, `.css`, `.scss`, `.sh`). Skip generated output, lockfiles, vendored dependencies, and markdown/docs.
24
+ List git-tracked source files with `git ls-files`. Restrict to source files (e.g. `.ts`, `.tsx`, `.js`, `.jsx`, `.cs`, `.py`, `.go`, `.rs`, `.java`, `.kt`, `.rb`, `.c`, `.h`, `.cpp`, `.css`, `.scss`), plus `#`-comment config and script files: `Dockerfile` (and variants `Dockerfile.*` / `*.dockerfile`), `*.env`, and `*.sh`. Skip generated output, lockfiles, vendored dependencies, and markdown/docs.
25
+
26
+ For `*.sh` files, leave the leading header block untouched — the contiguous run of shebang, blank, and `#` lines from the top of the file, ending at the first line of code. Only strip violating `#` comments that appear **after** that header block. Dockerfile and `*.env` files have no such allowance; treat every `#` comment as in-scope.
25
27
 
26
28
  ## Step 3: Remove violating comments
27
29