move-doctor 0.2.0-dev.4820c3a → 0.2.0-dev.d0feceb

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.
Files changed (3) hide show
  1. package/README.md +3 -30
  2. package/dist/cli.js +757 -649
  3. package/package.json +2 -3
package/README.md CHANGED
@@ -10,28 +10,7 @@ Deterministic Sui Move scanner. Rules grounded in [The Move Book](https://move-b
10
10
  npx move-doctor@latest
11
11
  ```
12
12
 
13
- Scans the current directory and prints a health score, a per-bucket breakdown, and next steps. Add `--verbose` for file/line refs and fix hints. Sample output:
14
-
15
- ```
16
- ╭────────────────────────────────────────────────────────────────────────╮
17
- │ │
18
- │ 44 / 100 poor movebook_gaps │
19
- │ ███████████████████████████████░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ │
20
- │ │
21
- │ 2 modules · edition 2024.beta · Sui 1.70.2 · scanned in 1.3s │
22
- │ 22 findings > 4 errors · 3 warnings · 15 info │
23
- ╰────────────────────────────────────────────────────────── move.doctor ─╯
24
-
25
- security > 4 errors · 3 warnings
26
- conventions > 5 info
27
- testing > 5 info
28
- functions > 2 info
29
- idioms > 2 info
30
- macros > 1 info
31
-
32
- > Run --verbose for file refs and fix hints.
33
- > Full rule catalog: https://move.doctor/docs/rules
34
- ```
13
+ Scans the current directory and prints a 0–100 health score, a severity breakdown by area, and next steps. Add `--verbose` for file/line refs and fix hints. With the Sui CLI on `PATH`, its `sui move build --lint` pass runs alongside and feeds the same score.
35
14
 
36
15
  ## Install as an agent skill
37
16
 
@@ -41,25 +20,19 @@ npx move-doctor@latest install
41
20
 
42
21
  Writes `<cwd>/.claude/skills/move-doctor/SKILL.md`. Claude Code picks it up automatically — type `/movedoctor` or ask it to "run move doctor" and it'll scan, group findings, and fix them.
43
22
 
44
- ## CI gate
23
+ ## CI
45
24
 
46
- Use `--score` for a numeric output and gate PRs on a budget:
25
+ `npx move-doctor@latest install` can set up a GitHub Actions workflow that scores every push and pull request. To gate by hand, fail the build below a score budget:
47
26
 
48
27
  ```bash
49
28
  SCORE=$(npx move-doctor@latest . --score)
50
29
  [ "$SCORE" -ge 80 ] || exit 1
51
30
  ```
52
31
 
53
- ## Requirements
54
-
55
- - Node.js ≥ 20
56
- - (Optional) Sui CLI on PATH — when present, `sui move build --lint` runs in parallel and its 6 built-in lints feed the same score.
57
-
58
32
  ## Source
59
33
 
60
34
  - Source code: [github.com/notmatical/move-doctor](https://github.com/notmatical/move-doctor)
61
35
  - Issues: [github.com/notmatical/move-doctor/issues](https://github.com/notmatical/move-doctor/issues)
62
- - Per-rule playbooks: [move.doctor/docs/rules](https://move.doctor/docs/rules)
63
36
  - Agent prompt: [move.doctor/prompts/move-doctor-agent.md](https://move.doctor/prompts/move-doctor-agent.md)
64
37
 
65
38
  ## License