incitaciones 0.7.0 → 0.8.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/README.md +4 -7
- package/content/distilled/codebase-cartography/SKILL.md +4 -3
- package/content/distilled/codebase-cartography/references/report-template.md +56 -5
- package/package.json +1 -1
- package/pi-package/skills/codebase-cartography/SKILL.md +4 -3
- package/pi-package/skills/codebase-cartography/references/report-template.md +56 -5
package/README.md
CHANGED
|
@@ -39,13 +39,10 @@ cd incitaciones
|
|
|
39
39
|
**Install options:**
|
|
40
40
|
|
|
41
41
|
```bash
|
|
42
|
-
./install.sh --bundle essentials # Core prompts only
|
|
43
|
-
./install.sh --
|
|
44
|
-
./install.sh --bundle reviews # Review prompts
|
|
45
|
-
./install.sh --bundle documentation # Documentation tools
|
|
42
|
+
./install.sh --bundle essentials # Core prompts only (see all 8 bundles: --list)
|
|
43
|
+
./install.sh --list # Show available prompts and bundles
|
|
46
44
|
./install.sh --format commands # Legacy flat-file format for other tools
|
|
47
45
|
./install.sh --disable-model-invocation # Require explicit /skill:name usage
|
|
48
|
-
./install.sh --list # Show available prompts
|
|
49
46
|
./install.sh --help # Show all options
|
|
50
47
|
```
|
|
51
48
|
|
|
@@ -83,12 +80,12 @@ pi install git:github.com/charly-vibes/incitaciones
|
|
|
83
80
|
pi install .
|
|
84
81
|
```
|
|
85
82
|
|
|
86
|
-
The
|
|
83
|
+
The npm package ships generated pi package resources under `pi-package/`. The directory is **gitignored, not checked in** — CI regenerates it during npm publish (`npm-publish.yml` runs `scripts/generate-pi-resources.mjs` before `npm publish`), so there is nothing to commit. Locally, the pre-push hook runs `just validate-pi-package`, which regenerates and verifies the resources match the manifest:
|
|
87
84
|
|
|
88
85
|
- `pi-package/skills/` — Agent Skills with pi-compatible frontmatter
|
|
89
86
|
- `pi-package/prompts/` — prompt templates for slash-command shortcuts
|
|
90
87
|
|
|
91
|
-
After changing distilled content or manifest entries,
|
|
88
|
+
After changing distilled content or manifest entries, you don't need to touch `pi-package/` — it is regenerated and validated automatically (CI on publish, pre-push hook locally). To preview the generated resources manually, run `just generate-pi-resources`.
|
|
92
89
|
|
|
93
90
|
### Publishing a new version
|
|
94
91
|
|
|
@@ -31,11 +31,12 @@ Pick the entry level from the request:
|
|
|
31
31
|
- Before gathering evidence for any map (and again before rendering), read `references/zoom-levels.md` — per-level evidence collection commands and text rendering formats.
|
|
32
32
|
- Before any health check or when the user asks about "health", "smells", or refactoring targets, read `references/smell-signatures.md` — anti-pattern proxies, evidence requirements, severity ratings.
|
|
33
33
|
- Before writing the final output, read `references/report-template.md` — output structure per mode.
|
|
34
|
-
- When the user asks for an HTML export or a shareable version of the report, read the "Optional HTML Export" section at the end of `references/report-template.md
|
|
34
|
+
- When the user asks for an HTML export or a shareable version of the report, read the "Optional HTML Export" section at the end of `references/report-template.md`; when the request spans multiple reports (batch), also read its "Batch export" section.
|
|
35
35
|
|
|
36
36
|
## Zoom Discipline
|
|
37
37
|
|
|
38
|
-
- Offer adjacent levels as follow-ups; never dump all three maps unrequested.
|
|
38
|
+
- Offer adjacent levels as follow-ups; never dump all three maps unrequested. An explicit batch request ("all reports", "map every module") is a user request — the offer-don't-dump rule applies to unprompted follow-ups only (batch procedure in `references/report-template.md`, "Batch export" section).
|
|
39
|
+
- Re-verify every embedded count and fan-in/fan-out number against a fresh command run immediately before writing each report (one consolidated pass per batch is fine) — counts gathered early in a long session drift.
|
|
39
40
|
- Every claim carries a file reference (`path`, or `path:line` for specific symbols).
|
|
40
41
|
- State dependency direction explicitly (A → B); never "related to".
|
|
41
42
|
- Distinguish observed evidence from inference; label inference explicitly.
|
|
@@ -48,4 +49,4 @@ Pick the entry level from the request:
|
|
|
48
49
|
- Prefer structural facts over narrative: dependency direction, counts, boundaries.
|
|
49
50
|
- Health-check findings follow the evidence format in `references/smell-signatures.md` (pattern, evidence, quantity, severity) — never unanchored opinions.
|
|
50
51
|
- Maps are diff-able artifacts: tables and Mermaid, not prose walls.
|
|
51
|
-
- HTML export is derived output, produced only on request; the markdown report remains the artifact of record.
|
|
52
|
+
- HTML export is derived output, produced only on request; the markdown report remains the artifact of record. Exports live in `docs/cartography/` as a self-contained directory (index + shared assets); see the "Optional HTML Export" section of `references/report-template.md`.
|
|
@@ -60,16 +60,67 @@ One finding block per pattern (format in `smell-signatures.md`), ordered by seve
|
|
|
60
60
|
|
|
61
61
|
**Adjacent levels offered** — one line each, e.g. "meso map of ledger available on request".
|
|
62
62
|
|
|
63
|
+
## Batch export
|
|
64
|
+
|
|
65
|
+
An explicit batch request ("generate all the reports", "map every module") is a user request — Zoom Discipline's offer-don't-dump rule applies to unprompted follow-ups only.
|
|
66
|
+
|
|
67
|
+
- Enumerate targets from the module inventory. Confirm the list once when it exceeds 3 targets or the scope is ambiguous; proceed unless corrected.
|
|
68
|
+
- One markdown per target in `docs/cartography/` — each the artifact of record for its target. For each, re-verify counts immediately before writing (Zoom Discipline).
|
|
69
|
+
- Include a health report only if the batch request names health/smells.
|
|
70
|
+
- A target too large for one pass: skip it, mark it as "offered — too large for one pass" in the final summary and, when HTML export is part of the batch, in `index.html`. Do not stop the batch to ask.
|
|
71
|
+
- Superseded artifacts from older exports (old-format HTML pages, render scripts): regenerate in place, recommend deleting the superseded script/pages, and never index stale-format files.
|
|
72
|
+
- When HTML export is part of the batch request or separately requested, HTML pages and `index.html` follow the Optional HTML Export section (regenerate the index once at the end, covering all reports).
|
|
73
|
+
|
|
63
74
|
## Optional HTML Export
|
|
64
75
|
|
|
65
|
-
Produce only on request ("export as HTML", "shareable report"). The markdown report is the source of truth; the HTML
|
|
76
|
+
Produce only on request ("export as HTML", "shareable report"). The markdown report is the source of truth; the HTML files are a derived, regenerable view — never hand-edit them, regenerate them from the markdown.
|
|
77
|
+
|
|
78
|
+
The export is a **self-contained directory**: all pages plus shared assets under one folder, opening correctly via `file://`, offline, with no server, CDN at view time, or build step. JavaScript is permitted only as a local vendored asset (see Diagrams).
|
|
79
|
+
|
|
80
|
+
### Output directory
|
|
81
|
+
|
|
82
|
+
- All exports live in `docs/cartography/` (create directories as needed). If `docs/` does not already exist in the repo, confirm once with the user before creating it.
|
|
83
|
+
- Pages reference assets with relative paths (`assets/...`), never absolute or remote URLs.
|
|
84
|
+
|
|
85
|
+
### Files
|
|
86
|
+
|
|
87
|
+
- One page per report: `cartography-<level>-<target>.html` (e.g. `cartography-meso-payments-billing.html`; slugify the target with hyphens, no dots or spaces). The zoom level in the name prevents exports of different levels overwriting each other. Re-exporting the same level+target overwrites the previous file — intended; there is no history.
|
|
88
|
+
- `index.html` — regenerated on every export; never hand-maintained.
|
|
89
|
+
- `assets/mermaid.min.js` — vendored Mermaid v9.4.3 IIFE build, shared by all pages.
|
|
90
|
+
|
|
91
|
+
### Index
|
|
92
|
+
|
|
93
|
+
Regenerate `index.html` on every export from what is on disk plus what is known this session:
|
|
94
|
+
|
|
95
|
+
- Scan `docs/cartography/*.html` (excluding `index.html`), group entries by zoom level (macro / meso / micro / health), sorted alphabetically.
|
|
96
|
+
- Each entry links to the page and shows its target plus a one-line scope taken from the report header.
|
|
97
|
+
- Also list markdown reports known to this session (the artifact of record), linked with a repo-relative path from the HTML location. Do not invent paths for reports you cannot locate.
|
|
98
|
+
- The template must handle N=1 (a single entry) without looking broken.
|
|
99
|
+
- Deterministic: sorted, no timestamps, no generator metadata.
|
|
100
|
+
|
|
101
|
+
### Navigation
|
|
102
|
+
|
|
103
|
+
- Every page (including `index.html`) has a plain nav header: `← Index` plus links to parent-context and adjacent-level pages when they exist (meso → its macro page; micro → its macro/meso parent). Relative links only.
|
|
104
|
+
- Static links only — no interactivity. Do not evolve the export into an application — no servers, frameworks, or interactive controls. If live interaction is requested, note it is out of scope for this skill.
|
|
105
|
+
|
|
106
|
+
### Diagrams
|
|
107
|
+
|
|
108
|
+
- Render Mermaid client-side with the vendored local asset: `<script src="assets/mermaid.min.js"></script>` plus `<pre class="mermaid">` blocks. Use only the v9.x IIFE build (global `mermaid`); v10+ is ESM-only and is blocked by CORS under `file://`.
|
|
109
|
+
- Asset acquisition: on the first export, download `mermaid.min.js` v9.4.3 into `assets/` if absent (e.g. from jsDelivr); reuse thereafter. If the download fails (offline machine), still emit all pages — diagrams degrade to their source in a styled `<pre>` and the report footer notes "diagrams show source; rerun the export with network access to enable rendering". Never fail the whole export because of assets.
|
|
110
|
+
- Every diagram keeps its Mermaid source in `<details><pre class="mermaid-source">` as the no-JS fallback, so nothing is ever blank.
|
|
111
|
+
- Prose stays pre-rendered HTML — do not client-render markdown. The markdown report remains the artifact of record.
|
|
112
|
+
|
|
113
|
+
### Handoff
|
|
114
|
+
|
|
115
|
+
- Final step of any export (including the first): tell the user to open `docs/cartography/index.html` directly in a browser — `file://` works with no server; diagram rendering is guaranteed by the Diagrams section.
|
|
116
|
+
- Never start a server for static reports unless the user explicitly asks.
|
|
66
117
|
|
|
67
|
-
|
|
118
|
+
### Invariants
|
|
68
119
|
|
|
69
|
-
- **
|
|
70
|
-
- **No JavaScript:** diagrams render as styled `<pre>` blocks (text diagrams) or inline SVG producible without new dependencies. Keep the Mermaid source in the file (e.g. `<pre class="mermaid-source">`) so the diagram stays manipulable.
|
|
120
|
+
- **Write HTML directly:** no render scripts, build pipelines, or new dependencies (pandoc etc.) — even in batch mode. The regeneration path is re-running this skill, not a committed pipeline; exception only on explicit user request (note the dependency caveat in the reply).
|
|
71
121
|
- **Mirror, don't redesign:** same sections, same order, same content as the markdown report. The HTML adds presentation only (readable typography; `prefers-color-scheme` support optional).
|
|
72
122
|
- **Deterministic:** stable section order, no timestamps, no generator metadata.
|
|
73
123
|
- **Size guard:** render large reports as-is; never paginate, collapse, or add interactivity.
|
|
124
|
+
- **Commit-able:** reports and `assets/` are self-contained and offline-safe; suggest committing them, never silently gitignore.
|
|
74
125
|
|
|
75
|
-
|
|
126
|
+
Decision record: diagrams use a vendored local Mermaid v9.4.3 IIFE; prose is pre-rendered. Rationale: offline rendering, `file://` compatibility, no ESM/CORS issues. Render scripts and build pipelines are banned because agent-regeneration keeps the navigation/diagram/index guarantees that build scripts historically dropped (wai cartography batch, 2026-09-01: a pandoc pipeline produced 12 pages with zero cross-links and unrendered diagrams).
|
package/package.json
CHANGED
|
@@ -37,11 +37,12 @@ Pick the entry level from the request:
|
|
|
37
37
|
- Before gathering evidence for any map (and again before rendering), read `references/zoom-levels.md` — per-level evidence collection commands and text rendering formats.
|
|
38
38
|
- Before any health check or when the user asks about "health", "smells", or refactoring targets, read `references/smell-signatures.md` — anti-pattern proxies, evidence requirements, severity ratings.
|
|
39
39
|
- Before writing the final output, read `references/report-template.md` — output structure per mode.
|
|
40
|
-
- When the user asks for an HTML export or a shareable version of the report, read the "Optional HTML Export" section at the end of `references/report-template.md
|
|
40
|
+
- When the user asks for an HTML export or a shareable version of the report, read the "Optional HTML Export" section at the end of `references/report-template.md`; when the request spans multiple reports (batch), also read its "Batch export" section.
|
|
41
41
|
|
|
42
42
|
## Zoom Discipline
|
|
43
43
|
|
|
44
|
-
- Offer adjacent levels as follow-ups; never dump all three maps unrequested.
|
|
44
|
+
- Offer adjacent levels as follow-ups; never dump all three maps unrequested. An explicit batch request ("all reports", "map every module") is a user request — the offer-don't-dump rule applies to unprompted follow-ups only (batch procedure in `references/report-template.md`, "Batch export" section).
|
|
45
|
+
- Re-verify every embedded count and fan-in/fan-out number against a fresh command run immediately before writing each report (one consolidated pass per batch is fine) — counts gathered early in a long session drift.
|
|
45
46
|
- Every claim carries a file reference (`path`, or `path:line` for specific symbols).
|
|
46
47
|
- State dependency direction explicitly (A → B); never "related to".
|
|
47
48
|
- Distinguish observed evidence from inference; label inference explicitly.
|
|
@@ -54,4 +55,4 @@ Pick the entry level from the request:
|
|
|
54
55
|
- Prefer structural facts over narrative: dependency direction, counts, boundaries.
|
|
55
56
|
- Health-check findings follow the evidence format in `references/smell-signatures.md` (pattern, evidence, quantity, severity) — never unanchored opinions.
|
|
56
57
|
- Maps are diff-able artifacts: tables and Mermaid, not prose walls.
|
|
57
|
-
- HTML export is derived output, produced only on request; the markdown report remains the artifact of record.
|
|
58
|
+
- HTML export is derived output, produced only on request; the markdown report remains the artifact of record. Exports live in `docs/cartography/` as a self-contained directory (index + shared assets); see the "Optional HTML Export" section of `references/report-template.md`.
|
|
@@ -60,16 +60,67 @@ One finding block per pattern (format in `smell-signatures.md`), ordered by seve
|
|
|
60
60
|
|
|
61
61
|
**Adjacent levels offered** — one line each, e.g. "meso map of ledger available on request".
|
|
62
62
|
|
|
63
|
+
## Batch export
|
|
64
|
+
|
|
65
|
+
An explicit batch request ("generate all the reports", "map every module") is a user request — Zoom Discipline's offer-don't-dump rule applies to unprompted follow-ups only.
|
|
66
|
+
|
|
67
|
+
- Enumerate targets from the module inventory. Confirm the list once when it exceeds 3 targets or the scope is ambiguous; proceed unless corrected.
|
|
68
|
+
- One markdown per target in `docs/cartography/` — each the artifact of record for its target. For each, re-verify counts immediately before writing (Zoom Discipline).
|
|
69
|
+
- Include a health report only if the batch request names health/smells.
|
|
70
|
+
- A target too large for one pass: skip it, mark it as "offered — too large for one pass" in the final summary and, when HTML export is part of the batch, in `index.html`. Do not stop the batch to ask.
|
|
71
|
+
- Superseded artifacts from older exports (old-format HTML pages, render scripts): regenerate in place, recommend deleting the superseded script/pages, and never index stale-format files.
|
|
72
|
+
- When HTML export is part of the batch request or separately requested, HTML pages and `index.html` follow the Optional HTML Export section (regenerate the index once at the end, covering all reports).
|
|
73
|
+
|
|
63
74
|
## Optional HTML Export
|
|
64
75
|
|
|
65
|
-
Produce only on request ("export as HTML", "shareable report"). The markdown report is the source of truth; the HTML
|
|
76
|
+
Produce only on request ("export as HTML", "shareable report"). The markdown report is the source of truth; the HTML files are a derived, regenerable view — never hand-edit them, regenerate them from the markdown.
|
|
77
|
+
|
|
78
|
+
The export is a **self-contained directory**: all pages plus shared assets under one folder, opening correctly via `file://`, offline, with no server, CDN at view time, or build step. JavaScript is permitted only as a local vendored asset (see Diagrams).
|
|
79
|
+
|
|
80
|
+
### Output directory
|
|
81
|
+
|
|
82
|
+
- All exports live in `docs/cartography/` (create directories as needed). If `docs/` does not already exist in the repo, confirm once with the user before creating it.
|
|
83
|
+
- Pages reference assets with relative paths (`assets/...`), never absolute or remote URLs.
|
|
84
|
+
|
|
85
|
+
### Files
|
|
86
|
+
|
|
87
|
+
- One page per report: `cartography-<level>-<target>.html` (e.g. `cartography-meso-payments-billing.html`; slugify the target with hyphens, no dots or spaces). The zoom level in the name prevents exports of different levels overwriting each other. Re-exporting the same level+target overwrites the previous file — intended; there is no history.
|
|
88
|
+
- `index.html` — regenerated on every export; never hand-maintained.
|
|
89
|
+
- `assets/mermaid.min.js` — vendored Mermaid v9.4.3 IIFE build, shared by all pages.
|
|
90
|
+
|
|
91
|
+
### Index
|
|
92
|
+
|
|
93
|
+
Regenerate `index.html` on every export from what is on disk plus what is known this session:
|
|
94
|
+
|
|
95
|
+
- Scan `docs/cartography/*.html` (excluding `index.html`), group entries by zoom level (macro / meso / micro / health), sorted alphabetically.
|
|
96
|
+
- Each entry links to the page and shows its target plus a one-line scope taken from the report header.
|
|
97
|
+
- Also list markdown reports known to this session (the artifact of record), linked with a repo-relative path from the HTML location. Do not invent paths for reports you cannot locate.
|
|
98
|
+
- The template must handle N=1 (a single entry) without looking broken.
|
|
99
|
+
- Deterministic: sorted, no timestamps, no generator metadata.
|
|
100
|
+
|
|
101
|
+
### Navigation
|
|
102
|
+
|
|
103
|
+
- Every page (including `index.html`) has a plain nav header: `← Index` plus links to parent-context and adjacent-level pages when they exist (meso → its macro page; micro → its macro/meso parent). Relative links only.
|
|
104
|
+
- Static links only — no interactivity. Do not evolve the export into an application — no servers, frameworks, or interactive controls. If live interaction is requested, note it is out of scope for this skill.
|
|
105
|
+
|
|
106
|
+
### Diagrams
|
|
107
|
+
|
|
108
|
+
- Render Mermaid client-side with the vendored local asset: `<script src="assets/mermaid.min.js"></script>` plus `<pre class="mermaid">` blocks. Use only the v9.x IIFE build (global `mermaid`); v10+ is ESM-only and is blocked by CORS under `file://`.
|
|
109
|
+
- Asset acquisition: on the first export, download `mermaid.min.js` v9.4.3 into `assets/` if absent (e.g. from jsDelivr); reuse thereafter. If the download fails (offline machine), still emit all pages — diagrams degrade to their source in a styled `<pre>` and the report footer notes "diagrams show source; rerun the export with network access to enable rendering". Never fail the whole export because of assets.
|
|
110
|
+
- Every diagram keeps its Mermaid source in `<details><pre class="mermaid-source">` as the no-JS fallback, so nothing is ever blank.
|
|
111
|
+
- Prose stays pre-rendered HTML — do not client-render markdown. The markdown report remains the artifact of record.
|
|
112
|
+
|
|
113
|
+
### Handoff
|
|
114
|
+
|
|
115
|
+
- Final step of any export (including the first): tell the user to open `docs/cartography/index.html` directly in a browser — `file://` works with no server; diagram rendering is guaranteed by the Diagrams section.
|
|
116
|
+
- Never start a server for static reports unless the user explicitly asks.
|
|
66
117
|
|
|
67
|
-
|
|
118
|
+
### Invariants
|
|
68
119
|
|
|
69
|
-
- **
|
|
70
|
-
- **No JavaScript:** diagrams render as styled `<pre>` blocks (text diagrams) or inline SVG producible without new dependencies. Keep the Mermaid source in the file (e.g. `<pre class="mermaid-source">`) so the diagram stays manipulable.
|
|
120
|
+
- **Write HTML directly:** no render scripts, build pipelines, or new dependencies (pandoc etc.) — even in batch mode. The regeneration path is re-running this skill, not a committed pipeline; exception only on explicit user request (note the dependency caveat in the reply).
|
|
71
121
|
- **Mirror, don't redesign:** same sections, same order, same content as the markdown report. The HTML adds presentation only (readable typography; `prefers-color-scheme` support optional).
|
|
72
122
|
- **Deterministic:** stable section order, no timestamps, no generator metadata.
|
|
73
123
|
- **Size guard:** render large reports as-is; never paginate, collapse, or add interactivity.
|
|
124
|
+
- **Commit-able:** reports and `assets/` are self-contained and offline-safe; suggest committing them, never silently gitignore.
|
|
74
125
|
|
|
75
|
-
|
|
126
|
+
Decision record: diagrams use a vendored local Mermaid v9.4.3 IIFE; prose is pre-rendered. Rationale: offline rendering, `file://` compatibility, no ESM/CORS issues. Render scripts and build pipelines are banned because agent-regeneration keeps the navigation/diagram/index guarantees that build scripts historically dropped (wai cartography batch, 2026-09-01: a pandoc pipeline produced 12 pages with zero cross-links and unrendered diagrams).
|