@geonosis/doctor 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,167 @@
+# @geonosis/doctor
+
+Five questions a version bump is not finished until something has asked. The first four are ways
+enforcement has reported **green while measuring nothing** — in real repos, for weeks at a time.
+The fifth asks whether the gate is still there at all.
+
+```bash
+pnpm add -D @geonosis/doctor
+npx geonosis-doctor
+```
+
+Run it **after every bump** and **in CI**. It exits 1 when any line is a FAIL, 2 when the run could
+not be made at all.
+
+```
+geonosis-doctor [--root <dir>] [--json] [--strict] [--baseline-against [<ref>]] [--oxlint <path>]
+```
+
+## The five checks
+
+### `loaded` — declared ≠ loaded
+
+oxlint resolves a `jsPlugins` specifier from the **config file's** directory, not the working
+directory. A nested `apps/<ws>/node_modules/@scope/plugin` left behind by a per-workspace install
+therefore runs while every `package.json` and the lockfile say a different version. One consumer
+measured a whole bug report against 0.3.0 on a repo pinned to 0.4.0, and nothing in either repo
+could have told them.
+
+So for every `.oxlintrc.json` in the tree that names a `@geonosis/*` plugin, this resolves that
+plugin **from the config's own directory**, imports it, reads `meta.version`, and compares it to
+the version the nearest manifest up from there declares:
+
+```
+OK   apps/web/.oxlintrc.json: @geonosis/… loaded 0.6.0 = declared 0.6.0 (apps/web/package.json)
+FAIL apps/web/.oxlintrc.json: @geonosis/… loaded 0.3.0, declared 0.6.0 (apps/web/package.json)
+     — a nested copy at apps/web/node_modules/@geonosis/…
+```
+
+It then lists every copy **resolution** reaches, one question per workspace directory. Never a
+`find`: on pnpm the entries under `node_modules/@scope/` are symlinks into `.pnpm/`, which keeps
+every version ever installed, so counting directories answers 7 on a tree that is perfectly correct
+and 0 with the store excluded. Resolution is the only form of the question that is true on bun,
+npm and pnpm alike.
+
+A declared range this check cannot read is a **FAIL**, not a pass. A version it cannot judge is a
+refusal.
+
+### `exercised` — enabled ≠ exercised
+
+A rule at `"error"` over a tree with no violation of it, and a rule at `"error"` that can never
+fire at all, produce the identical green. One consumer ran `no-raw-html-atoms` that way for months
+with 136 raw elements in the tree.
+
+For each config, every rule it enables is run against the **corpus the loaded plugin ships**, under
+that config's own options — because the options are usually where the reach went:
+
+```
+OK   .oxlintrc.json: 31 enabled, 31 exercised
+FAIL .oxlintrc.json: 2 enabled rules fire nowhere in the corpus: bio/no-brand-names, bio/…
+```
+
+The reach engine is [`@geonosis/lint-parity`](https://www.npmjs.com/package/@geonosis/lint-parity)'s
+`corpusOf`, and the corpus is found on the **loaded** plugin, at `corpus/manifest.json`. A plugin
+that ships no corpus is a SKIP: it never claimed to be evidence about anything.
+
+A rule enabled without the options it needs makes oxlint refuse. That refusal is reported as the
+finding — with the sentence naming the rule, which takes a second run to obtain (see below).
+
+#### The corpus a shipped one cannot be
+
+Three rules cannot be answered by the plugin's corpus at all, because their reach is a **repo's own
+vocabulary**: `layer-walls` fires on the layers this config declares, `no-brand-names` on the brands
+it names, `plugin-route-namespaced` on its package root — and the shipped corpus says `acme` and
+`layers/core`. Both source repos hit exactly this: dielime's `no-brand-names` and during.day's
+`step-opens-its-own-cell` read as firing nowhere in trees that enforce them correctly.
+
+So a repo may ship its own, and point at it:
+
+```jsonc
+// geonosis.json
+{ "doctor": { "corpus": "lint-corpus" } }
+```
+
+The directory holds fixtures in **this** repo's vocabulary, at paths that mirror this repo's own
+(the layer patterns are path patterns), and a `manifest.json` naming exactly the rules it is
+evidence about. A rule is exercised when it fires in **either** corpus. Two refusals guard it: a
+declared corpus that is not there is a FAIL, and a rule the repo's own manifest names that fires
+nowhere in it is a FAIL — claiming evidence and shipping none is worse than claiming none.
+
+It is read for the config beside `geonosis.json` and no other: a nested config sets different
+options, and asking one config's fixtures to answer for another's would report firing nowhere.
+
+### `baseline` — a number that may only shrink, against another ref
+
+A ratchet lowers its **own** baseline whenever a number shrinks; that is what locks a win in, and it
+is also what lets a branch write any number it likes and stay green on every gate it runs. Nothing
+inside one checkout can tell the difference. Only the same file at another ref can:
+
+```bash
+geonosis-doctor --baseline-against          # origin/main, if the repo has one
+geonosis-doctor --baseline-against main
+```
+
+```
+FAIL gate-baseline.json: oxlintErrors 12 → 135 (grew against origin/main)
+```
+
+**Off unless asked for.** It is the only check that runs git, and this tool gets pointed at repos
+other people are working in.
+
+### `runner` — an exit code is not a verdict
+
+`@cloudflare/vitest-pool-workers` exited 0 over suites it had just reported as failing, for weeks,
+in a consumer, so every gate that trusted the status read green over red. A workspace whose `test`
+script runs vitest or `bun test` without asking for a JSON report, and which no `testFailures`
+counter in report mode covers, gets a WARN. `--strict` makes it a FAIL.
+
+### `drift` — the gate that is no longer there
+
+The other four ask whether a gate measures what it names. This one asks whether it still runs.
+
+| Line | Verdict | What it is |
+|---|---|---|
+| `.github/workflows/*.yml` | FAIL | a job or step switched off by a condition that can never be true. One consumer carried 90 tests, a pgvector container and an E2E suite and ran none of it, the disablement documented as "TEMPORARY" in a comment. It is "never downgrade a rule", one level up |
+| test files | FAIL | a `*.test.*` file with no `test` script in any workspace from it up to the root. A monorepo that runs one vitest over the whole tree has no orphan in it, and this says so |
+| plugin directories | FAIL | a manifest directory under the roots `no-unregistered-plugin-dir` names that the registry never mentions. SKIP when the rule is not configured — the roots are the repo's, read from the rule it already wrote, never a list invented here |
+| the law | WARN | its measured length against `geonosis.json` → `law.maxLines` (200 by default). dielime is 382, during.day 1,104 |
+| `.claude/settings.json` | WARN | nothing installs the kit's plugin, so the gates run and the method does not (D-041) |
+| `geonosis.json` blocks | WARN | a block whose package is not installed — nothing reads it — or an installed package with no block, running on defaults nobody chose |
+
+## What `--format=unix` does not tell you
+
+Measured on oxlint 1.80: a JS plugin rule that throws from `create()` is reported **once per file**,
+and the unix formatter renders each of those as
+
+```
+:0:0:  [Warning]
+```
+
+— no path, no rule id, no sentence. The default formatter carries the whole message, including
+which rule refused and which option it is missing. So when a config's corpus run is refused, this
+tool asks oxlint a second time, over one trivial file, in the format that answers.
+
+A tool that only ever read `--format=unix` would report that something went wrong and be unable to
+say what.
+
+## `--json`
+
+The whole report, for a CI step to read:
+
+```json
+{
+  "counts": { "FAIL": 1, "OK": 12, "SKIP": 2, "WARN": 0 },
+  "findings": [{ "check": "loaded", "message": "…", "subject": "apps/web/.oxlintrc.json", "verdict": "FAIL" }],
+  "ok": false,
+  "root": "/repo"
+}
+```
+
+## What it does not depend on
+
+Not the rule plugin. This tool asks which plugin a config loads; a copy of that plugin in its own
+dependency tree would be one more copy for the question to be wrong about. It depends on
+`@geonosis/lint-parity` for the reach engine and on nothing else, and the kit's own `layer-walls`
+config holds that wall.
+
+Apache-2.0.

package/bin/geonosis-doctor.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/doctor-cli.js'