chore(suggestion-bot): move package into rnx-kit

.changeset/clean-towns-leave.md

@@ -0,0 +1,5 @@
+---
+"suggestion-bot": patch
+---
+
+Publish from rnx-kit

docsite/generate.js

@@ -2,6 +2,8 @@
 const fs = require("node:fs");
 const path = require("node:path");
 
+const UTF_8 = /** @type {const} */ ({ encoding: "utf-8" });
+
 const badges = [
   "https://github\\.com/microsoft/rnx-kit/actions/workflows",
   "https://img\\.shields\\.io",
@@ -12,6 +14,7 @@ const badgesRE = new RegExp(
   "g"
 );
 
+const localImagesRE = /!\[(.*?)\]\(\.\/(.*?)\)/g;
 const titleRE = /# @rnx-kit\/(.*)/;
 
 function copyContributing() {
@@ -33,19 +36,22 @@ function generateToolsSidebar() {
       continue;
     }
 
-    const content = fs.readFileSync(manifest, { encoding: "utf-8" });
-    if (JSON.parse(content).private) {
+    if (JSON.parse(fs.readFileSync(manifest, UTF_8)).private) {
       continue;
     }
 
     const output = path.join("docs", "tools", `${pkg}.md`);
     if (!fs.existsSync(output)) {
-      const content = fs.readFileSync(readme, { encoding: "utf-8" });
+      const content = fs.readFileSync(readme, UTF_8);
       fs.writeFileSync(
         output,
         content
           .replace(titleRE, "# $1") // Remove scope from title
           .replace(badgesRE, "") // Remove badges
+          .replace(
+            localImagesRE,
+            `![$1](${path.join("..", "..", path.dirname(readme), "$2")})`
+          )
       );
     }
 

package.json

@@ -51,7 +51,7 @@
     "nx": "patch:nx@npm%3A22.5.4#~/.yarn/patches/nx-npm-22.5.4-3d43ac9c10.patch",
     "oxfmt": "catalog:",
     "oxlint": "catalog:",
-    "suggestion-bot": "^4.0.0",
+    "suggestion-bot": "workspace:*",
     "typescript": "catalog:"
   },
   "resolutions": {

packages/suggestion-bot/.gitignore

@@ -0,0 +1,2 @@
+*.d.ts
+*.d.ts.map

packages/suggestion-bot/README.md

@@ -0,0 +1,136 @@
+# suggestion-bot
+
+[![Build](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml/badge.svg)](https://github.com/microsoft/rnx-kit/actions/workflows/build.yml)
+[![npm version](https://img.shields.io/npm/v/suggestion-bot)](https://www.npmjs.com/package/suggestion-bot)
+
+`suggestion-bot` submits code reviews with suggestions based on your diffs.
+
+![screenshot of code review with suggestions](./docs/screenshot.png)
+
+## Usage
+
+```
+Usage: cli.js [options] [diff | file]
+
+Submit code reviews with suggestions based on your diffs
+
+Arguments:
+  diff | file            the diff or file containing diff to create suggestions from
+
+Options:
+  -h, --help             display this help message
+  -v, --version          display version number
+  -m, --message <msg>    use the specified message as the PR comment
+  -f, --fail             fail if comments could not be posted
+
+Examples:
+  # Submit current changes as suggestions
+  GITHUB_TOKEN=<secret> suggestion-bot "$(git diff)"
+
+  # Alternatively, pipe to suggestion-bot
+  # to avoid escape character issues
+  git diff | GITHUB_TOKEN=<secret> suggestion-bot
+```
+
+If your CI is hosted by Azure DevOps, replace `GITHUB_TOKEN` with
+`AZURE_PERSONAL_ACCESS_TOKEN`.
+
+## Requirements
+
+- Host your code on [GitHub](https://github.com/)
+- `GITHUB_TOKEN` permissions:
+  - `pull-requests: write` — required for creating code reviews
+  - `issues: write` — fallback in case creating a review fails
+
+-- or --
+
+- Host your code on [Azure DevOps](https://dev.azure.com/)
+- An Azure DevOps [personal access token][ado-personal-access-token]
+
+## Recipes
+
+- [Using `suggestion-bot` with GitHub Actions](#using-suggestion-bot-with-github-actions)
+- [Using `suggestion-bot` with `clang-format`](#using-suggestion-bot-with-clang-format)
+- [Using `suggestion-bot` with Prettier](#using-suggestion-bot-with-prettier)
+
+### Using `suggestion-bot` with GitHub Actions
+
+1. Install `suggestion-bot` in your project
+
+   ```sh
+   yarn add suggestion-bot --dev
+   ```
+
+2. Configure your GitHub workflow so `suggestion-bot` can access the
+   `GITHUB_TOKEN` secret provided by GitHub via an environment variable with the
+   same name:
+
+   ```yaml
+   # .github/workflows/build.yml
+   jobs:
+     lint:
+       runs-on: ubuntu-latest
+       steps:
+         - name: Set up Node.js
+           uses: actions/setup-node@v6
+           with:
+             node-version: 24
+         - name: Checkout
+           uses: actions/checkout@v6
+         - name: Install
+           run: yarn
+         - name: ClangFormat
+           if: ${{ github.event_name == 'pull_request' }}
+           env:
+             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+           run: scripts/clang-format-diff.sh | yarn suggestion-bot
+   ```
+
+### Using `suggestion-bot` with `clang-format`
+
+Use [`clang-format-diff`][] to format only changed files:
+
+```sh
+curl --silent --show-error --remote-name https://raw.githubusercontent.com/llvm/llvm-project/release/10.x/clang/tools/clang-format/clang-format-diff.py
+git diff --unified=0 --no-color @^ \
+  | python clang-format-diff.py -p1 -regex '.*\.(cpp|cc|c\+\+|cxx|c|cl|h|hh|hpp|m|mm|inc)' -sort-includes \
+  | yarn suggestion-bot
+```
+
+### Using `suggestion-bot` with Prettier
+
+We must first write a script that pipes [Prettier][]'s output to `diff` so we
+can feed it to `suggestion-bot` later.
+
+```js
+#!/usr/bin/env node
+
+import { spawnSync } from "node:child_process";
+import * as fs from "node:fs";
+import * as prettier from "prettier";
+import suggest from "suggestion-bot";
+
+const diff = process.argv.slice(2).reduce((diff, filepath) => {
+  const source = fs.readFileSync(filepath, { encoding: "utf8" });
+  const { stdout } = spawnSync("diff", ["--unified", filepath, "-"], {
+    input: prettier.format(source, { filepath }),
+    encoding: "utf-8",
+  });
+  return diff + stdout;
+}, "");
+
+suggest(diff);
+```
+
+Save the script somewhere, e.g. `scripts/prettier-diff.mjs`, then invoke it with
+Node:
+
+```sh
+node scripts/prettier-diff.mjs $(git ls-files '*.js')
+```
+
+<!-- References -->
+
+[Prettier]: https://prettier.io/
+[`clang-format-diff`]: https://clang.llvm.org/docs/ClangFormat.html#script-for-patch-reformatting
+[ado-personal-access-token]: https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page

packages/suggestion-bot/cli.js

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+
+import * as fs from "node:fs";
+import * as path from "node:path";
+import { fileURLToPath, URL } from "node:url";
+import { parseArgs } from "node:util";
+import suggest from "./src/index.js";
+
+function printHelp() {
+  console.log(
+    [
+      `Usage: ${path.basename(process.argv[1])} [options] [diff | file]`,
+      "",
+      "Submit code reviews with suggestions based on your diffs",
+      "",
+      "Arguments:",
+      "  diff | file            the diff or file containing diff to create suggestions from",
+      "",
+      "Options:",
+      "  -h, --help             display this help message",
+      "  -v, --version          display version number",
+      "  -m, --message <msg>    use the specified message as the PR comment",
+      "  -f, --fail             fail if comments could not be posted",
+      "",
+      "Examples:",
+      "  # Submit current changes as suggestions",
+      '  GITHUB_TOKEN=<secret> suggestion-bot "$(git diff)"',
+      "",
+      "  # Alternatively, pipe to suggestion-bot",
+      "  # to avoid escape character issues",
+      "  git diff | GITHUB_TOKEN=<secret> suggestion-bot",
+      "",
+      "If your CI is hosted by Azure DevOps, replace `GITHUB_TOKEN` with `AZURE_PERSONAL_ACCESS_TOKEN`.",
+    ].join("\n")
+  );
+}
+
+const { values, positionals } = parseArgs({
+  args: process.argv.slice(2),
+  options: {
+    help: {
+      type: "boolean",
+      short: "h",
+    },
+    version: {
+      type: "boolean",
+      short: "v",
+    },
+    message: {
+      type: "string",
+      short: "m",
+    },
+    fail: {
+      type: "boolean",
+      short: "f",
+    },
+  },
+  allowPositionals: true,
+});
+
+if (values.help) {
+  printHelp();
+} else if (values.version) {
+  const p = fileURLToPath(new URL("package.json", import.meta.url));
+  const manifest = fs.readFileSync(p, { encoding: "utf-8" });
+  const { name, version } = JSON.parse(manifest);
+  console.log(name, version);
+} else {
+  if (positionals.length > 0) {
+    const diffOrFile = positionals[0];
+    const diff = fs.existsSync(diffOrFile)
+      ? fs.readFileSync(diffOrFile, { encoding: "utf-8" })
+      : diffOrFile;
+    suggest(diff, values);
+  } else if (!process.stdin.isTTY) {
+    let data = "";
+    const stdin = process.openStdin();
+    stdin.setEncoding("utf8");
+    stdin.on("data", (chunk) => (data += chunk));
+    stdin.on("end", () => suggest(data, values));
+  } else {
+    process.exitCode = 1;
+    printHelp();
+  }
+}

packages/suggestion-bot/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "suggestion-bot",
+  "version": "4.0.3",
+  "description": "suggestion-bot submits code reviews with suggestions based on your diffs",
+  "keywords": [
+    "code review",
+    "diff",
+    "github",
+    "pull request",
+    "review",
+    "suggestion"
+  ],
+  "homepage": "https://github.com/microsoft/rnx-kit/tree/main/packages/suggestion-bot#readme",
+  "license": "MIT",
+  "author": {
+    "name": "Microsoft Open Source",
+    "email": "microsoftopensource@users.noreply.github.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/rnx-kit",
+    "directory": "packages/suggestion-bot"
+  },
+  "bin": "cli.js",
+  "files": [
+    "cli.js",
+    "src"
+  ],
+  "type": "module",
+  "main": "src/index.js",
+  "exports": {
+    ".": {
+      "default": "./src/index.js"
+    },
+    "./cli.js": {
+      "default": "./cli.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "//build": "We run `tsgo` directly because we don't want to output to `lib`",
+    "build": "yarn clean && tsgo",
+    "clean": "git clean -dfqx -- src/ test/",
+    "format": "rnx-kit-scripts format",
+    "lint": "rnx-kit-scripts lint",
+    "suggest": "suggestion-bot",
+    "test": "rnx-kit-scripts test"
+  },
+  "dependencies": {
+    "@octokit/core": "^7.0.0",
+    "@octokit/plugin-rest-endpoint-methods": "^17.0.0",
+    "azure-devops-node-api": "^15.0.0",
+    "parse-diff": "^0.11.0"
+  },
+  "devDependencies": {
+    "@rnx-kit/scripts": "*",
+    "@rnx-kit/tsconfig": "*",
+    "@types/node": "^24.0.0"
+  },
+  "engines": {
+    "node": ">=20.9"
+  }
+}