@tailor-platform/sdk-codemod 0.4.0 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @tailor-platform/sdk-codemod
 
+## 0.4.2
+
+### Patch Changes
+
+- [#1934](https://github.com/tailor-platform/sdk/pull/1934) [`2a3ec7b`](https://github.com/tailor-platform/sdk/commit/2a3ec7b108275410bf5b35d23784b07aa147c5ea) Thanks [@toiroakr](https://github.com/toiroakr)! - Drop the `chalk` dependency in favor of Node's built-in styling, and decide color support per output stream. Diagnostics on stderr now keep their colors when you redirect stdout (`tailor executor list > out.txt`), and stop writing escape codes into the file when you redirect stderr (`tailor deploy 2> log.txt`). `NO_COLOR`, `FORCE_COLOR` and non-TTY detection keep working as before.
+  
+  `@tailor-platform/sdk-codemod`, `@tailor-platform/sdk-plugin-seed` and `@tailor-platform/sdk-plugin-tailordb-erd` now declare the Node and Bun versions they need (`node >=22.15.0`, `bun >=1.2.0`), matching `@tailor-platform/sdk`. Installing them on an older runtime reports the mismatch instead of failing once the CLI runs.
+
+- [#2008](https://github.com/tailor-platform/sdk/pull/2008) [`f2135ab`](https://github.com/tailor-platform/sdk/commit/f2135ab6dd3d130d88803b9829a26024de930ed3) Thanks [@toiroakr](https://github.com/toiroakr)! - Consistently call a TailorDB schema definition a "table" instead of a "type" across the docs, matching the `db.type()` → `db.table()` rename. Also fix three leftover `db.type(...)` code samples in `docs/services/tailordb.md` that should have read `db.table(...)`.
+  
+  Update the `v2/idp-publish-events-rename` codemod registry description to say "tables" instead of "types", matching the same wording fix.
+
+## 0.4.1
+
+### Patch Changes
+
+- [#1957](https://github.com/tailor-platform/sdk/pull/1957) [`a465547`](https://github.com/tailor-platform/sdk/commit/a465547df712ca8c607c1e42cf12c15fe3e830d1) Thanks [@toiroakr](https://github.com/toiroakr)! - Invoke the CLI as `npx @tailor-platform/sdk <command>` wherever an invocation is written for you. `npx` resolves a command it cannot find locally as a package name, so `npx tailor` fell through to an unrelated `tailor` package on npm whenever the SDK was not installed in the project — including in CI, where npm installs without prompting. Omitting the version specifier keeps using the project's installed SDK when there is one.
+  
+  - Setup examples in the README, the quickstart, and the scaffolded project READMEs now use the package-runner form. Bun examples use `bun tailor <command>`, which resolves the local binary without fetching from the registry.
+  - Workflows generated by `tailor setup` use `npx @tailor-platform/sdk` for npm projects and `bun run tailor` for Bun projects. `tailor setup check` reports the template as outdated so existing projects regenerate; re-run `tailor setup` to pick it up.
+  - The `v2/seed-exec-to-cli-plugin` and `v2/sdk-skills-shim` codemods write the package-runner form when the invocation they produce goes through a runner that installs from the registry (`npx`, `bunx`, `pnpm`/`yarn dlx`, `npm exec`). A runner that resolves project binaries, such as `pnpm exec`, still gets the bare `tailor` binary.
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/codemods/v2/sdk-skills-shim/scripts/transform.js

@@ -1,9 +1,10 @@
 import * as path from "pathe";
 //#region codemods/v2/sdk-skills-shim/scripts/transform.ts
-const SHIM_PATTERN = /\btailor-sdk-skills(?:@[^\s'"`]+)?(?:[ \t]+install)?\b(?!-)/g;
-const REPLACEMENT = "tailor skills add";
+const SHIM_PATTERN = new RegExp(`((?<![\\w.-])(?:npx|bunx|(?:pnpm|yarn)[ \\t]+dlx|npm[ \\t]+exec)(?:[ \\t]+-{1,2}[\\w-]*)*[ \\t]+)?\\btailor-sdk-skills(?:@[^\\s'"\`]+)?(?:[ \\t]+install)?\\b(?!-)`, "g");
+const CLI_BINARY = "tailor";
+const CLI_PACKAGE = "@tailor-platform/sdk";
 function replaceShim(value) {
-	return value.replace(SHIM_PATTERN, REPLACEMENT);
+	return value.replace(SHIM_PATTERN, (_match, runner) => `${runner ?? ""}${runner == null ? CLI_BINARY : CLI_PACKAGE} skills add`);
 }
 function transformText(source) {
 	if (!SHIM_PATTERN.test(source)) return null;

package/dist/codemods/v2/seed-exec-to-cli-plugin/scripts/transform.js

@@ -22,8 +22,17 @@ const SOURCE_EXTENSIONS = /* @__PURE__ */ new Set([
 ]);
 const NODE_FLAG_PATTERN = new RegExp(`(${VALUE_NODE_FLAG})(?:=(${ARG_VALUE})|${SPACE}(${ARG_VALUE}))|(${BOOLEAN_NODE_FLAG})`, "g");
 const ENV_FILE_FLAG = /^--env-file(?:-if-exists)?$/;
-const RUNNER_PREFIX_PATTERN = new RegExp(`(?<![\\w.-])(?:pnpm|npm|yarn|bunx|bun|npx)(?:${SPACE}(?:run|exec|dlx))?${SPACE}$`);
+const RUNNER_PREFIX_PATTERN = new RegExp(`(?<![\\w.-])(pnpm|npm|yarn|bunx|bun|npx)(?:${SPACE}(run|exec|dlx))?${SPACE}$`);
 const RUNNER_PREFIX_WINDOW = 64;
+const CLI_BINARY = "tailor";
+const CLI_PACKAGE = "@tailor-platform/sdk";
+const PACKAGE_RUNNER = `npx ${CLI_PACKAGE}`;
+/** Whether a runner installs names it cannot resolve from the project. */
+function installsMissingNames(runner, subcommand) {
+	if (runner === "npx" || runner === "bunx") return true;
+	if (subcommand === "dlx") return true;
+	return runner === "npm" && subcommand === "exec";
+}
 /** Translate the leading `node` flags into flags the CLI command accepts. */
 function carriedOverFlags(nodeFlags) {
 	return [...nodeFlags.matchAll(NODE_FLAG_PATTERN)].filter((match) => match[1] != null && ENV_FILE_FLAG.test(match[1])).map((match) => ` ${match[1]} ${match[2] ?? match[3]}`).join("");
@@ -32,11 +41,12 @@ function carriedOverFlags(nodeFlags) {
 * Rewrite runner invocations. The runner spells validation as its first
 * positional argument, so a consumed `validate` selects the subcommand.
 */
-function rewrite(value, prefix = "") {
+function rewrite(value, inventedHead = CLI_BINARY) {
 	return value.replace(RUNNER_PATTERN, (_match, nodeFlags, _quote, validate, offset) => {
 		const command = validate ? "validate" : "apply";
 		const before = value.slice(Math.max(0, offset - RUNNER_PREFIX_WINDOW), offset);
-		return `${RUNNER_PREFIX_PATTERN.test(before) ? "" : prefix}tailor seed ${command}${carriedOverFlags(nodeFlags)}`;
+		const existing = RUNNER_PREFIX_PATTERN.exec(before);
+		return `${existing ? installsMissingNames(existing[1], existing[2]) ? CLI_PACKAGE : CLI_BINARY : inventedHead} seed ${command}${carriedOverFlags(nodeFlags)}`;
 	});
 }
 function transformText(source) {
@@ -49,7 +59,7 @@ function transformText(source) {
 * node_modules rather than the PATH.
 */
 function transformSourceText(source) {
-	const updated = rewrite(source, "npx ");
+	const updated = rewrite(source, PACKAGE_RUNNER);
 	if (FORK_PATTERN.test(source) && updated.includes("exec.mjs")) return null;
 	return updated === source ? null : updated;
 }
@@ -106,7 +116,7 @@ function reviewFindings(source, filePath, relativePath) {
 		return {
 			file: relativePath,
 			line: index + 1,
-			message: "Replace the fork()-based seed runner call with execSync(\"npx tailor seed apply\"), forwarding env/stdio, and unwind the surrounding await/Promise plumbing.",
+			message: "Replace the fork()-based seed runner call with execSync(\"npx @tailor-platform/sdk seed apply\"), forwarding env/stdio, and unwind the surrounding await/Promise plumbing.",
 			excerpt: lines[index].trim()
 		};
 	});

package/dist/index.js

@@ -9,7 +9,7 @@ import { gte, lt, parse, valid } from "semver";
 import * as fs from "node:fs";
 import { realpathSync } from "node:fs";
 import { Lang, parse as parse$1 } from "@ast-grep/napi";
-import chalk from "chalk";
+import { stripVTControlCharacters, styleText } from "node:util";
 import { structuredPatch } from "diff";
 import picomatch from "picomatch";
 import { execFileSync } from "node:child_process";
@@ -205,13 +205,16 @@ const allCodemods = [
 		examples: [{
 			lang: "sh",
 			before: "npx tailor-sdk-skills",
-			after: "tailor skills add"
+			after: "npx @tailor-platform/sdk skills add"
 		}],
 		prompt: [
 			"The standalone tailor-sdk-skills binary is removed in v2; call the skills add",
 			"subcommand on the main tailor CLI instead. Replace any remaining",
 			"tailor-sdk-skills invocations the codemod did not rewrite with",
-			"`tailor skills add`."
+			"`tailor skills add`, or `npx @tailor-platform/sdk skills add` when the",
+			"invocation runs through a package runner (npx, bunx, pnpm/yarn dlx, npm exec)",
+			"— those resolve a package name, and `npx tailor` reaches an unrelated",
+			"`tailor` package on npm."
 		].join("\n")
 	},
 	{
@@ -680,7 +683,7 @@ const allCodemods = [
 	{
 		id: "v2/idp-publish-events-rename",
 		name: "defineIdp publishUserEvents → publishEvents",
-		description: "Rename the `defineIdp` option `publishUserEvents` to `publishEvents`, matching the field name TailorDB types, resolvers, and workflows already use.",
+		description: "Rename the `defineIdp` option `publishUserEvents` to `publishEvents`, matching the field name that TailorDB tables, resolvers, and workflows already use.",
 		since: "1.5.0",
 		until: "2.0.0",
 		prereleaseUntil: V2_NEXT_11,
@@ -1290,7 +1293,7 @@ const allCodemods = [
 			"  typically fork the runner and await a hand-rolled Promise around",
 			"  `child.on(\"close\", ...)`). The plugin is a CLI-dispatched binary rather",
 			"  than a forkable JS module, so call it synchronously instead —",
-			"  `execSync(\"npx tailor seed apply\", { env, stdio: \"inherit\" })` — keeping",
+			"  `execSync(\"npx @tailor-platform/sdk seed apply\", { env, stdio: \"inherit\" })` — keeping",
 			"  the original `env` and `stdio` forwarding, and unwind the surrounding",
 			"  Promise wrapper (drop the now-unused `await`, and the `async` keyword when",
 			"  nothing else in the function awaits). Note that `execSync` throws on a",
@@ -1518,6 +1521,46 @@ function getApplicableCodemods(fromVersion, toVersion) {
 	return allCodemods.filter((codemod) => gte(fromVersion, codemod.since) && lt(fromVersion, effectiveCodemodBoundary(codemod)) && reachesCodemodBoundary(toVersion, codemod));
 }
 //#endregion
+//#region ../shared/src/color.ts
+const style = (name) => (text) => styleText(name, text, { validateStream: false });
+/**
+* Style functions by name, so call sites read `color.bold(text)`. Styling is
+* always applied; `renderFor` drops it again when the destination stream has no
+* color support. Add a name here when a package needs one that is not listed.
+*/
+const color = {
+	bold: style("bold"),
+	dim: style("dim"),
+	italic: style("italic"),
+	gray: style("gray"),
+	white: style("white"),
+	red: style("red"),
+	green: style("green"),
+	yellow: style("yellow"),
+	cyan: style("cyan"),
+	magenta: style("magenta"),
+	redBright: style("redBright"),
+	greenBright: style("greenBright"),
+	cyanBright: style("cyanBright")
+};
+const supportsColor = (stream) => {
+	const forced = process.env.FORCE_COLOR;
+	if (forced !== void 0) return forced !== "0" && forced !== "false";
+	if (process.env.NODE_DISABLE_COLORS !== void 0) return false;
+	if ((process.env.NO_COLOR ?? "") !== "") return false;
+	if (process.env.TERM === "dumb") return false;
+	return stream.isTTY === true;
+};
+/**
+* Prepares styled text for the stream it is written to.
+* @param stream - Stream the text is written to
+* @param text - Styled text
+* @returns Text with styling removed when the stream has no color support
+*/
+function renderFor(stream, text) {
+	return supportsColor(stream) ? text : stripVTControlCharacters(text);
+}
+//#endregion
 //#region src/runner.ts
 /** Default file patterns for TypeScript files. */
 const DEFAULT_FILE_PATTERNS = ["**/*.{ts,tsx,mts,cts}"];
@@ -1589,6 +1632,9 @@ async function* walkFiles(root, relativeDir = "") {
 		if (entry.isFile()) yield relative;
 	}
 }
+function writeDiffLine(line, style) {
+	process.stderr.write(renderFor(process.stderr, `${style ? style(line) : line}\n`));
+}
 /**
 * Print a colorized unified diff for a single file to stderr.
 * @param filePath - Absolute path to the file
@@ -1598,13 +1644,14 @@ async function* walkFiles(root, relativeDir = "") {
 function printDiff(filePath, before, after) {
 	const patch = structuredPatch(filePath, filePath, before, after, "", "", { context: 3 });
 	if (patch.hunks.length === 0) return;
-	process.stderr.write(`\n${chalk.bold(`--- ${filePath}`)}\n`);
-	process.stderr.write(`${chalk.bold(`+++ ${filePath}`)}\n`);
+	writeDiffLine("");
+	writeDiffLine(`--- ${filePath}`, color.bold);
+	writeDiffLine(`+++ ${filePath}`, color.bold);
 	for (const hunk of patch.hunks) {
-		process.stderr.write(chalk.cyan(`@@ -${hunk.oldStart},${hunk.oldLines} +${hunk.newStart},${hunk.newLines} @@\n`));
-		for (const line of hunk.lines) if (line.startsWith("+")) process.stderr.write(`${chalk.green(line)}\n`);
-		else if (line.startsWith("-")) process.stderr.write(`${chalk.red(line)}\n`);
-		else process.stderr.write(`${line}\n`);
+		writeDiffLine(`@@ -${hunk.oldStart},${hunk.oldLines} +${hunk.newStart},${hunk.newLines} @@`, color.cyan);
+		for (const line of hunk.lines) if (line.startsWith("+")) writeDiffLine(line, color.green);
+		else if (line.startsWith("-")) writeDiffLine(line, color.red);
+		else writeDiffLine(line);
 	}
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tailor-platform/sdk-codemod",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "Codemod runner for Tailor Platform SDK upgrades",
   "license": "MIT",
   "repository": {
@@ -17,7 +17,6 @@
   "type": "module",
   "dependencies": {
     "@ast-grep/napi": "0.45.0",
-    "chalk": "5.6.2",
     "diff": "9.0.0",
     "pathe": "2.0.3",
     "picomatch": "4.0.5",
@@ -29,12 +28,17 @@
   "devDependencies": {
     "@types/node": "24.13.3",
     "@types/picomatch": "4.0.3",
-    "@types/semver": "7.7.1",
-    "eslint-plugin-zod": "4.7.0",
+    "@types/semver": "7.8.0",
+    "eslint-plugin-zod": "4.9.0",
     "oxlint": "1.76.0",
     "tsdown": "0.22.14",
     "typescript": "6.0.3",
-    "vitest": "4.1.10"
+    "vitest": "4.1.10",
+    "@tailor-platform/shared": "^0.0.0"
+  },
+  "engines": {
+    "bun": ">=1.2.0",
+    "node": ">=22.15.0"
   },
   "scripts": {
     "build": "tsdown",