@geonosis/verify-arch 1.0.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,161 @@
+# @geonosis/verify-arch
+
+The architecture facts a per-file linter **cannot** see, behind one exit code.
+
+A lint rule is handed one file and asked a question about it. That is enough for most architecture
+invariants and not enough for the ones that hurt most: a module name that must be unique across
+every module, two packages registering the same route, a tier composing something above it once the
+import is resolved, a file nothing reaches. Each of those is a property of the whole graph, and each
+of them fails **silently** in the frameworks where it matters — a last-write-wins map, an inferred
+id, a loader that skips a filename.
+
+```bash
+npx geonosis-verify-arch                      # the repo root, human output, exit 0/1
+npx geonosis-verify-arch --format ratchet     # one ✗ line per finding, for a counter
+```
+
+## The config
+
+`geonosis.verify-arch.json` at the root. No packs, no run — a scanner with nothing enabled would
+report PASS having looked at nothing, so that is a refusal (exit 2), not a pass.
+
+```json
+{
+  "label": "verify:arch",
+  "packs": [{ "pack": "medusa", "options": { "sourceRoots": ["packages", "apps"] } }]
+}
+```
+
+`label` is what the pass and fail lines call themselves; a repo whose script is named `verify:arch`
+keeps its output byte-for-byte by saying so. Two worked configs ship in `examples/`.
+
+## Exit codes
+
+| code | meaning |
+|---|---|
+| 0 | every enabled check ran and found nothing |
+| 1 | findings |
+| 2 | **the run could not measure** — no config, an unknown pack, an unknown format |
+
+2 is its own code on purpose. A scan that never happened is not a clean scan, and a gate that gave
+it the same exit as a clean one would go green for a repo whose config had a typo in it.
+
+## Output
+
+The human format prints one line on success, naming every check that ran and nothing it did not:
+
+```
+verify:arch — PASS (R3.7 serviceName, R3.8 routes, #15442 loader-index, R4.3 query-step, …)
+```
+
+and on failure, on **stderr**, the count and then each finding marked, its message beneath it:
+
+```
+verify:arch — FAIL: 1 violation(s)
+
+✗ [R5.6] packages/plugins/b2b/src/workflows/place-order.ts
+    Mutating step 'place-order' has neither a compensation function nor noCompensation: true — …
+```
+
+The `✗` is part of the contract, not a decoration: a consumer's CI logs, its runbook and its
+reviewers all scan for it, and a drop-in that found the same things and marked none of them would be
+a migration wearing a drop-in's clothes.
+
+The ratchet format prints one line per finding and nothing else:
+
+```
+✗ packages/a/src/modules/one/index.ts R3.7 Module serviceName 'quote' is not globally unique …
+```
+
+which is the shape `@geonosis/ratchet`'s `archViolations` counter matches by default (`^✗`):
+
+```json
+{ "counter": "archViolations", "command": "npx geonosis-verify-arch --format ratchet" }
+```
+
+The message is flattened onto one line, so one finding is one count however long it is.
+
+## Packs
+
+### `medusa`
+
+Ten checks over a Medusa monorepo. Nine of them are also lint rules in
+`@geonosis/oxlint-plugin-biological-architecture`'s `backend-medusa` preset; carrying both is
+deliberate, so one command proves the invariant repo-wide whatever the lint stack is doing.
+
+**Where a scan and its rule disagree, the rule is right.** These checks read source as TEXT, which
+is enough for a token like `createStep(` and not enough for arity or for a statement's extent. R5.6
+decided whether a step had a compensation function by counting top-level commas, and the house
+style closes a multi-line call with a trailing one — so a two-argument step read as three, and the
+check reported 0 for its whole life over five real violations. The scan is the repo-wide backstop;
+the rule is the finer instrument. Both, on purpose.
+
+Two things the text reader knows, because it did not to begin with:
+
+- **a comment is not code.** Comments are blanked to spaces once per file, offsets and newlines
+  intact, and every check matches on that. A comment quoting `updateAiConversations(` used to count
+  as a write, a `// TODO: … subscriberId` used to PASS a subscriber that declared none. The
+  annotations are the exception and keep reading the real source, because they ARE comments;
+- **a step is a workflow source.** A file is read when it declares a workflow **or** a step, so a
+  `workflows/steps.ts` holding nothing but `createStep(` calls reaches R5.2 and R5.6 — which is
+  where a retry class and a compensation function belong, and where the two checks used to be blind.
+
+| id | check | what fails silently without it |
+|---|---|---|
+| `R3.7` | serviceName | two modules claiming one `serviceName` last-win at config merge; a whole module's service stops existing, with no error |
+| `R3.8` | routes | the routes-loader map is last-write-wins across packages, and plugin routes without a namespace segment are collision magnets |
+| `#15442` | loader-index | `ResourceLoader` filters files named `index`, so a resource declared in one is registered only if something else happens to import it |
+| `R4.3` | query-step | two un-named query steps in one workflow body collide in the step-handler map |
+| `R5.1` | route-mutations | a route that writes directly skips the door compensation and retry live behind |
+| `R5.2` | step-retry | `maxRetries` defaults to 0, so a transient failure reverts real state |
+| `R5.3` | route-shadow | two packages on one (path, method): the loader last-wins with no warning |
+| `R5.4` | subscriber-ids | an absent `subscriberId` is inferred from a name, and two that infer alike dedupe each other |
+| `R5.5` | named-when | an unnamed `when()` draws a fresh ULID for its checkpoint every process |
+| `R5.6` | compensation-or-flag | `noCompensation` is inferred from the ABSENCE of a compensate function, so "deliberate" and "forgotten" are one source |
+
+Every repo literal is an option (law 6): `packages` (which directories hold packages, how they are
+named, which are namespace-checked — **empty by default**, so nothing is namespace-checked until a
+repo says so), `workflowFactories`, `stepFactories`, `queryStepCalls`, `mutationPrefixes`,
+`retrySpreads`, `inlineMutationOk`, `routeOverrideOk`, `kinds`, `sourceRoots` / `moduleRoots` /
+`workflowRoots`, `ignoreDirs`, and `checks` to run a subset.
+
+**`kinds` defaults to `["subscriber", "job"]`**, which is what Medusa 2.19 measurably still skips:
+`framework/dist/utils/resource-loader.js:51` filters `index` unless the caller passes `allowIndex`,
+and `framework/dist/workflows/workflow-loader.js:34` is the only caller in the framework that does.
+A repo below 2.19 adds `"workflow"` back; `examples/dielime.verify-arch.json` does.
+
+### `composition-tree`
+
+The tier ladder as a graph fact. `atoms → molecules → compounds → organelles → cells → tissues`; a
+tier composes its own level and below, and only `atoms` and `cells` may not compose their own kind.
+
+| id | check |
+|---|---|
+| `direction` | a file composing a tier above its own, judged by the file the import RESOLVES to |
+| `self-composition` | an atom importing an atom, a cell importing a cell |
+| `orphan` | a classified file no entry point reaches — by BFS, not in-degree, so a cycle of dead files is still dead |
+
+`orphan` is not run **and not claimed in the pass line** until `entryPoints` is configured: with
+nothing to be reachable from, every file is an orphan, and a pass line naming a check that did
+nothing is the failure this package exists to refuse. `tiers`, `aliases`, `extensions` and `roots`
+are options too.
+
+## Writing a pack
+
+```ts
+import type { Pack } from '@geonosis/verify-arch'
+
+export const mine: Pack = {
+  checks: (options) => [{ id: 'X1', label: 'my-check' }],
+  id: 'mine',
+  scan: ({ files, options, root }) => [
+    { file: files[0], message: 'said what is wrong and what to write instead', scanner: 'X1' },
+  ],
+}
+```
+
+`checks` is asked BEFORE `scan` runs, because the pass line has to name what was looked at. `files`
+is every file under the root that survived one shared walk, absolute; `line` on a violation is
+optional and left off when the fact is about the whole file.
+
+Apache-2.0.

package/bin/geonosis-verify-arch.mjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+// Committed, so `pnpm install` can link the bin on a fresh clone — before `pnpm build` has
+// produced dist/. A bin that only exists after a build is a bin that is missing when you need it.
+import '../dist/verify-arch-cli.js'