@elliots/typical 0.1.8 → 0.1.9

package/README.md

@@ -2,9 +2,7 @@
 
 Typical adds runtime validation to typescript, making TypeScript type-safe at runtime *with no changes to your code*. 
 
-It can be used as a TSC plugin, or ESM loader for Node.js.
-
-(Could add unplugin/vite plugin, bun plugin etc. if needed.)
+It can be used as a TSC plugin, ESM loader for Node.js, or with bundlers like Vite, Webpack, and Rollup via unplugin.
 
 ## Why?
 
@@ -25,6 +23,7 @@ Why not.
 - ✅ TSC plugin
 - ✅ ESM loader for runtime transformation with `node --import @elliots/typical/esm` (or `node --loader @elliots/typical/esm-loader` for older Node versions)
 - ✅ tsx wrapper (ttsx) for easy use like `npx ttsx script.ts`
+- ✅ Unplugin for Vite, Webpack, Rollup, esbuild, and more
 
 ## Installation
 
@@ -40,12 +39,30 @@ If not provided, these default settings will be used.
 
 ```json
 {
-  "include": ["src/**/*.ts", "src/**/*.tsx"],
-  "exclude": ["node_modules/**", "**/*.d.ts", "dist/**"],
-  "optimizeReused": true
+  "include": ["**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules/**", "**/*.d.ts", "dist/**", "build/**"],
+  "reusableValidators": true,
+  "validateFunctions": true,
+  "validateCasts": false,
+  "hoistRegex": true,
+  "ignoreDOMTypes": true,
+  "ignoreTypes": []
 }
 ```
 
+### Configuration Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `include` | `["**/*.ts", "**/*.tsx"]` | Glob patterns for files to transform |
+| `exclude` | `["node_modules/**", "**/*.d.ts", "dist/**", "build/**"]` | Glob patterns for files to skip |
+| `reusableValidators` | `true` | Create shared validators for identical types (smaller output, allows reuse) |
+| `validateFunctions` | `true` | Validate function parameters and return types at runtime |
+| `validateCasts` | `false` | Validate type assertions (`as Type`) at runtime |
+| `hoistRegex` | `true` | Hoist regex patterns to top-level constants (improves performance) |
+| `ignoreDOMTypes` | `true` | Skip validation for DOM types (Document, Element, etc.) |
+| `ignoreTypes` | `[]` | Type patterns to skip validation for (supports wildcards, e.g., `["React.*"]`) |
+
 ## Usage
 
 See ./samples/esm and ./samples/tsc and ./samples/ttsx
@@ -64,6 +81,78 @@ npm add -g @elliots/typical
 ttsx your-script.ts
 ```
 
+## Vite / Webpack / Rollup (unplugin)
+
+Install the unplugin:
+
+```bash
+npm add @elliots/unplugin-typical
+```
+
+### Vite
+
+```typescript
+// vite.config.ts
+import Typical from '@elliots/unplugin-typical/vite'
+
+export default defineConfig({
+  plugins: [
+    Typical(),
+  ],
+})
+```
+
+### Webpack
+
+```typescript
+// webpack.config.js
+const Typical = require('@elliots/unplugin-typical/webpack').default
+
+module.exports = {
+  plugins: [
+    Typical(),
+  ],
+}
+```
+
+### Rollup
+
+```typescript
+// rollup.config.js
+import Typical from '@elliots/unplugin-typical/rollup'
+
+export default {
+  plugins: [
+    Typical(),
+  ],
+}
+```
+
+### esbuild
+
+```typescript
+import { build } from 'esbuild'
+import Typical from '@elliots/unplugin-typical/esbuild'
+
+build({
+  plugins: [Typical()],
+})
+```
+
+### Plugin Configuration
+
+Pass options directly to the plugin:
+
+```typescript
+Typical({
+  validateFunctions: true,
+  validateCasts: false,
+  // ... other options
+})
+```
+
+Or use a `typical.json` file in your project root (shared with other entry points like TSC plugin and ESM loader).
+
 ## Example
 
 This code will run without errors when compiled normally, but will throw an error when using Typical.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elliots/typical",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "Runtime safe TypeScript transformer using typia",
   "main": "dist/src/index.js",
   "type": "module",