Add configuration JSON Schema support (#60)

* Add configuration JSON Schema support

* Create eleven-glasses-peel.md

.changeset/eleven-glasses-peel.md

@@ -0,0 +1,6 @@
+---
+"@lunariajs/core": patch
+"create-lunaria": patch
+---
+
+Add configuration JSON Schema support

examples/vitepress/lunaria.config.json

@@ -1,4 +1,5 @@
 {
+  "$schema": "./node_modules/@lunariajs/core/config.schema.json",
   "repository": {
     "name": "Yan-Thomas/lunaria",
     "rootDir": "examples/vitepress"

packages/core/README.md

@@ -28,6 +28,7 @@ The example below contains all of the **required** options to generate a dashboa
 ```json
 // lunaria.config.json
 {
+  "$schema": "./node_modules/@lunariajs/core/config.schema.json",
   "repository": {
     "name": "me/cool-docs"
   },

packages/core/package.json

@@ -22,6 +22,7 @@
   },
   "files": [
     "dist",
+    "config.schema.json",
     "CHANGELOG.md"
   ],
   "keywords": [
@@ -39,13 +40,15 @@
   },
   "bugs": "https://github.com/Yan-Thomas/lunaria/issues",
   "scripts": {
-    "build": "unbuild",
-    "lint": "tsc"
+    "build": "unbuild && pnpm run schema",
+    "lint": "tsc",
+    "schema": "jiti ./scripts/schema.ts"
   },
   "devDependencies": {
     "@types/micromatch": "^4.0.3",
     "@types/node": "^20.8.9",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "zod-to-json-schema": "^3.22.1"
   },
   "dependencies": {
     "destr": "^2.0.2",
@@ -58,6 +61,6 @@
     "simple-git": "^3.20.0",
     "ufo": "^1.3.1",
     "ultramatter": "^0.0.4",
-    "zod": "^3.22.3"
+    "zod": "^3.22.4"
   }
 }

packages/core/scripts/schema.ts

@@ -0,0 +1,18 @@
+import { writeFileSync } from 'node:fs';
+import { z } from 'zod';
+import { zodToJsonSchema } from 'zod-to-json-schema';
+import { LunariaConfigSchema } from '../src/schemas/config.js';
+
+const mergedSchema = LunariaConfigSchema.merge(
+	z
+		.object({
+			$schema: z.string().optional(),
+		})
+		.describe('A path or URL to a valid Lunaria JSON Schema.')
+);
+
+const jsonSchema = JSON.stringify(zodToJsonSchema(mergedSchema, 'LunariaConfigSchema'));
+
+writeFileSync('./dist/config.schema.json', jsonSchema);
+
+console.log('Lunaria JSON schema generated!');

packages/create-lunaria/build.config.ts

@@ -2,4 +2,9 @@ import { defineBuildConfig } from 'unbuild';
 
 export default defineBuildConfig({
 	entries: ['src/create-lunaria'],
+	rollup: {
+		esbuild: {
+			minify: true,
+		},
+	},
 });

packages/create-lunaria/src/create-lunaria.ts

@@ -6,8 +6,13 @@ import { join, resolve } from 'node:path';
 import { addDependency, detectPackageManager, installDependencies } from 'nypm';
 import color from 'picocolors';
 
-// TODO: Add JSON Schema here!
-const cleanConfigContent = '{\n    \n}';
+const cleanConfigContent = JSON.stringify(
+	{
+		$schema: './node_modules/@lunariajs/core/config.schema.json',
+	},
+	null,
+	2
+);
 
 async function main() {
 	console.clear();
@@ -24,7 +29,7 @@ async function main() {
 						if (value[0] !== '.') return 'Please enter a relative path.';
 					},
 				}),
-			install: ({ results }) =>
+			install: () =>
 				p.confirm({
 					message: 'Install dependencies?',
 					initialValue: false,