@tailor-platform/sdk-codemod 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @tailor-platform/sdk-codemod
 
+## 0.5.0
+
+### Minor Changes
+
+- [#2023](https://github.com/tailor-platform/sdk/pull/2023) [`9dc826f`](https://github.com/tailor-platform/sdk/commit/9dc826fc0a83aa926de5b07245513f67c1ace877) Thanks [@dqn](https://github.com/dqn)! - Guide users through the v2 type-only import requirement. The CLI loads TypeScript by stripping types from each file in isolation, so a plain import of a type-only export fails at load time with `SyntaxError: ... does not provide an export named '<name>'` and no indication that the import form is the cause.
+  
+  - The CLI now appends a suggestion to that error: import the name with `import type` and set `"verbatimModuleSyntax": true` in tsconfig.json to catch violations at typecheck.
+  - Projects scaffolded by `tailor init` now enable `verbatimModuleSyntax` in their tsconfig.json, so new projects catch violations at typecheck instead of at load time.
+  - The v2 migration guide gains a `v2/type-only-imports` entry documenting the requirement, the failure mode, and the migration steps, offered by `tailor upgrade` when crossing the v2 boundary.
+
+## 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

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";
@@ -116,6 +116,7 @@ const RENAME_BIN_QUOTED_LEGACY_COMMAND_PATTERN = new RegExp([
 ].join(""));
 const V2_NEXT_1 = "2.0.0-next.1";
 const V2_NEXT_2 = "2.0.0-next.2";
+const V2_NEXT_3 = "2.0.0-next.3";
 const V2_NEXT_4 = "2.0.0-next.4";
 const V2_NEXT_5 = "2.0.0-next.5";
 const V2_NEXT_6 = "2.0.0-next.6";
@@ -124,6 +125,50 @@ const V2_NEXT_9 = "2.0.0-next.9";
 const V2_NEXT_11 = "2.0.0-next.11";
 /** All registered codemods, in registration order. */
 const allCodemods = [
+	{
+		id: "v2/type-only-imports",
+		name: "Type-only imports → `import type`",
+		description: [
+			"The v2 CLI runs TypeScript by stripping types from each file in isolation,",
+			"with no cross-file type information. A plain (non-`type`) import of a",
+			"type-only export therefore survives stripping and fails when the module",
+			"loads:",
+			"",
+			"```",
+			"SyntaxError: The requested module './types.ts' does not provide an export named 'Row'",
+			"```",
+			"",
+			"`tailor generate` / `tailor deploy` stop at this error before doing any work.",
+			"Import types with `import type` (or the inline `type` modifier), and",
+			"re-export them with `export type`, in every module the CLI loads. Generated",
+			"Kysely types (`DB`, `Insertable`, `Selectable`, table row types) are almost",
+			"entirely type-only, so v1 projects typically hit this in many files at once.",
+			"Set `\"verbatimModuleSyntax\": true` in tsconfig.json to catch every violation",
+			"at typecheck; projects scaffolded by v2 `tailor init` enable it by default."
+		].join("\n"),
+		since: "1.0.0",
+		until: "2.0.0",
+		prereleaseUntil: V2_NEXT_3,
+		examples: [{
+			before: "import { DB, getDB } from \"./generated/db\";",
+			after: "import { type DB, getDB } from \"./generated/db\";"
+		}],
+		prompt: [
+			"In Tailor SDK v2 the CLI loads TypeScript by stripping types from each file",
+			"in isolation, so type-only exports do not exist at runtime and plain imports",
+			"of them fail to load with \"does not provide an export named '<name>'\".",
+			"Migrate the project so every type-only import and re-export is marked:",
+			"",
+			"1. Add `\"verbatimModuleSyntax\": true` to compilerOptions in tsconfig.json.",
+			"2. Run `tsc --noEmit` and fix every reported violation: add the `type`",
+			"   modifier to type-only named imports (`import type { Row }` or",
+			"   `import { type Row, marker }`) and change type-only re-exports to",
+			"   `export type { ... }`.",
+			"",
+			"Only add `type` modifiers; do not reorder, remove, or otherwise change",
+			"imports that are used as values."
+		].join("\n")
+	},
 	{
 		id: "v2/define-generators-to-plugins",
 		name: "defineGenerators → definePlugins",
@@ -683,7 +728,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,
@@ -1521,6 +1566,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}"];
@@ -1592,6 +1677,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
@@ -1601,13 +1689,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.1",
+  "version": "0.5.0",
   "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",
+    "@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",