ndrstnd 0.1.2 → 0.2.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/CHANGELOG.md +41 -0
- package/README.md +6 -0
- package/dist/server/analysis-core.js +173 -21
- package/dist/server/analysis-core.js.map +1 -1
- package/dist/server/analyze.d.ts +13 -0
- package/dist/server/analyze.js +102 -28
- package/dist/server/analyze.js.map +1 -1
- package/dist/server/cli.js +39 -10
- package/dist/server/cli.js.map +1 -1
- package/dist/server/diagnostic.d.ts +34 -0
- package/dist/server/diagnostic.js +155 -0
- package/dist/server/diagnostic.js.map +1 -0
- package/dist/shared/diagnostic-schema.d.ts +572 -0
- package/dist/shared/diagnostic-schema.js +83 -0
- package/dist/shared/diagnostic-schema.js.map +1 -0
- package/package.json +3 -2
- package/src/skill-assets/ndrstnd/SKILL.md +4 -3
|
@@ -17,6 +17,7 @@ Use ndrstnd whenever a human needs an intelligible story of a set of changes: af
|
|
|
17
17
|
3. Verify the scope cheaply before analyzing: `git diff --stat <base>...<target>` (or against the working tree) must list only files that belong to the handoff. Unrelated files mean a wrong base or stray dirty edits; fix that first, because the analysis takes minutes.
|
|
18
18
|
4. Export the conversation unless it contains no intent. Create a portable `ndrstnd-conversation-v1.json` with user and assistant text only, covering the motivating request, decisions, rejected alternatives, constraints, and any test or build results that were reported (commands and outcomes feed the Test plan's observed-execution evidence); never include tool output, credentials, or reasoning records. The analysis grounds its summary, before/after semantics, and step goals in this export, so omitting it produces a poorer artifact. A changed export triggers a fresh analysis rather than reusing a stale session. When the changes were produced outside this session and no dialogue about them exists, skip the export instead of fabricating one.
|
|
19
19
|
5. Run `ndrstnd review … --repo <root> --conversation <path> --agent <id>`, passing the agent you are (`codex` for Codex, `claude` for Claude Code) so the analysis reuses your own authenticated session instead of another installed agent's; ndrstnd detects the host agent when the flag is missing, but passing it removes the guess. Read the scope and manifest lines it prints (base, changed files, meaningful files, hunks, conversation count). If they do not match the intended handoff, correct the base and re-run. The analysis takes minutes on large branches and prints a `still analyzing` heartbeat line about every 15 seconds naming what the analysis agent is doing; while heartbeat lines keep appearing the run is healthy, so give the command a timeout of at least 15 minutes and never kill or restart it mid-analysis; that discards the whole draft.
|
|
20
|
-
6.
|
|
21
|
-
7.
|
|
22
|
-
8.
|
|
20
|
+
6. If the review fails, stop and preserve the diagnostic workflow. ndrstnd writes `.ndrstnd/ndrstnd-diagnostic-*.json` when it has a repository path, then prints numbered instructions. Attach that JSON unchanged with the exact review command, selected agent, and intended base/target scope. The default file contains safe metadata and hashes, not prompts, diffs, environment variables, or raw agent responses. Use `--diagnostic-include-agent-output` only when the maintainer asks for the raw response and only through a private channel; treat that file as sensitive. If no JSON was written, attach the complete terminal output. Never fabricate a review artifact or summarize a failed analysis as if it succeeded.
|
|
21
|
+
7. Link the successful HTML artifact in the handoff response so it can be read on desktop or mobile; it is self-contained, lives in the Git-ignored `.ndrstnd/` directory, and should be deleted once the review is done.
|
|
22
|
+
8. Tell the reviewer that ndrstnd is for comprehension: Story for the narrative, Timeline for the suggested build order, Test plan for how the behavior was exercised, and Full diff for every hunk including collapsed low-signal files.
|
|
23
|
+
9. Do not treat ndrstnd findings as merge criticism or modify the branch from its workspace. Use the agent's dedicated review workflow (Codex `/review` or Claude Code `/review`) for critique and change requests.
|