@staff0rd/assist 0.1065.3 → 0.1067.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/claude/advice/code-comments.md +1 -1
- package/claude/commands/strip-code-comments.md +2 -1
- package/dist/built-version +1 -1
- package/dist/commands/extension/extension/content.js +1 -1
- package/dist/commands/extension/extension/docs.js +1 -1
- package/dist/commands/extension/extension/updates.json +2 -2
- package/dist/commands/sessions/web/bundle.js +352 -352
- package/dist/index.js +32 -8
- package/package.json +1 -1
|
@@ -3,4 +3,4 @@ title: Commenting code
|
|
|
3
3
|
when: always
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
Do not include comments for standard logic or syntax. Only comment if the specific line involves unintuitive complexity or a hack.
|
|
6
|
+
Do not include comments for standard logic or syntax. Only comment if the specific line involves unintuitive complexity or a hack. A trailing comment naming the tag/version on a SHA-pinned GitHub Actions `uses:` ref (e.g. `uses: owner/repo/.github/workflows/review.yml@<sha> # review-v0.17.1`) is allowed.
|
|
@@ -21,7 +21,7 @@ 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`), plus `#`-comment config and script files: `Dockerfile` (and variants `Dockerfile.*` / `*.dockerfile`), `*.env`, and
|
|
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`, `*.sh`, and GitHub workflow and action YAML (`.github/workflows/*.yml` / `.yaml`, `action.yml` / `action.yaml`). Skip generated output, lockfiles, vendored dependencies, and markdown/docs.
|
|
25
25
|
|
|
26
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.
|
|
27
27
|
|
|
@@ -37,6 +37,7 @@ Read each file and remove only comments that violate the policy:
|
|
|
37
37
|
|
|
38
38
|
- **Functional directives** that the toolchain acts on: `eslint-disable*`, `@ts-expect-error`, `@ts-ignore`, `oxlint-disable`, `prettier-ignore`, `// @ts-nocheck`, coverage pragmas (`c8 ignore`, `istanbul ignore`), `noqa`, `type: ignore`, `#pragma`, `//go:`-style directives, and similar.
|
|
39
39
|
- **Comments marking a genuine hack or workaround** — anything explaining _why_ non-obvious code exists, including `HACK`/`WORKAROUND`/`FIXME`/`TODO` notes, links to issues, or rationale the code cannot convey on its own.
|
|
40
|
+
- **SHA-pin version comments** — a trailing comment naming the tag/version on a `uses:` line pinned to a commit SHA (e.g. `uses: actions/checkout@<sha> # v4.2.2`).
|
|
40
41
|
- **Doc comments** that form part of an API contract (JSDoc/TSDoc, XML doc comments, docstrings) unless they only restate the signature.
|
|
41
42
|
|
|
42
43
|
When in doubt, keep the comment. The cost of leaving a borderline comment is far lower than deleting one that carries intent.
|
package/dist/built-version
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
0.
|
|
1
|
+
0.1067.0
|