feat(core): add configuration validation using typia

Author: colinaaa

packages/core/package.json

@@ -56,7 +56,9 @@
     "rslib": "npm:@rslib/[email protected]",
     "rslog": "^1.2.3",
     "tsconfck": "3.1.4",
-    "typescript": "^5.7.3"
+    "typescript": "^5.7.3",
+    "typia": "^7.6.2",
+    "typia-rspack-plugin": "^1.0.1"
   },
   "peerDependencies": {
     "@microsoft/api-extractor": "^7",

packages/core/rslib.config.ts

@@ -3,6 +3,7 @@ import path from 'node:path';
 import type { RsbuildPlugin } from '@rsbuild/core';
 import { pluginPublint } from 'rsbuild-plugin-publint';
 import { defineConfig } from 'rslib';
+import { TypiaRspackPlugin } from 'typia-rspack-plugin';
 
 const pluginFixDtsTypes: RsbuildPlugin = {
   name: 'fix-dts-types',
@@ -55,4 +56,14 @@ export default defineConfig({
       rslog: '../compiled/rslog/index.js',
     },
   },
+  tools: {
+    rspack: {
+      plugins: [
+        new TypiaRspackPlugin({
+          log: false,
+          include: [path.resolve('./src/validate.ts')],
+        }),
+      ],
+    },
+  },
 });

packages/core/src/config.ts

@@ -80,6 +80,7 @@ import {
   transformSyntaxToRspackTarget,
 } from './utils/syntax';
 import { loadTsconfig } from './utils/tsconfig';
+import { validate } from './validate';
 
 /**
  * This function helps you to autocomplete configuration types.
@@ -138,7 +139,9 @@ export async function loadConfig({
     envMode,
   });
 
-  return { content: content as RslibConfig, filePath: configFilePath };
+  const rslibConfig = validate(content, configFilePath);
+
+  return { content: rslibConfig, filePath: configFilePath };
 }
 
 const composeExternalsWarnConfig = (

packages/core/src/validate.ts

@@ -0,0 +1,48 @@
+import color from 'picocolors';
+import * as typia from 'typia';
+import type { RslibConfig } from './types';
+
+export const validateConfig: (
+  input: unknown,
+) => typia.IValidation<RslibConfig> = typia.createValidateEquals<RslibConfig>();
+
+export function validate(input: unknown, configPath?: string): RslibConfig {
+  const result = validateConfig(input);
+
+  if (result.success) {
+    return result.data;
+  }
+
+  const messages = result.errors.flatMap(({ expected, path, value }) => {
+    if (expected === 'undefined') {
+      // Unknown properties
+      return [`Unknown property: \`${color.red(path)}\` in configuration`, ''];
+    }
+
+    return [
+      `Invalid config on \`${color.red(path)}\`.`,
+      `  - Expect to be ${color.green(expected)}`,
+      `  - Got: ${color.red(whatIs(value))}`,
+      '',
+    ];
+  });
+
+  // We use `Array.isArray` outside to deal with error messages
+  throw new Error(
+    [
+      `Invalid configuration${
+        configPath ? ` loaded from ${color.dim(configPath)}` : '.'
+      }`,
+      '',
+    ]
+      .concat(messages)
+      .join('\n'),
+  );
+}
+
+function whatIs(value: unknown): string {
+  return Object.prototype.toString
+    .call(value)
+    .replace(/^\[object\s+([a-z]+)\]$/i, '$1')
+    .toLowerCase();
+}