feat: add JSON schema for config (#1074)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: Kevin Deng <sxzz@sxzz.moe>

Author: 3 people

.github/workflows/autofix.yml

@@ -36,7 +36,7 @@ jobs:
         run: $PACKAGE_MANAGER install $NO_FROZEN_LOCKFILE
 
       - name: Fix
-        run: pnpm run format && pnpm run lint --fix && pnpm build --update-snapshot
+        run: pnpm schema:generate && pnpm run format && pnpm run lint --fix && pnpm build --update-snapshot
 
       - name: Commit
         uses: autofix-ci/action@c5b2d67aa2274e7b5a18224e8171550871fc7e4a

.github/workflows/src/autofix.yml

@@ -7,6 +7,6 @@ jobs:
     if: github.repository == 'rolldown/tsdown'
     uses: sxzz/workflows/.github/workflows/autofix.yml@main
     with:
-      command: pnpm run format && pnpm run lint --fix && pnpm build --update-snapshot
+      command: pnpm schema:generate && pnpm run format && pnpm run lint --fix && pnpm build --update-snapshot
     permissions:
       contents: read

docs/options/config-file.md

@@ -12,6 +12,21 @@ By default, `tsdown` will search for a configuration file by looking in the curr
 
 Additionally, you can define your configuration directly in the `tsdown` field of your `package.json` file.
 
+## JSON Schema
+
+When using `tsdown.config.json`, add the schema reference to enable editor autocomplete and validation:
+
+```json [tsdown.config.json]
+{
+  "$schema": "https://raw.githubusercontent.com/rolldown/tsdown/main/schema.json",
+  "entry": "src/index.ts",
+  "format": "esm",
+  "dts": true
+}
+```
+
+The schema describes JSON-compatible configuration options. TypeScript-only values such as functions, plugins, and callbacks are available in `tsdown.config.ts` instead.
+
 ## Writing a Config File
 
 The configuration file allows you to define and customize your build settings in a centralized and reusable way. Below is a simple example of a `tsdown` configuration file:

package.json

@@ -83,6 +83,8 @@
     "test": "vitest",
     "typecheck": "tsc --noEmit",
     "format": "prettier --cache --write .",
+    "schema:generate": "node ./scripts/generate-schema.ts",
+    "schema:check": "node ./scripts/generate-schema.ts -c",
     "release": "node ./scripts/release.ts",
     "docs:dev": "pnpm -C docs run dev",
     "docs:build": "pnpm -C docs run build",
@@ -159,6 +161,7 @@
     "@types/node": "catalog:dev",
     "@types/picomatch": "catalog:dev",
     "@unocss/eslint-plugin": "catalog:docs",
+    "@valibot/to-json-schema": "catalog:dev",
     "@vitejs/devtools": "catalog:peer",
     "@vitest/coverage-v8": "catalog:dev",
     "@vitest/ui": "catalog:dev",
@@ -188,6 +191,7 @@
     "unplugin-unused": "catalog:peer",
     "unplugin-vue": "catalog:dev",
     "unrun": "catalog:dev",
+    "valibot": "catalog:dev",
     "vite": "catalog:docs",
     "vitest": "catalog:dev",
     "vue": "catalog:docs"

pnpm-lock.yaml

@@ -18,6 +18,7 @@ catalogs:
     '@sxzz/test-utils': ^0.5.20
     '@types/node': ^26.6.5
     '@types/picomatch': ^4.0.3
+    '@valibot/to-json-schema': ^1.8.0
     '@vitest/coverage-v8': ^5.0.5
     '@vitest/ui': ^5.0.5
     actionspack: ^0.1.5
@@ -41,6 +42,7 @@ catalogs:
     unplugin-raw: ^0.8.0
     unplugin-vue: ^8.0.0
     unrun: ^0.3.1
+    valibot: ^1.5.0
     vitest: ^5.0.5
   docs:
     '@iconify-json/logos': ^1.2.17