@vintasoftware/pr-review-canvas 0.1.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 2026 Vinta Software
+
+   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,192 @@
+# PR Review Canvas
+
+Review a GitHub pull request canvas: layers by topic, with grouped diffs, attention points, comments,
+and an optional AI chat. Everything runs locally at **http://localhost:3010**.
+
+## Quick start: author generates, reviewers review
+
+### Author side
+
+Each PR author should generate a canvas and attach its zip to the **PR description** before
+requesting review. After the project setup below, run the installed skill in Claude Code or Codex:
+
+```text
+/pr-review-canvas 123
+```
+
+Replace **123** with your PR number. The skill reads the PR, generates and validates the canvas,
+then returns a local review URL and the exported zip's path. Open the URL to check the canvas.
+
+The skill ends with upload instructions. If you're happy with the produced canvas, edit the PR
+description in GitHub's UI, drag the zip into the editor, wait for the upload to finish, and save.
+Uploading the zip is a manual browser step due to restrictions of GitHub's API.
+
+### Review side
+
+Start the canvas server from the project you want to review:
+
+```bash
+pr-review serve
+```
+
+Open **http://localhost:3010**, enter a PR number, and leave the terminal running while you
+review. Stop the server with **Ctrl+C**. To use another port, run `pr-review serve --port 3011`.
+
+## Install
+
+You need Node.js 22+, npm, Git, and [GitHub CLI](https://cli.github.com).
+Sign in to GitHub with `gh auth login`.
+
+Install the command globally once, for use in any project:
+
+```bash
+npm install -g @vintasoftware/pr-review-canvas
+```
+
+The npm installation command will be available after the first release.
+
+## Set up a project
+
+```bash
+cd /path/to/your-project
+pr-review install-skill
+pr-review doctor --all-checks
+```
+
+`install-skill` sets up **both Claude Code and Codex** in one command: `.claude/skills/pr-review-canvas`
+and `.agents/skills/pr-review-canvas`, respectively. It also adds `.pr-review/settings.yml` to the
+project's `.gitignore`. Restart your coding agent if the skill
+does not appear. Repeat this setup for each project you want to review.
+
+`doctor` checks Git, your GitHub remote, the GitHub CLI and its login, write access to the local
+canvas directory, and whether the skill is installed. It prints a JSON report with a result for
+each check and suggested fixes for failures. `doctor --all-checks` also checks that `acpx` runs and
+reports its version. Exit code `0` means all checks passed.
+
+### Optional: AI Chat install
+
+To ask questions about a PR inside the canvas, install `acpx` globally:
+
+```bash
+npm install -g acpx
+acpx --version
+pr-review doctor --all-checks
+```
+
+Install and sign in to either Claude Code or Codex on the same machine. Start (or restart)
+the review server, then choose your agent in **settings**. The chat uses that agent's account.
+You can review canvases without installing `acpx`.
+
+## Advanced usage
+
+See the [CLI and configuration reference](docs/reference.md) for detailed options and troubleshooting.
+
+### Export an existing canvas
+
+```bash
+pr-review export --pr 123
+```
+
+The command prints the zip's absolute path. Both `export` and `publish` save locally; neither
+uploads an attachment to GitHub.
+
+The zip contains `manifest.json` and `review.json`: the PR description, file/hunk metadata,
+and generated review notes. Check these before sharing, since they can contain private
+information. Each reviewer gets source diffs from their own clone; chat history stays local.
+
+### Update an outdated canvas
+
+After pushing new commits, run `/pr-review-canvas 123` again. To rewrite a canvas for the
+same commit, run `/pr-review-canvas 123 --force`. Replace the zip in the PR description.
+Reviewers click **refresh**.
+
+When the saved canvas describes a different PR head, **Canvas is outdated** appears at
+the top. You can still read the older canvas, with its commit and distance shown; posting
+from that view is disabled. Click **refresh** to check GitHub for changes and a newer zip.
+
+## Configuration
+
+### User-local preferences
+
+Your appearance and AI Chat preferences are saved in `.pr-review/settings.yml` in your local
+project directory. This file is ignored by Git, so each teammate can use their own settings.
+
+Use **skin** and **theme** in the header to change the appearance.
+
+For AI Chat, open **settings**, choose Claude Code or Codex, and optionally enter a model ID.
+Leave the model blank to use the agent's default. You can also adjust the reply timeout and
+maximum turns. Click **Test agent** to check the connection, then **save**.
+
+Switching agents starts a new thread and keeps earlier threads. Server flags `--agent` and
+`--model` override your saved chat preferences for that run.
+
+### Shared project settings
+
+Edit `pr-review.config.yml` at the repository root and commit it to share settings with your team.
+It controls review rules, layers, generation mode, test file patterns, prompt templates, and
+whether AI Chat is enabled. The settings dialog displays this configuration; edit the file to
+change it. See the [configuration reference](docs/reference.md#project-config).
+
+Canvas generation follows the [skill's model rules](skills/pr-review-canvas/SKILL.md#model-choice).
+
+### Project prompt templates
+
+A global install reads `pr-review.config.yml` from the project root. Use its `prompts`
+map to replace individual templates with files you keep in the project's Git repository:
+
+```yaml
+prompts:
+  generation-format.md: review-prompts/generation-format.md
+  generation-surfacing.md: review-prompts/generation-surfacing.md
+  chat-seed.md: review-prompts/chat-seed.md
+```
+
+To start from the installed templates (for an npm global install):
+
+```bash
+mkdir -p review-prompts
+cp "$(npm root -g)/@vintasoftware/pr-review-canvas/prompts/"*.md review-prompts/
+```
+
+Edit the copies and add entries only for the templates you want to override. Commit
+`pr-review.config.yml` and the referenced files together. Paths resolve from the project
+root, including when running from a subdirectory or using `--repo`. Absolute paths also
+work for personal templates shared across projects. Omitted entries use the installed
+package's defaults; a configured file that cannot be read causes an error.
+
+The six supported keys are `generation-format.md` (schema and output rules),
+`generation-strict.md` and `generation-surfacing.md` (mode wrappers),
+`quality-standards.md` (bundled code standards), `layers-default.md` (taxonomy prose),
+and `chat-seed.md` (the opening AI Chat instructions). `generation.mode` still selects
+the wrapper. The rulebook still takes precedence over code standards, and configured
+layers and caps still supply the template data.
+
+Each file replaces a whole template. Preserve its `{{TOKENS}}`, including `{{FORMAT}}`
+in generation wrappers, to keep the generated context and output contract. Unknown
+generation tokens fail rendering. Chat leaves unknown tokens as written. Prompt edits
+do not change the output schema or validation rules enforced by the tool. Overrides
+remain yours across tool upgrades; compare them with new bundled templates when upgrading.
+
+Run `prepare` again to apply generation edits (use `--force` for an existing canvas).
+Restart the server after changing the config; chat template edits apply to new threads.
+
+## Contributing
+
+In a clone of this tool, use pnpm for the shared lockfile and development checks:
+
+```bash
+corepack pnpm --version
+corepack pnpm install --frozen-lockfile
+corepack pnpm exec playwright install --with-deps chromium
+corepack pnpm verify
+corepack pnpm start --repo /path/to/your-project
+```
+
+Run `pr-review --help` for CLI commands. Local data goes in the project's `.pr-review/`
+directory; keep it out of Git.
+
+See [Publishing to npm](docs/publishing.md) for release checks and first-publish instructions.
+
+## License
+
+Licensed under the [Apache License 2.0](LICENSE).

package/bin/pr-review.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+import { tsImport } from 'tsx/esm/api'
+
+const cli = await tsImport('../src/cli.ts', import.meta.url)
+process.exitCode = await cli.main(process.argv.slice(2))