diff --git a/README.md b/README.md index 4d53be0..843eb86 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,12 @@ Use punctuation markers in comments to flag human judgment: | `??` | TODO, HACK | I'm uncertain | Purple (base0E) | | `>>` | NOTE, NB | See reference | Cyan (base0C) | +The VS Code/Cursor extension highlights the whole comment line as a rounded badge. Legacy keywords use the same colors as their punctuation marker, so `FIXME`/`BUG`/`XXX` look like `!!`, `TODO`/`HACK` look like `??`, and `NOTE`/`NB` look like `>>`. + +

+ Human++ comment marker preview showing FIXME, TODO, HACK, NOTE, NB, and explicit punctuation badges +

+ ```js // Regular comment stays calm (base03) diff --git a/site/assets/comment-marker-preview.svg b/site/assets/comment-marker-preview.svg new file mode 100644 index 0000000..8adb76a --- /dev/null +++ b/site/assets/comment-marker-preview.svg @@ -0,0 +1,63 @@ + + Human++ comment marker preview + Preview of Human++ comment marker badges for explicit punctuation and legacy keyword aliases. + + + + + + + + marker-aliases.ts + + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + + // Regular comment stays calm and low-contrast + + + // FIXME: payment retry can double-submit + !! + + + // BUG: cache invalidation skips deleted users + !! + + + // XXX: verify migration before rollout + !! + + + // TODO: choose a better empty-state copy + ?? + + + // HACK: keep legacy slug routing alive for now + ?? + + + // NOTE: this mirrors the server-side validator + >> + + + // NB: redirects intentionally preserve the query string + >> + + + // !! Explicit punctuation always works too + !! + + + // >> Explicit context note stays visible + >> + + Aliases are case-insensitive; strongest marker wins when multiple keywords appear. + diff --git a/templates/README.md.tmpl b/templates/README.md.tmpl index d703308..f412fe0 100644 --- a/templates/README.md.tmpl +++ b/templates/README.md.tmpl @@ -105,6 +105,12 @@ Use punctuation markers in comments to flag human judgment: | `??` | TODO, HACK | I'm uncertain | Purple (base0E) | | `>>` | NOTE, NB | See reference | Cyan (base0C) | +The VS Code/Cursor extension highlights the whole comment line as a rounded badge. Legacy keywords use the same colors as their punctuation marker, so `FIXME`/`BUG`/`XXX` look like `!!`, `TODO`/`HACK` look like `??`, and `NOTE`/`NB` look like `>>`. + +

+ Human++ comment marker preview showing FIXME, TODO, HACK, NOTE, NB, and explicit punctuation badges +

+ ```js // Regular comment stays calm (base03) diff --git a/tools/build.py b/tools/build.py index 9a68950..01e0fc2 100755 --- a/tools/build.py +++ b/tools/build.py @@ -1644,6 +1644,74 @@ def generate_svgs(colors, meta): (assets_dir / "preview-light.svg").write_text(preview_light) print(" ✓ site/assets/preview-dark.svg, preview-light.svg") + # Comment marker alias preview for issue triage / README clarity. + marker_preview = f''' + Human++ comment marker preview + Preview of Human++ comment marker badges for explicit punctuation and legacy keyword aliases. + + + + + + + + marker-aliases.ts + + 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 + 10 + + // Regular comment stays calm and low-contrast + + + // FIXME: payment retry can double-submit + !! + + + // BUG: cache invalidation skips deleted users + !! + + + // XXX: verify migration before rollout + !! + + + // TODO: choose a better empty-state copy + ?? + + + // HACK: keep legacy slug routing alive for now + ?? + + + // NOTE: this mirrors the server-side validator + >> + + + // NB: redirects intentionally preserve the query string + >> + + + // !! Explicit punctuation always works too + !! + + + // >> Explicit context note stays visible + >> + + Aliases are case-insensitive; strongest marker wins when multiple keywords appear. + +''' + (assets_dir / "comment-marker-preview.svg").write_text(marker_preview) + print(" ✓ site/assets/comment-marker-preview.svg") + def generate_readme(colors, meta):