Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ryoppippi/unplugin-typia
unplugin for Typia with an extra Bun plugin 🫶
https://github.com/ryoppippi/unplugin-typia
bun bun-build esbuild rolldown rollup typescript typia unplugin vite webpack
Last synced: 1 day ago
JSON representation
unplugin for Typia with an extra Bun plugin 🫶
- Host: GitHub
- URL: https://github.com/ryoppippi/unplugin-typia
- Owner: ryoppippi
- License: other
- Created: 2024-05-24T13:25:25.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-12-18T16:21:40.000Z (7 days ago)
- Last Synced: 2024-12-18T19:24:28.266Z (6 days ago)
- Topics: bun, bun-build, esbuild, rolldown, rollup, typescript, typia, unplugin, vite, webpack
- Language: TypeScript
- Homepage: https://jsr.io/@ryoppippi/unplugin-typia
- Size: 4.48 MB
- Stars: 45
- Watchers: 1
- Forks: 9
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yaml
- License: LICENSE
Awesome Lists containing this project
README
# unplugin-typia
**unplugin for [Typia](https://typia.io/)**
[](https://npmjs.com/package/@ryoppippi/unplugin-typia)
[](https://npmjs.com/package/@ryoppippi/unplugin-typia)
[](https://jsr.io/@ryoppippi/unplugin-typia)
[](https://jsr.io/@ryoppippi/unplugin-typia)
## Why
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.
## Install
First, install `unplugin-typia`:
```bash
# jsr(recommended)
npx jsr add -D @ryoppippi/unplugin-typia
# npm
npm install -D @ryoppippi/unplugin-typia
```
Then, install `typia`:
```bash
# 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](https://typia.io/docs/setup/#unplugin-typia).
Then, add the unplugin to your favorite bundler:
Vite
```ts
// vite.config.ts
import UnpluginTypia from '@ryoppippi/unplugin-typia/vite';
export default defineConfig({
plugins: [
UnpluginTypia({ /* options */ }), // should be placed before other plugins like `react`, `svetle`, etc.
],
});
```
> When using typia with types imported from non-relative paths like tsconfig `compilerOptions.paths` or relative to
> tsconfig `compilerOptions.baseUrl`, they must be defined in vite.config.ts under [resolve.alias](https://vitejs.dev/config/shared-options#resolve-alias)
> in order to be resolved, according to vite's resolution mechanism.
Examples:
- [`examples/vite-react`](https://github.com/ryoppippi/unplugin-typia/tree/main/examples/vite-react)
- [`examples/vite-hono`](https://github.com/ryoppippi/unplugin-typia/tree/main/examples/vite-hono)
- [`examples/sveltekit`](https://github.com/ryoppippi/unplugin-typia/tree/main/examples/sveltekit)
esbuild
```ts
// esbuild.config.js
import UnpluginTypia from '@ryoppippi/unplugin-typia/esbuild';
export default {
plugins: [
UnpluginTypia({ /* options */ }),
],
};
```
Examples:
- [`tests/rollup.spec.ts`](https://github.com/ryoppippi/unplugin-typia/tree/main/packages/unplugin-typia/tests/esbuild.spec.ts)
Next.js
```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:
- [`examples/nextjs`](https://github.com/ryoppippi/unplugin-typia/tree/main/examples/nextjs)
Bun.build
### Example 1: Using for building script
```ts
// 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:
```sh
bun run ./build.ts
node ./out/index.js
```
Check the [Plugins – Bundler | Bun Docs](https://bun.sh/docs/bundler/plugins) for more details.
### Example 2: Using for running script
```ts
// preload.ts
import { plugin } from 'bun';
import UnpluginTypia from '@ryoppippi/unplugin-typia/bun';
plugin(UnpluginTypia({ /* your options */}));
```
```toml
# bun.toml
preload = "preload.ts"
[test]
preload = "preload.ts"
```
For running the script:
```sh
bun run ./index.ts
```
Check the [Plugins – Runtime | Bun Docs](https://bun.sh/docs/runtime/plugins) for more details.
Rollup
```ts
// rollup.config.js
import UnpluginTypia from '@ryoppippi/unplugin-typia/rollup';
export default {
plugins: [
UnpluginTypia({ /* options */ }),
],
};
```
Examples:
- [`tests/rollup.spec.ts`](https://github.com/ryoppippi/unplugin-typia/tree/main/packages/unplugin-typia/tests/rollup.spec.ts)
Webpack
> ⚠️ Note: Currently, this plugin works only with 'esm' target.
> If you want to use 'cjs' target on Node < 20.17.0 , please use with [`jiti`](https://github.com/unjs/jiti).
> If you want to use 'cjs' target on Node >= 20.17.0, please use with `require` and enable [`--experimental-require-modules` flag](https://github.com/nodejs/node/pull/51977).
> If you want to use 'esm' target, don't worry! You can use this plugin without any additional setup.
```sh
npm install jiti
```
```js
// webpack.config.js
// if you use Node < 20.17.0
const jiti = require('jiti')(__filename);
const { default: UnpluginTypia } = jiti('@ryoppippi/unplugin-typia/webpack');
// if you use Node >= 20.17.0
// const { default: UnpluginTypia } = require("@ryoppippi/unplugin-typia/webpack");
module.exports = {
plugins: [
UnpluginTypia({ /* options */ }),
],
};
```
More integration guides can be found in the [`JSR Doc`](https://jsr.io/@ryoppippi/unplugin-typia/doc)
You can find examples in the [`examples/`](https://github.com/ryoppippi/unplugin-typia/tree/main/examples).
## Supported File Extensions
- `.ts`
- `.tsx`
- `.mts`
- `.mtsx`
- `.svelte` (only script tag with `lang="ts"`)
## Development
This repository is a monorepo managed by [Bun](https://bun.sh).
- [unplugin-typia](https://github.com/ryoppippi/unplugin-typia/tree/main/packages/unplugin-typia)
- [examples](https://github.com/ryoppippi/unplugin-typia/tree/main/examples)
```sh
bun i --frozen-lockfile
```
## Acknowledgements
This project started as an unofficial integration of Typia for bundlers.
Now, this plugin is one of the official integrations of Typia and is sponsored by [@samchon](https://github.com/samchon) (the creator of Typia).
## LICENSE
[MIT](./LICENSE)
