habit-hooks-typescript 1.0.0__tar.gz

habit_hooks_typescript-1.0.0/.gitignore

@@ -0,0 +1,20 @@
+# Per-plugin Node tool deps (installed via npm ci; see plugins/*/package.json)
+node_modules/
+dist
+coverage
+.DS_Store
+.idea
+.claude-channel/
+*.tgz
+*.log
+.vscode/
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+.spec-runs/
+
+/ruff.toml
+
+# Workflow orchestration script (run from ~/.claude, never a repo deliverable)
+.claude/workflows-build-overnight.js

habit_hooks_typescript-1.0.0/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: habit-hooks-typescript
+Version: 1.0.0
+Summary: The TypeScript Habit Hooks plugin
+Requires-Python: >=3.11

habit_hooks_typescript-1.0.0/docs/typescript-plugin.spec.md

@@ -0,0 +1,178 @@
+# The typescript plugin — acceptance
+
+The typescript plugin runs its sensors through the real `habit-sensors` pipeline.
+These cases run the **actual** tools (`eslint`, `knip`, and a `ts-morph` comment
+scan) against a fixture with a known smell and assert the canonical finding comes
+out, mapped to the smell keys in [smell-vocabulary.md](smell-vocabulary.md).
+
+`habit-sensors` is the installed CLI. The Node tools live in the typescript
+plugin's own `node_modules` (`plugins/typescript/node_modules`). The intro
+symlinks that into each case as `./node_modules` and puts its `.bin` on `PATH`
+once — the shipped `eslint.config.mjs` and `knip` resolve their plugin deps
+through the normal `node_modules` walk (ESM `import` ignores `NODE_PATH`, which
+is why we symlink rather than set it), and `ts-morph`'s `require` resolves the
+same way. The cases share `finding.jq` to project each finding down to the
+asserted fields.
+
+📄.habit-hooks/config.toml
+```toml
+plugins = ["typescript"]
+```
+
+📄package.json
+```json
+{ "name": "demo", "version": "0.0.0" }
+```
+
+📄finding.jq
+```jq
+sort_by(.smell)[]
+| {
+    smell,
+    language,
+    key: (.issues[0].key | sub(".*/"; "")),
+    line: .issues[0].details.line,
+    source: .issues[0].details.source
+  }
+```
+
+```bash
+ln -s ../../plugins/typescript/node_modules node_modules
+```
+
+✏️PATH
+```text
+$PWD/node_modules/.bin:$PATH
+```
+
+## eslint adapter maps rule IDs to canonical smells
+
+The `eslint` adapter runs eslint with the shipped flat config and a jq transform
+in its command flattens the per-file `messages[]`, remaps each rule ID to a
+canonical smell, and groups one finding per smell, stamping `source:
+"eslint:<rule>"` on each issue. The config caps `max-params` at 3, so a
+four-parameter function trips `max-params` → `too-many-parameters`.
+
+📄eslint.config.mjs @plugins/typescript/src/habit_hooks_typescript/eslint.config.mjs
+
+📄src/billing.ts
+```typescript
+export function charge(a: number, b: number, c: number, d: number): number {
+  return a + b + c + d;
+}
+```
+
+📄.habit-hooks/config.toml
+```toml
+plugins = ["typescript"]
+
+[sensors.knip]
+disabled = true
+
+[sensors.comment]
+disabled = true
+```
+
+```bash
+habit-sensors --all | jq -f finding.jq
+```
+
+🖥️ ✅
+```json
+{
+  "smell": "too-many-parameters",
+  "language": "typescript",
+  "key": "billing.ts",
+  "line": 1,
+  "source": "eslint:max-params"
+}
+```
+
+## knip sensor maps an unused export to unused-export
+
+The `knip` sensor runs knip with the shipped `knip.json`, accepts its 0/1 exit
+codes, and shapes each typed issue array into a finding — `exports` →
+`unused-export`, one issue per symbol keyed by the symbol name. `helper.ts`
+exports `neverUsed`, which nothing imports.
+
+📄knip.json @plugins/typescript/src/habit_hooks_typescript/knip.json
+
+📄src/cli.ts
+```typescript
+import { used } from "./helper";
+
+used();
+```
+
+📄src/helper.ts
+```typescript
+export function used(): void {}
+
+export function neverUsed(): void {}
+```
+
+📄.habit-hooks/config.toml
+```toml
+plugins = ["typescript"]
+
+[sensors.eslint]
+disabled = true
+
+[sensors.comment]
+disabled = true
+```
+
+```bash
+habit-sensors --all | jq '.[] | {smell, language, key: .issues[0].key, file: .issues[0].details.file, source: .issues[0].details.source}'
+```
+
+🖥️ ✅
+```json
+{
+  "smell": "unused-export",
+  "language": "typescript",
+  "key": "neverUsed",
+  "file": "src/helper.ts",
+  "source": "knip:exports"
+}
+```
+
+## comment sensor maps a non-essential comment to non-essential-comment
+
+The `comment` sensor scans the scoped files with ts-morph and reports comments
+the reader could work out from the code, shaping each into a
+`non-essential-comment` finding with `source: "comment:non-essential"`.
+
+📄src/util.ts
+```typescript
+export function add(a: number, b: number): number {
+  // this comment restates what the code already says clearly
+  return a + b;
+}
+```
+
+📄.habit-hooks/config.toml
+```toml
+plugins = ["typescript"]
+
+[sensors.eslint]
+disabled = true
+
+[sensors.knip]
+disabled = true
+```
+
+```bash
+habit-sensors --all | jq -f finding.jq
+```
+
+🖥️ ✅
+```json
+{
+  "smell": "non-essential-comment",
+  "language": "typescript",
+  "key": "util.ts",
+  "line": 2,
+  "source": "comment:non-essential"
+}
+```