feat(tailwindcss-patch): publish restore result json schema

Author: sonofmagic

.changeset/tidy-kids-care.md

@@ -0,0 +1,9 @@
+---
+"tailwindcss-patch": patch
+---
+
+Publish JSON schema for restore and validate outputs.
+
+- add `tailwindcss-patch/restore-result.schema.json` for `tw-patch restore --json` and `tw-patch validate --json`
+- expose the schema through package exports (source and publish configs)
+- add tests and docs to keep schema fields aligned with public report constants

packages/tailwindcss-patch/MIGRATION.md

@@ -93,7 +93,7 @@ Migration mapping:
 - `tw-patch restore` validates report metadata when present, rejects unknown kinds/newer schema versions, and keeps legacy metadata-free reports backward compatible.
 - `tw-patch restore --json` now exposes report metadata fields (`reportKind`, `reportSchemaVersion`) when available for easier diagnostics.
 - `tw-patch validate` can validate migration report compatibility in dry-run mode without restoring files.
-- Migration report tooling now has public exports from package entry (`migrateConfigFiles`, `restoreConfigFiles`, report constants/types) and a published JSON schema subpath: `tailwindcss-patch/migration-report.schema.json`.
+- Migration report tooling now has public exports from package entry (`migrateConfigFiles`, `restoreConfigFiles`, report constants/types) and published JSON schema subpaths: `tailwindcss-patch/migration-report.schema.json`, `tailwindcss-patch/restore-result.schema.json`.
 - Commands resolve configuration from `tailwindcss-patch.config.ts` via `@tailwindcss-mangle/config`. Existing configuration files continue to work without changes.
 
 ## 4. Cache handling

packages/tailwindcss-patch/README-cn.md

@@ -106,7 +106,9 @@ CLI 会通过 `@tailwindcss-mangle/config` 加载 `tailwindcss-patch.config.ts`
 
 `tw-patch validate` 会以 dry-run 模式执行迁移报告校验，不写回任何恢复文件，同时校验报告 schema 与备份引用状态。
 
-迁移报告 JSON Schema 通过子路径发布：`tailwindcss-patch/migration-report.schema.json`。
+JSON Schema 通过子路径发布：
+`tailwindcss-patch/migration-report.schema.json`、
+`tailwindcss-patch/restore-result.schema.json`。
 编程场景也可直接从包入口导入报告相关导出：
 `migrateConfigFiles`、`restoreConfigFiles`、`MIGRATION_REPORT_KIND`、`MIGRATION_REPORT_SCHEMA_VERSION`、`ConfigFileMigrationReport`。
 

packages/tailwindcss-patch/README.md

@@ -163,7 +163,9 @@ With `--json`, restore output includes `reportKind` / `reportSchemaVersion` when
 
 `tw-patch validate` performs migration report compatibility checks without writing restored files. It runs report schema validation and scans backup references in dry-run mode.
 
-Migration report schema is published at package subpath: `tailwindcss-patch/migration-report.schema.json`.
+Schemas are published at package subpaths:
+`tailwindcss-patch/migration-report.schema.json`,
+`tailwindcss-patch/restore-result.schema.json`.
 Programmatic consumers can also import report helpers/types from package entry:
 `migrateConfigFiles`, `restoreConfigFiles`, `MIGRATION_REPORT_KIND`, `MIGRATION_REPORT_SCHEMA_VERSION`, `ConfigFileMigrationReport`.
 

packages/tailwindcss-patch/package.json

@@ -25,7 +25,8 @@
       "import": "./src/index.ts",
       "require": "./src/index.ts"
     },
-    "./migration-report.schema.json": "./schema/migration-report.schema.json"
+    "./migration-report.schema.json": "./schema/migration-report.schema.json",
+    "./restore-result.schema.json": "./schema/restore-result.schema.json"
   },
   "main": "./src/index.ts",
   "module": "./src/index.ts",
@@ -61,7 +62,8 @@
         "import": "./dist/index.mjs",
         "require": "./dist/index.js"
       },
-      "./migration-report.schema.json": "./schema/migration-report.schema.json"
+      "./migration-report.schema.json": "./schema/migration-report.schema.json",
+      "./restore-result.schema.json": "./schema/restore-result.schema.json"
     },
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",

packages/tailwindcss-patch/schema/restore-result.schema.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mangle.icebreaker.top/schemas/tailwindcss-patch/restore-result.schema.json",
+  "title": "tailwindcss-patch restore/validate result",
+  "description": "Schema for JSON output from `tw-patch restore --json` and `tw-patch validate --json`.",
+  "type": "object",
+  "required": [
+    "cwd",
+    "reportFile",
+    "dryRun",
+    "strict",
+    "scannedEntries",
+    "restorableEntries",
+    "restoredFiles",
+    "missingBackups",
+    "skippedEntries",
+    "restored"
+  ],
+  "properties": {
+    "cwd": {
+      "type": "string"
+    },
+    "reportFile": {
+      "type": "string"
+    },
+    "reportKind": {
+      "type": "string",
+      "const": "tw-patch-migrate-report"
+    },
+    "reportSchemaVersion": {
+      "type": "integer",
+      "minimum": 1
+    },
+    "dryRun": {
+      "type": "boolean"
+    },
+    "strict": {
+      "type": "boolean"
+    },
+    "scannedEntries": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "restorableEntries": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "restoredFiles": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "missingBackups": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "skippedEntries": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "restored": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    }
+  },
+  "additionalProperties": false
+}

packages/tailwindcss-patch/test/migration-report.schema.test.ts

@@ -32,3 +32,18 @@ describe('migration report json schema', () => {
     )
   })
 })
+
+describe('restore result json schema', () => {
+  it('ships a restore-result schema file aligned with exported constants', async () => {
+    const schemaPath = path.resolve(process.cwd(), 'schema/restore-result.schema.json')
+    const schema = await fs.readJSON(schemaPath) as Record<string, any>
+
+    expect(schema.$schema).toContain('json-schema.org')
+    expect(schema.type).toBe('object')
+    expect(schema.required).toEqual(
+      expect.arrayContaining(['reportFile', 'dryRun', 'restored', 'missingBackups']),
+    )
+    expect(schema.properties.reportKind.const).toBe(MIGRATION_REPORT_KIND)
+    expect(schema.properties.reportSchemaVersion.minimum).toBe(MIGRATION_REPORT_SCHEMA_VERSION)
+  })
+})