tailwindcss-patch 8.7.4-alpha.0 → 9.0.0-alpha.2

package/README.md

@@ -115,7 +115,69 @@ Skip `next()` to fully replace a command (e.g. custom `init` or cache clearing b
 | `--css <file>`           | Provide a CSS entry file when working with Tailwind v4 projects. |
 | `--no-write`             | Skip writing to disk and only return the collected classes.      |
 
-The CLI loads `tailwindcss-patch.config.ts` via `@tailwindcss-mangle/config`. Legacy configs continue to work; see the [migration guide](./MIGRATION.md) for hints on the new fields.
+The CLI loads `tailwindcss-patch.config.ts` via `@tailwindcss-mangle/config`. v9 expects the modern `registry` shape; use `tw-patch migrate` before upgrading if your config still uses deprecated keys.
+
+### Public Type Names
+
+The current alpha exports the modern option type names only:
+
+```ts
+import type {
+  ApplyOptions,
+  CacheOptions,
+  ExtractOptions,
+  TailwindCssOptions,
+  TailwindCssPatchOptions,
+  TailwindV2Options,
+  TailwindV3Options,
+  TailwindV4Options,
+  NormalizedTailwindCssPatchOptions,
+} from 'tailwindcss-patch'
+```
+
+Older aliases such as `TailwindcssPatchOptions`, `TailwindLocatorOptions`, and `TailwindTargetOptions` are intentionally removed in the alpha line.
+
+### v9 upgrade flow
+
+1. Run `pnpm dlx tw-patch migrate --dry-run` to preview required config rewrites.
+2. Apply the migration, or rewrite the config manually to modern `registry` fields.
+3. Confirm every config sets `registry.tailwindcss.version` explicitly.
+4. Upgrade to v9 and rerun `tw-patch install` / `tw-patch extract` in your project.
+
+Legacy to v9 example:
+
+```ts
+// before
+export default defineConfig({
+  registry: {
+    output: {
+      file: '.tw-patch/tw-class-list.json',
+    },
+    tailwind: {
+      package: 'tailwindcss',
+      classic: {
+        cwd: 'apps/web',
+      },
+    },
+  },
+})
+
+// after
+export default defineConfig({
+  registry: {
+    extract: {
+      file: '.tw-patch/tw-class-list.json',
+    },
+    tailwindcss: {
+      version: 3,
+      packageName: 'tailwindcss',
+      v3: {
+        cwd: 'apps/web',
+      },
+    },
+  },
+})
+```
 
 ### Migrate options
 
@@ -296,9 +358,7 @@ const patchStatus = await patcher.getPatchStatus()
 console.log(patchStatus.entries)
 ```
 
-The constructor accepts either the new object shown above or historical shapes. Conversions happen internally so existing configs remain backwards compatible.
-
-Deprecated fields kept temporarily (to be removed in the next major): `cwd`, `overwrite`, `tailwind`, `features`, `output`.
+The constructor accepts the modern object shown above only in v9.
 
 Migration mapping:
 
@@ -308,7 +368,7 @@ Migration mapping:
 - `features` -> `apply`
 - `output` -> `extract`
 
-When deprecated fields are detected at runtime, `normalizeOptions` logs a one-time warning to help migration.
+Deprecated fields are rejected at runtime in v9. Run `tw-patch migrate --dry-run` to preview required rewrites.
 
 Use cache.driver to switch between the default file-backed cache, an in-memory cache (memory), or a no-op cache (noop) when filesystem permissions are restricted.