From 670e5d1c79037510fa6d88a42958e1412abfb9ee Mon Sep 17 00:00:00 2001 From: ryoppippi <1560508+ryoppippi@users.noreply.github.com> Date: Thu, 22 Aug 2024 11:10:36 +0100 Subject: [PATCH 1/4] feat(docs): update bundling recommendation in setup guide Updated the setup documentation to recommend using `unplugin-typia` for additional bundling when using `Typia` with bundlers like `vite`, `rollup`, and `webpack`. --- website/pages/docs/setup.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/pages/docs/setup.mdx b/website/pages/docs/setup.mdx index de9e33cb62..a58b01d40c 100644 --- a/website/pages/docs/setup.mdx +++ b/website/pages/docs/setup.mdx @@ -31,7 +31,7 @@ bun typia setup --manager bun Just run `npx typia setup` command if you're using `tsc`. The setup wizard will do everything. -By the way, if you need additional bundling, the third party library [`unplugin-typia`](#unplugin-typia) is recommended. +By the way, if you use `Typia` with bundlers(`vite`, `rollup`, `webpack`, etc), the third party library [`unplugin-typia`](#unplugin-typia) is recommended. Otherwise non-standard compiler case, only the [generation](#generation) mode is available. From 1d883b34a4515e1418724fb474d7efae84d4ba0f Mon Sep 17 00:00:00 2001 From: ryoppippi <1560508+ryoppippi@users.noreply.github.com> Date: Thu, 22 Aug 2024 11:11:59 +0100 Subject: [PATCH 2/4] docs(setup): update link to examples in unplugin-typia repo Updated the link to the examples projects in the unplugin-typia repository to point to the correct path under the main branch. --- website/pages/docs/setup.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/pages/docs/setup.mdx b/website/pages/docs/setup.mdx index a58b01d40c..7c5367ef08 100644 --- a/website/pages/docs/setup.mdx +++ b/website/pages/docs/setup.mdx @@ -284,7 +284,7 @@ At first, install both `unplugin-typia` and `typia`, with `npx typia setup` comm After that, follow the next section steps to integrate `unplugin-typia` into your bundlers. -For reference, there are a couple of ways to integrate `unplugin-typia` into your bundlers. For the full integration guide, please refer to the [`unplugin-typia` documentation](https://jsr.io/@ryoppippi/unplugin-typia/doc). Also, you can see the examples projects in [`unplugin-typia` repository](https://github.com/ryoppippi/unplugin-typia). +For reference, there are a couple of ways to integrate `unplugin-typia` into your bundlers. For the full integration guide, please refer to the [`unplugin-typia` documentation](https://jsr.io/@ryoppippi/unplugin-typia/doc). Also, you can see the examples projects in [`unplugin-typia` repository](https://github.com/ryoppippi/unplugin-typia/tree/main/examples). From d10a9117d9189b61bcbf85d605b94a37410989e0 Mon Sep 17 00:00:00 2001 From: ryoppippi <1560508+ryoppippi@users.noreply.github.com> Date: Thu, 22 Aug 2024 11:16:28 +0100 Subject: [PATCH 3/4] feat(docs): add info callout for unplugin-typia in Vite Added an informational callout in the setup documentation for Vite, highlighting the compatibility of `unplugin-typia` with other plugins like `@vitejs/plugin-react-swc`. This clarifies that `unplugin-typia` processes TypeScript code before transforming it to JavaScript, ensuring compatibility with any plugins. --- website/pages/docs/setup.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/website/pages/docs/setup.mdx b/website/pages/docs/setup.mdx index 7c5367ef08..0657950ca1 100644 --- a/website/pages/docs/setup.mdx +++ b/website/pages/docs/setup.mdx @@ -288,6 +288,10 @@ For reference, there are a couple of ways to integrate `unplugin-typia` into you + + You can use any plugins with [`unplugin-typia`](#unplugin-typia) in Vite (including [`@vitejs/plugin-react-swc`](https://github.com/vitejs/vite-plugin-react-swc)). + `unplugin-typia` process the TypeScript code before transforming it to JavaScript, so it can be used with any plugins. + ```typescript filename="vite.config.ts" copy showLineNumbers import UnpluginTypia from '@ryoppippi/unplugin-typia/vite' From f6455bee05860ab0bde22cf228d20c8bc56ff25f Mon Sep 17 00:00:00 2001 From: Jeongho Nam Date: Fri, 23 Aug 2024 00:27:52 +0900 Subject: [PATCH 4/4] Update setup.mdx --- website/pages/docs/setup.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/pages/docs/setup.mdx b/website/pages/docs/setup.mdx index 0657950ca1..9f879cd24e 100644 --- a/website/pages/docs/setup.mdx +++ b/website/pages/docs/setup.mdx @@ -31,7 +31,7 @@ bun typia setup --manager bun Just run `npx typia setup` command if you're using `tsc`. The setup wizard will do everything. -By the way, if you use `Typia` with bundlers(`vite`, `rollup`, `webpack`, etc), the third party library [`unplugin-typia`](#unplugin-typia) is recommended. +By the way, if you use `typia` with bundlers(`vite`, `rollup`, `webpack`, etc), the third party library [`unplugin-typia`](#unplugin-typia) is recommended. Otherwise non-standard compiler case, only the [generation](#generation) mode is available.