simt-dev 0.2.0__tar.gz
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.
- simt_dev-0.2.0/.gitignore +10 -0
- simt_dev-0.2.0/CHANGELOG.md +166 -0
- simt_dev-0.2.0/LICENSE +202 -0
- simt_dev-0.2.0/PKG-INFO +150 -0
- simt_dev-0.2.0/README.md +120 -0
- simt_dev-0.2.0/bin/simt-dev.mjs +28 -0
- simt_dev-0.2.0/docs/decisions/ADR-001-push-requires-approval.md +42 -0
- simt_dev-0.2.0/docs/decisions/ADR-002-refactor-blast-radius.md +45 -0
- simt_dev-0.2.0/docs/decisions/ADR-003-test-breadth.md +46 -0
- simt_dev-0.2.0/docs/decisions/ADR-004-hook-owns-format.md +45 -0
- simt_dev-0.2.0/docs/decisions/ADR-005-file-length.md +42 -0
- simt_dev-0.2.0/docs/decisions/ADR-006-coverage-bar.md +59 -0
- simt_dev-0.2.0/docs/decisions/ADR-007-section-skeleton.md +54 -0
- simt_dev-0.2.0/docs/decisions/ADR-008-verdict-vocabulary.md +59 -0
- simt_dev-0.2.0/docs/decisions/ADR-009-skill-layout.md +48 -0
- simt_dev-0.2.0/docs/decisions/ADR-010-runner-invocation.md +56 -0
- simt_dev-0.2.0/docs/decisions/ADR-011-windows-support.md +52 -0
- simt_dev-0.2.0/docs/decisions/ADR-012-drop-windows-support.md +59 -0
- simt_dev-0.2.0/docs/decisions/ADR-013-genericity-by-facts-and-local-profiles.md +114 -0
- simt_dev-0.2.0/docs/decisions/ADR-014-workspace-is-configuration.md +211 -0
- simt_dev-0.2.0/docs/decisions/ADR-015-a-source-is-content-not-a-location.md +117 -0
- simt_dev-0.2.0/docs/decisions/ADR-016-a-divergent-rule-is-retired-not-merged.md +180 -0
- simt_dev-0.2.0/docs/decisions/ADR-017-a-declared-gate-must-be-runnable.md +89 -0
- simt_dev-0.2.0/docs/decisions/ADR-018-an-unset-hooks-path-is-not-an-absent-hook.md +183 -0
- simt_dev-0.2.0/docs/decisions/ADR-019-a-declared-command-is-the-runner.md +110 -0
- simt_dev-0.2.0/docs/decisions/ADR-020-a-rule-is-written-per-surface-and-pointed-not-copied.md +100 -0
- simt_dev-0.2.0/docs/decisions/ADR-021-one-surface-per-repo.md +94 -0
- simt_dev-0.2.0/docs/decisions/ADR-022-a-key-simt-dev-reads-is-prefixed.md +98 -0
- simt_dev-0.2.0/docs/decisions/ADR-023-the-gate-ships-as-a-file-the-repo-owns.md +106 -0
- simt_dev-0.2.0/docs/decisions/ADR-024-simt-dev-overwrites-its-own-gate-file.md +111 -0
- simt_dev-0.2.0/docs/decisions/ADR-025-a-baseline-is-a-region-in-a-file-the-repo-owns.md +153 -0
- simt_dev-0.2.0/docs/decisions/ADR-026-a-config-without-a-region-is-a-file-the-repo-owns.md +117 -0
- simt_dev-0.2.0/docs/decisions/ADR-027-the-one-gitattributes-line-that-is-neither-dangerous-nor-empty.md +130 -0
- simt_dev-0.2.0/docs/decisions/ADR-028-a-base-file-is-a-floor-so-the-disagreement-it-cannot-repair-becomes-a-check.md +131 -0
- simt_dev-0.2.0/docs/decisions/ADR-029-the-pins-a-repository-declares-are-its-own.md +120 -0
- simt_dev-0.2.0/docs/decisions/ADR-030-what-a-plan-does-not-ship-is-a-decision-with-a-record.md +114 -0
- simt_dev-0.2.0/docs/decisions/ADR-031-the-suite-stages-the-environment-it-needs.md +129 -0
- simt_dev-0.2.0/docs/decisions/ADR-032-provenance-is-a-content-digest-not-a-commit.md +141 -0
- simt_dev-0.2.0/docs/decisions/ADR-033-three-plan-rows-closed-by-decision-not-by-authoring.md +82 -0
- simt_dev-0.2.0/docs/decisions/ADR-034-a-staged-tool-refuses-a-partially-staged-file.md +91 -0
- simt_dev-0.2.0/docs/decisions/ADR-035-one-write-decision-and-one-json-document.md +119 -0
- simt_dev-0.2.0/docs/decisions/ADR-036-a-writer-that-writes-says-so-and-the-instructions-naming-it-move-with-it.md +103 -0
- simt_dev-0.2.0/docs/decisions/ADR-037-unchanged-means-writing-would-not-change-a-byte.md +100 -0
- simt_dev-0.2.0/docs/decisions/ADR-038-the-gate-filter-belongs-to-every-manifest-writer.md +95 -0
- simt_dev-0.2.0/docs/decisions/ADR-039-a-ci-step-runs-a-form-that-can-fail.md +101 -0
- simt_dev-0.2.0/docs/decisions/ADR-040-the-last-writer-that-wrote-by-default-was-not-the-one-named.md +158 -0
- simt_dev-0.2.0/docs/decisions/ADR-041-the-suite-installs-the-package-in-order-to-test-it.md +92 -0
- simt_dev-0.2.0/docs/decisions/ADR-042-a-declared-glob-must-match-a-path-built-from-it.md +94 -0
- simt_dev-0.2.0/docs/decisions/ADR-043-a-keyword-is-a-phrase-and-two-letters-is-a-word.md +90 -0
- simt_dev-0.2.0/docs/decisions/ADR-044-compatibility-is-not-evidence.md +116 -0
- simt_dev-0.2.0/docs/decisions/ADR-045-a-dashboard-that-counts-a-defect.md +119 -0
- simt_dev-0.2.0/docs/decisions/ADR-046-one-rule-one-copy.md +140 -0
- simt_dev-0.2.0/docs/decisions/ADR-047-a-profile-selects-on-what-a-repository-runs-on.md +141 -0
- simt_dev-0.2.0/docs/decisions/ADR-048-a-baseline-carries-only-keys-a-reader-honours.md +150 -0
- simt_dev-0.2.0/docs/decisions/ADR-049-a-ruling-that-a-later-record-moved-says-so-where-it-is-printed.md +153 -0
- simt_dev-0.2.0/docs/decisions/ADR-050-a-byte-count-is-not-a-region-and-updated-is-not-a-change-of-rules.md +102 -0
- simt_dev-0.2.0/docs/decisions/ADR-051-a-pointer-is-the-readers-only-route-so-it-is-not-a-convenience.md +134 -0
- simt_dev-0.2.0/docs/decisions/ADR-052-a-dependency-is-counted-against-the-budget-and-there-is-one-budget.md +101 -0
- simt_dev-0.2.0/docs/decisions/ADR-053-the-node-floor-is-22-20-0.md +49 -0
- simt_dev-0.2.0/docs/decisions/ADR-054-the-digest-covers-every-byte-that-leaves-the-package.md +100 -0
- simt_dev-0.2.0/docs/decisions/ADR-055-a-status-line-travels-so-it-may-not-name-a-location.md +98 -0
- simt_dev-0.2.0/docs/decisions/ADR-056-three-names-one-of-which-is-cheap-to-move.md +160 -0
- simt_dev-0.2.0/docs/decisions/ADR-057-an-identity-is-per-developer-and-a-repository-does-not-own-it.md +115 -0
- simt_dev-0.2.0/docs/decisions/ADR-058-one-tool-three-channels-and-the-order-is-forced.md +148 -0
- simt_dev-0.2.0/docs/decisions/README.md +530 -0
- simt_dev-0.2.0/graph/skills.graph.json +1622 -0
- simt_dev-0.2.0/package.json +43 -0
- simt_dev-0.2.0/pyproject.toml +148 -0
- simt_dev-0.2.0/python/simt_dev/__init__.py +32 -0
- simt_dev-0.2.0/python/simt_dev/cli.py +225 -0
- simt_dev-0.2.0/rules/core.md +76 -0
- simt_dev-0.2.0/rules/mdc/intake-questions.mdc +50 -0
- simt_dev-0.2.0/rules/mdc/preview-postflight.mdc +61 -0
- simt_dev-0.2.0/rules/mdc/slice-commit.mdc +52 -0
- simt_dev-0.2.0/rules/mdc/test-gate.mdc +54 -0
- simt_dev-0.2.0/rules/stacks/android.md +63 -0
- simt_dev-0.2.0/rules/stacks/cloudflare-workers.md +65 -0
- simt_dev-0.2.0/rules/stacks/connectiq.md +62 -0
- simt_dev-0.2.0/rules/stacks/container.md +31 -0
- simt_dev-0.2.0/rules/stacks/jvm.md +54 -0
- simt_dev-0.2.0/rules/stacks/node.md +45 -0
- simt_dev-0.2.0/rules/stacks/python.md +48 -0
- simt_dev-0.2.0/rules/stacks/react-native.md +58 -0
- simt_dev-0.2.0/rules/stacks/react-web.md +61 -0
- simt_dev-0.2.0/rules/stacks/typescript.md +21 -0
- simt_dev-0.2.0/rules/stacks/uv.md +32 -0
- simt_dev-0.2.0/src/argv.mjs +116 -0
- simt_dev-0.2.0/src/ci/dependabot.mjs +268 -0
- simt_dev-0.2.0/src/ci/workflow.mjs +360 -0
- simt_dev-0.2.0/src/commands/ci.mjs +285 -0
- simt_dev-0.2.0/src/commands/compare.mjs +195 -0
- simt_dev-0.2.0/src/commands/graph.mjs +73 -0
- simt_dev-0.2.0/src/commands/help.mjs +108 -0
- simt_dev-0.2.0/src/commands/hooks.mjs +471 -0
- simt_dev-0.2.0/src/commands/index.mjs +241 -0
- simt_dev-0.2.0/src/commands/init.mjs +632 -0
- simt_dev-0.2.0/src/commands/mcp.mjs +63 -0
- simt_dev-0.2.0/src/commands/rules.mjs +374 -0
- simt_dev-0.2.0/src/commands/skills.mjs +647 -0
- simt_dev-0.2.0/src/commands/skillsinstall.mjs +515 -0
- simt_dev-0.2.0/src/commands/sync.mjs +331 -0
- simt_dev-0.2.0/src/commands/upgrade.mjs +202 -0
- simt_dev-0.2.0/src/compare/discover.mjs +212 -0
- simt_dev-0.2.0/src/compare/hooksstate.mjs +159 -0
- simt_dev-0.2.0/src/compare/row.mjs +299 -0
- simt_dev-0.2.0/src/decisions/index.mjs +536 -0
- simt_dev-0.2.0/src/graph/load.mjs +541 -0
- simt_dev-0.2.0/src/hooks/capability.mjs +129 -0
- simt_dev-0.2.0/src/hooks/dispatcher.mjs +268 -0
- simt_dev-0.2.0/src/hooks/gates.mjs +144 -0
- simt_dev-0.2.0/src/hooks/resolve.mjs +194 -0
- simt_dev-0.2.0/src/hooks/shim.mjs +140 -0
- simt_dev-0.2.0/src/hooks/where.mjs +118 -0
- simt_dev-0.2.0/src/identity.mjs +218 -0
- simt_dev-0.2.0/src/locate.mjs +75 -0
- simt_dev-0.2.0/src/mcp/server.mjs +167 -0
- simt_dev-0.2.0/src/mcp/tools.mjs +410 -0
- simt_dev-0.2.0/src/name.mjs +95 -0
- simt_dev-0.2.0/src/output/index.mjs +96 -0
- simt_dev-0.2.0/src/projection/baselines.mjs +209 -0
- simt_dev-0.2.0/src/projection/conflicts.mjs +205 -0
- simt_dev-0.2.0/src/projection/manifest.mjs +478 -0
- simt_dev-0.2.0/src/projection/markers.mjs +349 -0
- simt_dev-0.2.0/src/projection/mdc.mjs +327 -0
- simt_dev-0.2.0/src/projection/project.mjs +504 -0
- simt_dev-0.2.0/src/projection/rules.mjs +640 -0
- simt_dev-0.2.0/src/projection/surfaces.mjs +398 -0
- simt_dev-0.2.0/src/projection/targets.mjs +221 -0
- simt_dev-0.2.0/src/resolve/fingerprint.mjs +553 -0
- simt_dev-0.2.0/src/resolve/near.mjs +61 -0
- simt_dev-0.2.0/src/resolve/resolve.mjs +457 -0
- simt_dev-0.2.0/src/resolve/source.mjs +105 -0
- simt_dev-0.2.0/src/toolchain.mjs +202 -0
- simt_dev-0.2.0/src/tsconfig.mjs +314 -0
- simt_dev-0.2.0/src/upgrade/plan.mjs +203 -0
- simt_dev-0.2.0/src/workspace.mjs +289 -0
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Editors and operating systems
|
|
2
|
+
.DS_Store
|
|
3
|
+
.idea/
|
|
4
|
+
# Per-developer git identity, written by `simt init`. Not a file to share:
|
|
5
|
+
# it carries whoever is committing into the tree, and a repository has more than
|
|
6
|
+
# one of those. See ADR-057.
|
|
7
|
+
git.config
|
|
8
|
+
|
|
9
|
+
.pybuild/
|
|
10
|
+
dist/
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this package are recorded here. The format follows
|
|
4
|
+
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project follows
|
|
5
|
+
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
6
|
+
|
|
7
|
+
## [0.2.0] — 2026-10-11
|
|
8
|
+
|
|
9
|
+
### Publishable from PyPI and Homebrew as well as npm
|
|
10
|
+
|
|
11
|
+
simt-dev is a *repository* tool, and the people who adopt a repository are not
|
|
12
|
+
all Node developers. Somebody running `simt init` inside a repository with no
|
|
13
|
+
`package.json` has no reason to install a package manager, and a Homebrew user
|
|
14
|
+
has no reason to install Node to install a tool that needs Node.
|
|
15
|
+
|
|
16
|
+
So it now publishes to three channels, from one version number:
|
|
17
|
+
|
|
18
|
+
```sh
|
|
19
|
+
npm i -D simt-dev # a tarball of .mjs files
|
|
20
|
+
pip install simt-dev # a wheel carrying those same bytes
|
|
21
|
+
brew install QuazarMedia/tap/simt-dev
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
The wheel is not a wrapper around `npm install`. It carries the tool's own
|
|
25
|
+
source, and `scripts/verify-wheel.mjs` builds both artefacts and hashes every
|
|
26
|
+
file in both — a release fails when a single byte differs between them. That
|
|
27
|
+
check exists because the obvious defect in this arrangement is the wheel and the
|
|
28
|
+
tarball quietly shipping different code.
|
|
29
|
+
|
|
30
|
+
`simt` is the one command, on every channel. Where node comes from is
|
|
31
|
+
`SIMT_DEV_NODE`, then the bundled node from `pip install "simt-dev[node]"`,
|
|
32
|
+
then `node` on `PATH` — and if none of those resolve you get the remedy rather
|
|
33
|
+
than a placeholder path. There are no required dependencies on any channel.
|
|
34
|
+
*(ADR-058)*
|
|
35
|
+
|
|
36
|
+
The channels are published in a fixed order rather than in parallel, and the
|
|
37
|
+
reason is not taste: the Homebrew formula downloads the npm tarball at install
|
|
38
|
+
time, so a formula naming a version still sitting in npm's staging area
|
|
39
|
+
installs a 404. Both jobs fail with that stated, and are run again after
|
|
40
|
+
`npm stage approve`.
|
|
41
|
+
|
|
42
|
+
## [0.1.1] — 2026-10-11
|
|
43
|
+
|
|
44
|
+
### A foreign hook on an event this repo does not gate is chained
|
|
45
|
+
|
|
46
|
+
`0.1.0` chained the wrong set of hooks and is worth replacing rather than
|
|
47
|
+
recommending. It chained on the event *vocabulary* — anything that was not
|
|
48
|
+
`pre-commit` or `pre-push` — when the question worth asking is whether **this
|
|
49
|
+
repository** declares a gate for that event.
|
|
50
|
+
|
|
51
|
+
The difference is `simt-app`, whose `pre-push` is `git-lfs`. `pre-push` is an
|
|
52
|
+
event this tool gates in general, so `0.1.0` displaced that hook; and because
|
|
53
|
+
`simt-app` declares no `pre-push` gate there was no shim for the event either, so
|
|
54
|
+
git would have found no `pre-push` hook at all. LFS objects would have stopped
|
|
55
|
+
being uploaded, with nothing to notice it — the exact silent failure chaining
|
|
56
|
+
exists to prevent, reached by fixing the wrong half of it.
|
|
57
|
+
|
|
58
|
+
`0.1.1` asks the manifest. An event the repo declares a gate for is left to
|
|
59
|
+
`gates.commands`, where the hook runs as a gate and its verdict appears in the
|
|
60
|
+
report; every other foreign hook is chained. That also picks up
|
|
61
|
+
`simt-landing`'s Lighthouse pre-push, which declares no gates at all.
|
|
62
|
+
*(ADR-018, as amended)*
|
|
63
|
+
|
|
64
|
+
Upgrade with `npm i -D simt-dev@0.1.1`, then `simt hooks install --yes`. Any
|
|
65
|
+
repository already routed with `0.1.0` should re-run it: the shims it writes
|
|
66
|
+
will differ where a gated event was previously displaced.
|
|
67
|
+
|
|
68
|
+
## [0.1.0] — 2026-10-11
|
|
69
|
+
|
|
70
|
+
The first release with real contents in it. `1.0.0` was an empty reservation of the name
|
|
71
|
+
and `0.0.0-stage` was its rehearsal; neither shipped a byte anyone could run, so this entry
|
|
72
|
+
is the whole history. The decisions behind it are readable in the package under
|
|
73
|
+
`docs/decisions/`, and from any checkout with `simt rules why <id>`.
|
|
74
|
+
|
|
75
|
+
### The command is `simt`
|
|
76
|
+
|
|
77
|
+
The package is `simt-dev` and the command is `simt`. They are not the same thing and were
|
|
78
|
+
never required to be: the command appears only in text the tool itself writes, and that
|
|
79
|
+
text migrates on the next write. The package name, the `.simt-hooks/` directory and the
|
|
80
|
+
`simt-dev-check.yml` gate already exist in every repository that adopted this tool, and
|
|
81
|
+
they did not move. The manifest and the region markers did — see below.
|
|
82
|
+
|
|
83
|
+
### The manifest is `simt.json`
|
|
84
|
+
|
|
85
|
+
The manifest was called `simt-dev.json`; it is now `simt.json`. The move is a
|
|
86
|
+
read-both/write-new, so nothing in an adopting repository has to be done:
|
|
87
|
+
|
|
88
|
+
- Every read takes `simt.json` if it exists, else `simt-dev.json`, so a repository that
|
|
89
|
+
has not written since the upgrade is still seen as adopted.
|
|
90
|
+
- Every write goes to `simt.json`, and a lone `simt-dev.json` is moved, not shadowed.
|
|
91
|
+
- The old name keeps working until the first `init` or manifest write in each repository,
|
|
92
|
+
and that write closes it. *(ADR-056)*
|
|
93
|
+
|
|
94
|
+
### The region markers are `simt:`
|
|
95
|
+
|
|
96
|
+
The generated region was stamped `<!-- simt-dev:begin -->` / `<!-- simt-dev:end -->` — and
|
|
97
|
+
so was the provenance header inside it; every one of those lines is now `simt:`. The move
|
|
98
|
+
is the same read-both/write-new as the manifest:
|
|
99
|
+
|
|
100
|
+
- Every read accepts either spelling, so a repository that has not written since the
|
|
101
|
+
upgrade is still seen as adopted.
|
|
102
|
+
- Every write emits `simt:` only, so the first `sync` in each repository migrates its
|
|
103
|
+
regions in place, and that write closes the window.
|
|
104
|
+
- A file holding two regions — one of each spelling — is a state only a hand edit can
|
|
105
|
+
make, and it is reported malformed rather than merged. *(ADR-056)*
|
|
106
|
+
|
|
107
|
+
### A hook you already had keeps running
|
|
108
|
+
|
|
109
|
+
`hooks install` points `core.hooksPath` at `.simt-hooks/`, and git reads **every** hook from
|
|
110
|
+
that one directory — not just the two events this tool gates. So adopting a repository that
|
|
111
|
+
had its own `post-commit`, `post-checkout` or `post-merge` would have quietly stopped them:
|
|
112
|
+
nothing fails, nothing is logged, and the hook is still on disk looking intact.
|
|
113
|
+
|
|
114
|
+
Those hooks are now **chained**. Install writes a shim for them that runs the repository's
|
|
115
|
+
own hook and forwards git's arguments, so nothing is lost and the reason is in the file. If
|
|
116
|
+
the hook is gone, the shim refuses and names the path instead of passing quietly. A hook on
|
|
117
|
+
an event this tool *does* gate (`pre-commit`, `pre-push`) is deliberately not chained —
|
|
118
|
+
declare it under `gates.commands` so the dispatcher runs it and its verdict appears in the
|
|
119
|
+
gate report. *(ADR-018, as amended)*
|
|
120
|
+
|
|
121
|
+
### What a first release has to say out loud
|
|
122
|
+
|
|
123
|
+
These are the behaviours a reader is most likely to trip over. Each one is deliberate,
|
|
124
|
+
and each has a numbered decision record behind it — but a behaviour nobody can discover
|
|
125
|
+
without reading the source is not a documented one.
|
|
126
|
+
|
|
127
|
+
- **`sync` and `init` write nothing without `--yes`.** Both print a plan and exit. `sync`
|
|
128
|
+
exits **1** when the plan is non-empty, so bare `sync` doubles as a check. Neither ever
|
|
129
|
+
commits or pushes. *(ADR-035, ADR-036)*
|
|
130
|
+
- **`upgrade` moves a pin and nothing else.** It never adopts a repository, never repairs
|
|
131
|
+
one, and never rewrites a manifest. Every consumer moves to the same version as one set.
|
|
132
|
+
- **A pre-commit hook with no reachable binary fails closed.** The refusal is the correct
|
|
133
|
+
behaviour, not a bug; the remedy it prints is the command that obtains one.
|
|
134
|
+
*(ADR-010, ADR-018)*
|
|
135
|
+
- **A gate whose tool is not installed is dropped, with a remedy naming the package.**
|
|
136
|
+
It is never declared and silently unrunnable. *(ADR-017)*
|
|
137
|
+
- **Two rules are never loaded twice.** Each rule projects to exactly one place, chosen by
|
|
138
|
+
what the harness actually reads. *(ADR-021, ADR-046)*
|
|
139
|
+
- **macOS and Linux only.** Windows `npm i` fails with npm's `EBADPLATFORM`, which npm
|
|
140
|
+
will not let a package explain; use WSL2. See the platform section of the README.
|
|
141
|
+
*(ADR-012)*
|
|
142
|
+
|
|
143
|
+
### Packaging
|
|
144
|
+
|
|
145
|
+
- Licence set to Apache-2.0; the `LICENSE` file is the canonical, unmodified text.
|
|
146
|
+
- `files` no longer lists `skills`, `agents`, `tooling` or `hooks`, none of which exist,
|
|
147
|
+
and no longer ships `docs/plans`. The tarball is the tool and the decisions behind it,
|
|
148
|
+
and nothing else.
|
|
149
|
+
- The package `description` no longer names an internal ecosystem. It is the first line
|
|
150
|
+
anybody outside the project reads.
|
|
151
|
+
- Unscoped, so the install command is `npm i -D simt-dev` rather than a name under an
|
|
152
|
+
organisation. The `@simt` and `@quazarmedia` scopes were both free; an unscoped name is
|
|
153
|
+
the one a reader can guess.
|
|
154
|
+
|
|
155
|
+
### Notes for anyone upgrading a hook
|
|
156
|
+
|
|
157
|
+
A shim installed by an earlier version looks for `SIMT_DEV_BIN`, then for
|
|
158
|
+
`node_modules/simt-dev/bin/simt-dev.mjs`, then for a program named `simt` on `PATH`. The
|
|
159
|
+
last of those is new, so a machine that installed the package before this release and
|
|
160
|
+
never ran `simt hooks install` again will find nothing until the dependency is refreshed
|
|
161
|
+
and `simt hooks install --yes` is re-run. That is a real upgrade step and it is called out
|
|
162
|
+
here rather than discovered.
|
|
163
|
+
|
|
164
|
+
[0.2.0]: https://github.com/QuazarMedia/simt-dev/releases/tag/v0.2.0
|
|
165
|
+
[0.1.1]: https://github.com/QuazarMedia/simt-dev/releases/tag/v0.1.1
|
|
166
|
+
[0.1.0]: https://github.com/QuazarMedia/simt-dev/releases/tag/v0.1.0
|
simt_dev-0.2.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
simt_dev-0.2.0/PKG-INFO
ADDED
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: simt-dev
|
|
3
|
+
Version: 0.2.0
|
|
4
|
+
Summary: Shared agent rules, skills and git hooks for a repository: one command adopts a repo, and every gate it declares is probed before it is written.
|
|
5
|
+
Project-URL: Homepage, https://github.com/QuazarMedia/simt-dev
|
|
6
|
+
Project-URL: Repository, https://github.com/QuazarMedia/simt-dev
|
|
7
|
+
Project-URL: Changelog, https://github.com/QuazarMedia/simt-dev/blob/main/CHANGELOG.md
|
|
8
|
+
Author: Said Elimam
|
|
9
|
+
License-Expression: Apache-2.0
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Keywords: agent,agents,ai,codex,cursor,git-hooks,llm,rules,skills
|
|
12
|
+
Classifier: Development Status :: 3 - Alpha
|
|
13
|
+
Classifier: Environment :: Console
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
16
|
+
Classifier: Operating System :: MacOS
|
|
17
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
25
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
26
|
+
Requires-Python: >=3.9
|
|
27
|
+
Provides-Extra: node
|
|
28
|
+
Requires-Dist: nodejs-wheel-binaries; extra == 'node'
|
|
29
|
+
Description-Content-Type: text/markdown
|
|
30
|
+
|
|
31
|
+
# simt-dev
|
|
32
|
+
|
|
33
|
+
Shared agent rules, skills and git hooks for a repository.
|
|
34
|
+
|
|
35
|
+
One command adopts a repository: it reads what the repo actually runs, projects the
|
|
36
|
+
matching rules into the files your agent already reads, and installs a pre-commit hook
|
|
37
|
+
that refuses a commit which breaks a gate that repo can genuinely run.
|
|
38
|
+
|
|
39
|
+
- **Nothing is declared that cannot run.** Every gate is probed against the working tree
|
|
40
|
+
before it is written. A gate whose tool is absent is dropped, with a remedy naming the
|
|
41
|
+
package to install — never silently present, never silently absent.
|
|
42
|
+
- **Nothing an agent reads is written twice.** Each rule goes to exactly one place, chosen
|
|
43
|
+
by what the harness actually reads.
|
|
44
|
+
- **The rules are a projection, not a copy.** They carry markers, so `check` can tell
|
|
45
|
+
drift from a deliberate edit, and `sync` can regenerate.
|
|
46
|
+
- **The tool explains itself.** `rules why` answers "why did I get told this?" from a
|
|
47
|
+
numbered record of the decisions behind the rules, with the rejected alternatives
|
|
48
|
+
attached.
|
|
49
|
+
|
|
50
|
+
## Install
|
|
51
|
+
|
|
52
|
+
Requires **Node >= 22.20.0** (the PyPI install can supply it, see below).
|
|
53
|
+
|
|
54
|
+
```sh
|
|
55
|
+
# pinned, per repository - what CI and a teammate both get
|
|
56
|
+
npm i -D simt-dev@0.2.0
|
|
57
|
+
|
|
58
|
+
# or globally, if you would rather not add a dependency
|
|
59
|
+
npm i -g simt-dev@0.2.0
|
|
60
|
+
|
|
61
|
+
# or with no install at all, for a one-off
|
|
62
|
+
npx -y simt-dev@0.2.0 check
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### From PyPI
|
|
66
|
+
|
|
67
|
+
The same tool, from the same bytes. The wheel carries the exact contents the npm
|
|
68
|
+
tarball carries — the wheel is not a wrapper around `npm install`, so nothing is
|
|
69
|
+
fetched when you install it.
|
|
70
|
+
|
|
71
|
+
```sh
|
|
72
|
+
pip install simt-dev
|
|
73
|
+
|
|
74
|
+
# and if this machine has no node at all
|
|
75
|
+
pip install "simt-dev[node]"
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
`simt` is the command on both channels. Where node comes from is resolved in
|
|
79
|
+
this order, and the first one that answers wins: `SIMT_DEV_NODE`, the bundled
|
|
80
|
+
node from the `node` extra, then `node` on your `PATH`. If none of them resolve,
|
|
81
|
+
you get a message naming the remedy rather than a placeholder node path.
|
|
82
|
+
|
|
83
|
+
### From Homebrew
|
|
84
|
+
|
|
85
|
+
```sh
|
|
86
|
+
brew install QuazarMedia/homebrew-tap/simt-dev
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
The formula declares its own `node` dependency, so `brew install` gives you a
|
|
90
|
+
working command on a machine that has never had Node.
|
|
91
|
+
|
|
92
|
+
Pin the version. The tool writes a content digest into the files it generates, and an
|
|
93
|
+
unpinned upgrade changes them under you.
|
|
94
|
+
|
|
95
|
+
## Use
|
|
96
|
+
|
|
97
|
+
```sh
|
|
98
|
+
simt init # adopt or scaffold this repository (dry-run; --yes to write)
|
|
99
|
+
simt doctor # what this repo is, and whether its config is healthy
|
|
100
|
+
simt check # the gate: projection drift, manifest validity, policy
|
|
101
|
+
simt sync --yes # regenerate the projection
|
|
102
|
+
simt upgrade --yes # move every consumer of this tool to this version
|
|
103
|
+
simt rules why ADR-042 # why a rule says what it says, and what was rejected
|
|
104
|
+
simt compare # what changed across every repository that adopted it
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
`init` and `sync` print a plan and write nothing without `--yes`. Neither commits or pushes.
|
|
108
|
+
|
|
109
|
+
## What it writes
|
|
110
|
+
|
|
111
|
+
| Path | What |
|
|
112
|
+
| --- | --- |
|
|
113
|
+
| `AGENTS.md` | the projection, between `<!-- simt:begin -->` and `<!-- simt:end -->` (renamed from `simt-dev:`; the old markers are still read, and a region migrates on its next write) |
|
|
114
|
+
| `simt.json` | your manifest: which gates to declare, which substitutions to fill (renamed from `simt-dev.json`; the old name is still read, and moves on the next write) |
|
|
115
|
+
| `.cursor/rules/*.mdc`, `.claude/rules/*.md`, `.agents/rules/*.md`, `.github/instructions/*.instructions.md` | one file per rule, written only for the harnesses that read their own directory |
|
|
116
|
+
| `.editorconfig`, `.gitattributes` | baseline regions |
|
|
117
|
+
| `.simt-hooks/` and `core.hooksPath` | the shared dispatcher, fail-closed |
|
|
118
|
+
|
|
119
|
+
Anything outside the markers is yours. simt-dev never edits it and never reverts it.
|
|
120
|
+
|
|
121
|
+
## Platform
|
|
122
|
+
|
|
123
|
+
**macOS and Linux.** The hooks are POSIX `sh`; there is no Windows build and no plan for
|
|
124
|
+
one. `npm i` on Windows fails with npm's `EBADPLATFORM`, which npm will not let a package
|
|
125
|
+
explain — so the answer is here: **use WSL2**, and the gate works normally inside it.
|
|
126
|
+
|
|
127
|
+
A Windows checkout without WSL2 can still read every rule this tool generates, because the
|
|
128
|
+
projection is plain text in `AGENTS.md` and the per-harness rule files. Only the hooks and
|
|
129
|
+
the CI gate need the POSIX host.
|
|
130
|
+
|
|
131
|
+
## How the rules are chosen
|
|
132
|
+
|
|
133
|
+
Detection reads what the repository runs — its dependency manifests, its build files, its
|
|
134
|
+
CI workflows — and resolves that against a registry of capabilities. Resolution is a
|
|
135
|
+
scored ranking over path, keyword, name, capability and stack: no model, no network, no
|
|
136
|
+
guessing, so a pull request can meaningfully diff the answer.
|
|
137
|
+
|
|
138
|
+
**Not every ecosystem has a profile yet.** A Go, Rust, .NET, Ruby, Swift, Dart or Elixir
|
|
139
|
+
repository is detected and gets facts, but it is adopted with the core rules and no gates
|
|
140
|
+
until its gate templates are written. A repository with no gates is a repository with an
|
|
141
|
+
agent and no pre-commit hook — better than one with a hook that runs nothing, but not full
|
|
142
|
+
support, and this README will not pretend otherwise.
|
|
143
|
+
|
|
144
|
+
Every behaviour that is a choice rather than a detail has a numbered record, and the
|
|
145
|
+
records are readable with `simt rules why <id>`. If the tool ever does something you
|
|
146
|
+
did not expect, that command is the shortest path from the symptom to the reason.
|
|
147
|
+
|
|
148
|
+
## Licence
|
|
149
|
+
|
|
150
|
+
Apache-2.0. See [LICENSE](LICENSE).
|
simt_dev-0.2.0/README.md
ADDED
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
# simt-dev
|
|
2
|
+
|
|
3
|
+
Shared agent rules, skills and git hooks for a repository.
|
|
4
|
+
|
|
5
|
+
One command adopts a repository: it reads what the repo actually runs, projects the
|
|
6
|
+
matching rules into the files your agent already reads, and installs a pre-commit hook
|
|
7
|
+
that refuses a commit which breaks a gate that repo can genuinely run.
|
|
8
|
+
|
|
9
|
+
- **Nothing is declared that cannot run.** Every gate is probed against the working tree
|
|
10
|
+
before it is written. A gate whose tool is absent is dropped, with a remedy naming the
|
|
11
|
+
package to install — never silently present, never silently absent.
|
|
12
|
+
- **Nothing an agent reads is written twice.** Each rule goes to exactly one place, chosen
|
|
13
|
+
by what the harness actually reads.
|
|
14
|
+
- **The rules are a projection, not a copy.** They carry markers, so `check` can tell
|
|
15
|
+
drift from a deliberate edit, and `sync` can regenerate.
|
|
16
|
+
- **The tool explains itself.** `rules why` answers "why did I get told this?" from a
|
|
17
|
+
numbered record of the decisions behind the rules, with the rejected alternatives
|
|
18
|
+
attached.
|
|
19
|
+
|
|
20
|
+
## Install
|
|
21
|
+
|
|
22
|
+
Requires **Node >= 22.20.0** (the PyPI install can supply it, see below).
|
|
23
|
+
|
|
24
|
+
```sh
|
|
25
|
+
# pinned, per repository - what CI and a teammate both get
|
|
26
|
+
npm i -D simt-dev@0.2.0
|
|
27
|
+
|
|
28
|
+
# or globally, if you would rather not add a dependency
|
|
29
|
+
npm i -g simt-dev@0.2.0
|
|
30
|
+
|
|
31
|
+
# or with no install at all, for a one-off
|
|
32
|
+
npx -y simt-dev@0.2.0 check
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### From PyPI
|
|
36
|
+
|
|
37
|
+
The same tool, from the same bytes. The wheel carries the exact contents the npm
|
|
38
|
+
tarball carries — the wheel is not a wrapper around `npm install`, so nothing is
|
|
39
|
+
fetched when you install it.
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
pip install simt-dev
|
|
43
|
+
|
|
44
|
+
# and if this machine has no node at all
|
|
45
|
+
pip install "simt-dev[node]"
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
`simt` is the command on both channels. Where node comes from is resolved in
|
|
49
|
+
this order, and the first one that answers wins: `SIMT_DEV_NODE`, the bundled
|
|
50
|
+
node from the `node` extra, then `node` on your `PATH`. If none of them resolve,
|
|
51
|
+
you get a message naming the remedy rather than a placeholder node path.
|
|
52
|
+
|
|
53
|
+
### From Homebrew
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
brew install QuazarMedia/homebrew-tap/simt-dev
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
The formula declares its own `node` dependency, so `brew install` gives you a
|
|
60
|
+
working command on a machine that has never had Node.
|
|
61
|
+
|
|
62
|
+
Pin the version. The tool writes a content digest into the files it generates, and an
|
|
63
|
+
unpinned upgrade changes them under you.
|
|
64
|
+
|
|
65
|
+
## Use
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
simt init # adopt or scaffold this repository (dry-run; --yes to write)
|
|
69
|
+
simt doctor # what this repo is, and whether its config is healthy
|
|
70
|
+
simt check # the gate: projection drift, manifest validity, policy
|
|
71
|
+
simt sync --yes # regenerate the projection
|
|
72
|
+
simt upgrade --yes # move every consumer of this tool to this version
|
|
73
|
+
simt rules why ADR-042 # why a rule says what it says, and what was rejected
|
|
74
|
+
simt compare # what changed across every repository that adopted it
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
`init` and `sync` print a plan and write nothing without `--yes`. Neither commits or pushes.
|
|
78
|
+
|
|
79
|
+
## What it writes
|
|
80
|
+
|
|
81
|
+
| Path | What |
|
|
82
|
+
| --- | --- |
|
|
83
|
+
| `AGENTS.md` | the projection, between `<!-- simt:begin -->` and `<!-- simt:end -->` (renamed from `simt-dev:`; the old markers are still read, and a region migrates on its next write) |
|
|
84
|
+
| `simt.json` | your manifest: which gates to declare, which substitutions to fill (renamed from `simt-dev.json`; the old name is still read, and moves on the next write) |
|
|
85
|
+
| `.cursor/rules/*.mdc`, `.claude/rules/*.md`, `.agents/rules/*.md`, `.github/instructions/*.instructions.md` | one file per rule, written only for the harnesses that read their own directory |
|
|
86
|
+
| `.editorconfig`, `.gitattributes` | baseline regions |
|
|
87
|
+
| `.simt-hooks/` and `core.hooksPath` | the shared dispatcher, fail-closed |
|
|
88
|
+
|
|
89
|
+
Anything outside the markers is yours. simt-dev never edits it and never reverts it.
|
|
90
|
+
|
|
91
|
+
## Platform
|
|
92
|
+
|
|
93
|
+
**macOS and Linux.** The hooks are POSIX `sh`; there is no Windows build and no plan for
|
|
94
|
+
one. `npm i` on Windows fails with npm's `EBADPLATFORM`, which npm will not let a package
|
|
95
|
+
explain — so the answer is here: **use WSL2**, and the gate works normally inside it.
|
|
96
|
+
|
|
97
|
+
A Windows checkout without WSL2 can still read every rule this tool generates, because the
|
|
98
|
+
projection is plain text in `AGENTS.md` and the per-harness rule files. Only the hooks and
|
|
99
|
+
the CI gate need the POSIX host.
|
|
100
|
+
|
|
101
|
+
## How the rules are chosen
|
|
102
|
+
|
|
103
|
+
Detection reads what the repository runs — its dependency manifests, its build files, its
|
|
104
|
+
CI workflows — and resolves that against a registry of capabilities. Resolution is a
|
|
105
|
+
scored ranking over path, keyword, name, capability and stack: no model, no network, no
|
|
106
|
+
guessing, so a pull request can meaningfully diff the answer.
|
|
107
|
+
|
|
108
|
+
**Not every ecosystem has a profile yet.** A Go, Rust, .NET, Ruby, Swift, Dart or Elixir
|
|
109
|
+
repository is detected and gets facts, but it is adopted with the core rules and no gates
|
|
110
|
+
until its gate templates are written. A repository with no gates is a repository with an
|
|
111
|
+
agent and no pre-commit hook — better than one with a hook that runs nothing, but not full
|
|
112
|
+
support, and this README will not pretend otherwise.
|
|
113
|
+
|
|
114
|
+
Every behaviour that is a choice rather than a detail has a numbered record, and the
|
|
115
|
+
records are readable with `simt rules why <id>`. If the tool ever does something you
|
|
116
|
+
did not expect, that command is the shortest path from the symptom to the reason.
|
|
117
|
+
|
|
118
|
+
## Licence
|
|
119
|
+
|
|
120
|
+
Apache-2.0. See [LICENSE](LICENSE).
|