@readme/cli 0.2.0 → 0.3.0

package/bin/git-format.js

@@ -0,0 +1,80 @@
+#! /usr/bin/env node
+
+// Vendored copies of the two files this CLI reads from readmeio/git-format.
+// Checked into the repo so installs do not fetch a git dependency (npm 12
+// refuses those by default). `schemas:check` fails when upstream main drifts;
+// `schemas:write` refreshes the copies.
+import { createHash } from 'node:crypto';
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+const REPO = 'https://raw.githubusercontent.com/readmeio/git-format/main';
+
+const files = [
+  {
+    filePath: 'vendor/git-format/frontmatter.schema.json',
+    url: `${REPO}/frontmatter.schema.json`,
+    json: true,
+  },
+  {
+    filePath: 'vendor/git-format/CLAUDE.md',
+    url: `${REPO}/CLAUDE.md`,
+    json: false,
+  },
+];
+
+function getHash(data) {
+  const text = typeof data === 'string' ? data : JSON.stringify(data);
+  return createHash('sha1').update(Buffer.from(text, 'utf8')).digest('hex');
+}
+
+// `writeFile` does not create missing parents. `schemas:write` is how those
+// files get restored, so the directory has to be created first.
+async function writeVendored(filePath, contents) {
+  await fs.mkdir(path.dirname(filePath), { recursive: true });
+  await fs.writeFile(filePath, contents);
+}
+
+async function refresh() {
+  const isUpdate = process.argv.includes('--update');
+
+  try {
+    await Promise.all(
+      files.map(async file => {
+        const res = await fetch(file.url);
+        if (!res.ok) throw new Error(`Received ${res.status} when attempting to fetch ${file.url}`);
+
+        if (file.json) {
+          const rawFile = await res.json();
+          if (isUpdate) {
+            await writeVendored(file.filePath, JSON.stringify(rawFile));
+          } else {
+            const currentData = JSON.parse(await fs.readFile(file.filePath, 'utf-8'));
+            if (getHash(currentData) !== getHash(rawFile)) {
+              throw new Error(`${file.filePath} is outdated! Run \`npm run schemas:write\` to update.`);
+            }
+          }
+          return;
+        }
+
+        const rawFile = await res.text();
+        if (isUpdate) {
+          await writeVendored(file.filePath, rawFile);
+        } else {
+          const current = await fs.readFile(file.filePath, 'utf-8');
+          if (getHash(current) !== getHash(rawFile)) {
+            throw new Error(`${file.filePath} is outdated! Run \`npm run schemas:write\` to update.`);
+          }
+        }
+      }),
+    );
+
+    console.log(isUpdate ? 'git-format files updated!' : 'git-format files are up-to-date!');
+    process.exit(0);
+  } catch (e) {
+    console.error(e.message);
+    process.exit(1);
+  }
+}
+
+await refresh();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readme/cli",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "The ReadMe CLI",
   "keywords": [
     "cli",
@@ -36,8 +36,10 @@
   "scripts": {
     "build:gha": "ncc build src/gha.js -o dist-gha --external @readme/markdown",
     "format": "npx oxlint --fix && npx oxfmt --write",
-    "lint": "npx oxlint && npx oxfmt --check .",
+    "lint": "npx oxlint && npx oxfmt --check . && npm run schemas:check",
     "pretest": "npm run lint",
+    "schemas:check": "./bin/git-format.js",
+    "schemas:write": "./bin/git-format.js --update && npx oxfmt --write vendor/git-format/frontmatter.schema.json",
     "start": "node bin/readme.js",
     "test": "vitest run"
   },
@@ -45,14 +47,13 @@
     "@anthropic-ai/claude-agent-sdk": "^0.3.207",
     "@readme/markdown": "^13.3.0",
     "@readme/openapi-parser": "^5.5.0",
-    "@readmeio/git-format": "git+https://github.com/readmeio/git-format.git",
     "ajv": "^8.18.0",
     "chalk": "^5.4.1",
     "cli-spinners": "^3.4.0",
     "commander": "^13.1.0",
     "js-yaml": "^5.5.0",
     "log-update": "^8.0.0",
-    "next": "^15.0.0",
+    "next": "^15.5.29",
     "oas-normalize": "^15.7.1",
     "ora": "^9.3.0",
     "react": "^18.3.1",
@@ -68,6 +69,24 @@
     "oxlint": "^1.89.0",
     "vitest": "^5.0.5"
   },
+  "overrides": {
+    "@graphql-tools/executor-graphql-ws": {
+      "ws": "8.22.1"
+    },
+    "@graphql-tools/executor-legacy-ws": {
+      "ws": "8.22.1"
+    },
+    "cosmiconfig": {
+      "js-yaml": "4.3.2"
+    },
+    "express-rate-limit": {
+      "express": "4.22.3"
+    },
+    "graphql-config": {
+      "minimatch": "4.2.6"
+    },
+    "uuid": "^11.1.1"
+  },
   "engines": {
     "node": ">=22"
   }

package/src/commands/import.js

@@ -18,6 +18,7 @@ import {
   organizeFromScratchPrompt,
   organizeFromScratchOutputSchema,
 } from '../prompts/index.js';
+import { makeContainment, PathEscapeError } from '../utils/containment.js';
 import { analyzeLlmsTxt } from '../utils/llms.js';
 import { parseFrontmatter, toFrontmatter } from '../utils/markdown.js';
 import * as styles from '../utils/styles.js';
@@ -1322,6 +1323,11 @@ export async function runAgent({ userPrompt, systemPrompt, cwd, model }) {
 
 function makeStagingGuard(stagingDir) {
   const absStaging = path.resolve(stagingDir);
+
+  // `path.relative` is lexical, so a symlink planted in the staging dir
+  // (or a path whose existing ancestor is one) would look inside it while
+  // the Write tool follows the link. Same containment check as oas:sync.
+  const assertContained = makeContainment(stagingDir, { label: 'staging directory' });
   const WRITE_TOOLS = new Set(['Write', 'Edit', 'NotebookEdit', 'MultiEdit']);
 
   return async (toolName, input) => {
@@ -1330,10 +1336,13 @@ function makeStagingGuard(stagingDir) {
     if (typeof fp !== 'string' || !fp) {
       return { behavior: 'deny', message: `${toolName}: missing file_path` };
     }
+
     const abs = path.isAbsolute(fp) ? path.resolve(fp) : path.resolve(absStaging, fp);
-    const rel = path.relative(absStaging, abs);
-    const inside = rel && !rel.startsWith('..') && !path.isAbsolute(rel);
-    if (!inside) {
+
+    try {
+      assertContained(abs);
+    } catch (err) {
+      if (!(err instanceof PathEscapeError)) throw err;
       styles.warning(`Blocked ${toolName} outside staging: ${fp}`);
       return {
         behavior: 'deny',