@vaubaan/harness 0.0.0-stage → 1.3.2

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/NOTICE

@@ -0,0 +1,5 @@
+Vaubaan harness (@vaubaan/harness)
+Copyright 2026 Vaubaan
+
+This product is licensed under the Apache License, Version 2.0.
+See the LICENSE file for details.

package/README.md

@@ -1,3 +1,308 @@
-# Temporary Holding Version
+# @vaubaan/harness
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Project conventions as code.**
+
+Write down once how your project is built — its architecture, decisions, quality rules and workflow. Claude Code, Codex and OpenCode read the same conventions, and linters tell you when code and docs drift apart.
+
+[![npm](https://img.shields.io/npm/v/@vaubaan/harness)](https://www.npmjs.com/package/@vaubaan/harness)
+[![CI](https://github.com/vaubaan/harness/actions/workflows/ci.yml/badge.svg)](https://github.com/vaubaan/harness/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
+
+```bash
+npx -y @vaubaan/harness init .
+```
+
+---
+
+## Why
+
+Coding agents are fast, but they don't know your project. So you end up:
+
+- repeating the same instructions in every session;
+- maintaining a `CLAUDE.md`, an `AGENTS.md` and an OpenCode config that slowly disagree;
+- discovering that the agent changed behavior the docs still describe the old way.
+
+The harness puts your conventions where they belong — in versioned docs inside the repo — and renders them into the native format of each agent. One source of truth, every engine, checked on every turn.
+
+## Quick start
+
+Requires Node.js 20 or later.
+
+```bash
+npx -y @vaubaan/harness init .
+```
+
+This renders, for each engine:
+
+```
+AGENTS.md                 # how to work in this project (all engines)
+CLAUDE.md                 # imports AGENTS.md for Claude Code
+.claude/                  # agents, skills, commands, Stop hook
+.codex/  .agents/skills/  # agents, skills, Stop hook
+.opencode/                # agents, commands, Stop hook plugin
+.harness-manifest.json    # what was written, for update/uninstall
+```
+
+All of these are **generated and gitignored**. What you commit is your `docs/` folder. Add these entries to `.gitignore`:
+
+```gitignore
+# generated by @vaubaan/harness
+AGENTS.md
+CLAUDE.md
+.claude/
+.codex/
+.agents/
+.opencode/
+.mcp.json
+.harness-manifest.json
+.harness-overrides/
+# Stop hook retry state and skill reports
+.harness/
+.vaubaan/
+```
+
+`npx @vaubaan/harness check .` tells you if an entry is missing.
+
+Then open your agent and ask it to fill the gaps:
+
+```
+/doc-audit      # what's missing or stale in your docs
+/spec           # write the spec of a subsystem, guided
+/decision       # turn an implicit choice into an ADR
+```
+
+> [!NOTE]
+> `init` regenerates `AGENTS.md` and `CLAUDE.md` at the root. If you already have hand-written ones, move their content into `docs/` (or your README) first.
+
+## How it works
+
+```
+  docs/                           your conventions, versioned in Git
+    │                             spec · decisions · handbook · tests · workflow · quality
+    │
+    ▼  init
+  AGENTS.md  .claude/  .codex/  .opencode/
+    │                             generated for each engine, gitignored
+    │
+    ▼
+  Claude Code · Codex · OpenCode  read the same conventions, write the code
+    │                     ▲
+    │ end of each turn    │ report: what drifted
+    ▼                     │
+  linters (Stop hook) ────┘
+    │
+    ▼
+  CI                              same checks on every pull request
+```
+
+1. **Your docs are the conventions.** A small, fixed layout under `docs/` says what the project does, why it's built that way, and how it actually works today.
+2. **The harness renders one pivot format into each engine's native layout.** Agents, skills and commands are written once and land where each engine looks for them.
+3. **Linters keep docs and code in sync.** At the end of each agent turn, a Stop hook runs them; if something drifted, the agent gets the report and fixes it before handing back. The same linters run in CI.
+
+The work order every agent follows is: **understand the docs → fill the gaps → code → update the docs → commit.**
+
+## Your docs
+
+```
+README.md                          # pitch, quick start
+docs/
+  spec/<subsystem>.md              # what and why — tech-agnostic
+  decisions/<slug>.md              # ADRs: Context, Decision, Consequences, Rejected alternatives
+  handbook/<feature>.md            # how it actually works today (tracks the code it describes)
+  tests/integration-tests.md       # core scenarios
+  tests/e2e-tests.md
+  workflow/coding-workflow.md      # CI, branches, PRs, release
+  quality/code-quality.md          # optional — your code-quality rules
+  skills/*.skill.md                # optional — your own domain skills
+```
+
+Handbooks and test plans declare the code they describe in a `tracks:` frontmatter field. When that code changes and the doc doesn't, the drift linter notices.
+
+Every file has a template and a writer skill, so you rarely start from a blank page.
+
+## What's included
+
+**4 agents** — rendered side by side; you pick one when you start a session.
+
+| Agent | Role |
+|---|---|
+| `planning` | Turns a request into an implementation plan; drafts missing specs and test plans first. |
+| `coding` | Implements a feature in doc-first order: docs, code, doc update, commit. |
+| `review` | Audits a diff or codebase and returns an actionable verdict, including doc gaps. |
+| `merge` | Merges (PR + tag) and makes sure a final ADR records the decision. |
+
+**9 skills**, each with a slash command:
+
+| Command | Skill | What it does |
+|---|---|---|
+| `/doc-audit` | `doc-audit` | Audits completeness and freshness of all doc pillars. |
+| `/drift` | `drift-detector` | Finds where docs no longer match the code. |
+| `/spec` | `spec-writer` | Guided writing of a tech-agnostic spec. |
+| `/decision` | `decision-record-writer` | Writes an ADR, spotting implicit decisions in your diff. |
+| `/handbook` | `handbook-writer` | Documents how a feature is actually implemented. |
+| `/test-plan` | `test-plan-writer` | Keeps integration and e2e test plans up to date. |
+| `/workflow` | `workflow-writer` | Documents CI, environments, PR process, branches, release. |
+| `/readme` | `readme-writer` | Keeps the README in sync with the code. |
+| `/clean-code` | `clean-code-guardian` | Reviews code quality against your `docs/quality/` rules. |
+
+**14 linters** — mechanical checks, fast enough to run on every turn.
+
+<details>
+<summary>See the list</summary>
+
+| Linter | Checks |
+|---|---|
+| `readme-presence`, `readme-sections` | `README.md` exists and has a title and a quick start. |
+| `doc-layout`, `cardinal-files` | The `docs/` folders and required files exist. |
+| `spec-has-content`, `spec-tech-agnostic` | Specs exist and don't name frameworks or vendors. |
+| `decision-schema` | Each ADR has its four sections. |
+| `adr-no-tracks`, `orphan-decisions` | ADRs stay frozen and are referenced somewhere. |
+| `frontmatter-tracks`, `tracks-drift` | Tracked paths exist; docs aren't older than the code they track. |
+| `cross-links` | Links between docs resolve. |
+| `gitignore-harness` | Generated files stay out of Git. |
+| `quality-schema` | `docs/quality/code-quality.md` has its sections, if you use it. |
+
+</details>
+
+## Engine support
+
+| | Claude Code | Codex | OpenCode |
+|---|---|---|---|
+| Agents | `.claude/agents/` | `.codex/agents/*.toml` | `.opencode/agents/` |
+| Skills | `.claude/skills/` | `.agents/skills/` | reuses the above |
+| Slash commands | ✓ | — invoke skills by name | ✓ |
+| Stop hook | `.claude/settings.json` | `.codex/hooks.json` | plugin (1.x and 2.x) |
+| Hook runs after | workspace trust | project trust **and** hook approval (`/hooks`) | — |
+| MCP (opt-in) | `.mcp.json` | `.codex/config.toml` | `.opencode/opencode.json` |
+
+Only use one engine? `--engines=claude-code` (or `codex-cli`, `opencode`, comma-separated).
+
+## Adopting it on an existing project
+
+You don't have to write all the docs on day one.
+
+- **See where you stand:** `npx @vaubaan/harness lint` lists what's missing, with the skill that fixes each item.
+- **Let the agent do the first pass:** `/doc-audit`, then `/spec`, `/handbook` and `/decision` on the parts you touch.
+- **Pause the Stop hook while you bootstrap:** `HARNESS_LINT_DISABLE=1`, or install without it: `init . --no-stop-hook`. When a retry makes no progress, the hook lets the turn end.
+- **Back out anytime:** `npx @vaubaan/harness uninstall .` removes what `init` wrote. Your own files, and config entries you edited, are left in place.
+
+## Use it in CI
+
+```yaml
+# .github/workflows/docs.yml
+name: docs
+on: [push, pull_request]
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      - run: npx -y @vaubaan/harness lint
+```
+
+`lint` exits non-zero on errors. Use `--format json` for machine-readable output and `--pillar <name>` to check a single pillar.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `init <dir>` | Render the harness into a project. |
+| `update [dir]` | Re-render with the installed version, keeping your settings. `--dry-run --json` previews. |
+| `uninstall <dir>` | Remove what `init` wrote, leaving your own files in place. |
+| `lint` | Run the linters. |
+| `check <dir>` | Quick layout check: doc folders and `.gitignore`. |
+| `render --out <dir>` | Preview the render somewhere harmless. |
+
+Run them with `npx @vaubaan/harness <command>`. If the package is installed in the project (`npm i -D @vaubaan/harness`), that uses the local version; otherwise `npx` downloads it (`-y` skips the confirmation prompt).
+
+## Configuration
+
+<details>
+<summary><b>Ignore paths in lint</b></summary>
+
+`node_modules/` and `dist/` are ignored by default. Add more in `.harnessrc.json` (or `.harnessrc`, `.harnessrc.yaml`, `harness.config.js`, or a `"harness"` key in `package.json`):
+
+```json
+{
+  "lint": {
+    "ignore": ["vendor/**", "packages/legacy/**"]
+  }
+}
+```
+
+Patterns use [fast-glob](https://github.com/mrmlnc/fast-glob#pattern-syntax) syntax and add to the defaults.
+
+</details>
+
+<details>
+<summary><b>Local overrides</b></summary>
+
+Try a custom agent, skill or command without forking, in a gitignored `.harness-overrides/` folder:
+
+```
+.harness-overrides/
+  agents/      *.agent.md
+  skills/      *.skill.md
+  commands/    *.cmd.md
+  disable.yaml           # disable: [readme-writer, workflow-writer]
+```
+
+Overrides are personal and disposable. Skills meant for the whole team go in `docs/skills/`, which is versioned. See [overrides loading](./docs/handbook/overrides-loading.md).
+
+</details>
+
+<details>
+<summary><b>MCP servers</b></summary>
+
+None by default. `init . --with-mcp=context7` adds [Context7](https://github.com/upstash/context7) (library documentation) to each engine's MCP config. Codex only loads project config in a trusted project.
+
+</details>
+
+<details>
+<summary><b>Updating</b></summary>
+
+```bash
+npm i -D @vaubaan/harness@latest
+npx @vaubaan/harness update . --dry-run --json   # preview
+npx @vaubaan/harness update .
+```
+
+`update` keeps your engines, hook preference, MCP entries and hook edits. Generated files you modified are reported instead of overwritten: move the change to `.harness-overrides/`, or keep the file as yours with `--preserve AGENTS.md`. A backup is written outside the project before any change. Details: [updating a project](./docs/handbook/project-update.md).
+
+</details>
+
+## FAQ
+
+**Does it phone home?** No. No telemetry, no daemon. It writes files and runs linters locally.
+
+**Do I need all three engines?** No. Everything is rendered for all three by default because it costs nothing, but `--engines` narrows it.
+
+**Can I write my docs in another language?** Prose, yes. The linters look for English section headings (`## Context`, `## Decision`…); French headings are also accepted.
+
+**Does it work in a monorepo?** Run it at the repository root and use `lint.ignore` for sub-projects you don't want checked.
+
+**Is this tied to Vaubaan?** No. Vaubaan builds it and uses it on its own projects — including this one, which is harnessed by itself.
+
+## Documentation
+
+- [Spec](./docs/spec/coding-agent-harness.md) — what the harness is and why
+- [Decisions](./docs/decisions/) — architecture choices and their alternatives
+- [Handbook](./docs/handbook/) — how each part works today
+- [Test plans](./docs/tests/) and [workflow](./docs/workflow/coding-workflow.md)
+- [Changelog](./CHANGELOG.md)
+
+## Contributing
+
+Issues and pull requests are welcome. Setup, conventions and the doc-first workflow are in [CONTRIBUTING.md](./CONTRIBUTING.md); security reports go through [SECURITY.md](./SECURITY.md).
+
+```bash
+git clone https://github.com/vaubaan/harness.git && cd harness
+npm ci && npm run ci
+```
+
+## License
+
+[Apache 2.0](./LICENSE) — see [NOTICE](./NOTICE).