unplugin for Typia
⚠️ Note: this is highly experimental software.
Typia is fantastic, but it is hard to setup, even for frontend development.
If you use some bundlers for frontend like Vite
, it is even harder to setup.
This unplugin aims to make it easier to use Typia in your projects.
First, install unplugin-typia
:
# jsr
npx jsr add -D @ryoppippi/unplugin-typia
Then, install typia
:
# install typia! (nypm detects your PM ✨)
npx nypm add typia
# setup typia!
npx typia setup
# pnpm dlx typia setup
# yarn dlx typia setup
# after installing typia, run prepare script
npm run prepare
More details about setting up Typia can be found in the Typia Docs.
Then, add the unplugin to your favorite bundler:
Vite
// vite.config.ts
import UnpluginTypia from '@ryoppippi/unplugin-typia/vite';
export default defineConfig({
plugins: [
UnpluginTypia({ /* options */ }),
],
});
When using typia with types imported from non-relative paths like tsconfig
compilerOptions.paths
or relative to tsconfigcompilerOptions.baseUrl
, they must be defined in vite.config.ts under resolve.alias in order to be resolved, according to vite's resolution mechanism.
Examples:
esbuild
// esbuild.config.js
import UnpluginTypia from '@ryoppippi/unplugin-typia/esbuild';
export default {
plugins: [
UnpluginTypia({ /* options */ }),
],
};
Examples:
Next.js
// next.config.mjs
import unTypiaNext from 'unplugin-typia/next';
/** @type {import('next').NextConfig} */
const nextConfig = { /* your next.js config */};
/** @type {import("unplugin-typia").Options} */
const unpluginTypiaOptions = { /* your unplugin-typia options */ };
export default unTypiaNext(nextConfig, unpluginTypiaOptions);
// you can omit the unplugin-typia options when you don't need to customize it
// export default unTypiaNext(nextConfig);
Examples:
Bun.build
// build.ts
import UnpluginTypia from '@ryoppippi/unplugin-typia/bun';
await Bun.build({
entrypoints: ['./index.ts'],
outdir: './out',
plugins: [
UnpluginTypia({ /* your options */})
]
});
For building the script:
bun run ./build.ts
node ./out/index.js
Check the Plugins – Bundler | Bun Docs for more details.
// preload.ts
import { plugin } from 'bun';
import UnpluginTypia from '@ryoppippi/unplugin-typia/bun';
plugin(UnpluginTypia({ /* your options */}));
# bun.toml
preload = "preload.ts"
[test]
preload = "preload.ts"
For running the script:
bun run ./index.ts
Check the Plugins – Runtime | Bun Docs for more details.
Rollup
// rollup.config.js
import UnpluginTypia from '@ryoppippi/unplugin-typia/rollup';
export default {
plugins: [
UnpluginTypia({ /* options */ }),
],
};
Examples:
Webpack
>
npm install jiti
// webpack.config.js
const jiti = require('jiti')(__filename);
const { default: UnpluginTypia } = jiti('@ryoppippi/unplugin-typia/webpack');
module.exports = {
plugins: [
UnpluginTypia({ /* options */ }),
],
};
More integration guides can be found in the JSR Doc
You can find examples in the examples/
.
.ts
.tsx
.mts
.mtsx
.svelte
(only script tag withlang="ts"
)
- This plugin is highly experimental and may not work as expected.
- This plugin is not officially supported by Typia.
This repository is a monorepo managed by Bun.
bun i --frozen-lockfile