Merge pull request #915 from samchon/features/setup

Enhance guide documents of setup page
samchon · Dec 30, 2023 · 5ee0a5e · 5ee0a5e
2 parents f3f01bb + 9ff73ef
commit 5ee0a5e
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 28 deletions.
diff --git a/website/package-lock.json b/website/package-lock.json
diff --git a/website/package.json b/website/package.json
@@ -41,6 +41,6 @@
     "prettier": "^2.8.8",
     "rimraf": "^5.0.0",
     "ts-node": "^10.9.1",
-    "typia": "^5.3.7-dev.20231230"
+    "typia": "^5.3.7"
   }
 }
diff --git a/website/pages/docs/setup.mdx b/website/pages/docs/setup.mdx
@@ -440,9 +440,9 @@ pnpm install --save-dev webpack webpack-cli
     </Tab>
     <Tab>
 ```bash filename="Terminal" copy showLineNumbers
-##############################
+###########################################
 # YARN BERRY IS NOT SUPPORTED
-##############################
+###########################################
 # TYPIA
 yarn add typia
 yarn typia setup --manager yarn
@@ -456,7 +456,7 @@ yarn add -D webpack webpack-cli
 
 When you're using `webpack` as a bundler, you can still utilize the [transformation](#transformation) mode.
 
-Just install `ts-loader` as well as `webpack`, and configure `webpack.config.js` file like below, that's all.
+Just install `ts-loader` as well as `webpack`, and configure `webpack.config.js` file like below.
 
 ```javascript filename="webpack.config.js" copy showLineNumbers
 const path = require("path");
@@ -490,3 +490,76 @@ module.exports = {
     },
 };
 ```
+
+From now on, you can build the single JS file just by running the `npx webpack` command. By the way, when removing `devDependencies` for `--production` install, never forget to add the `--ignore-scripts` option to prevent the `prepare` script.
+
+<Tabs items={['npm', 'pnpm', 'yarn']}>
+    <Tab>
+```bash filename="Terminal" copy showLineNumbers
+npx webpack
+npm ci --omit=dev --ignore-scripts
+```
+    </Tab>
+    <Tab>
+```bash filename="Terminal" copy showLineNumbers
+pnpm webpack
+pnpm install --production --ignore-scripts
+```
+    </Tab>
+    <Tab>
+```bash filename="Terminal" copy showLineNumbers
+yarn webpack
+rm -rf node_modules
+yarn install --production --ignore-scripts --immutable
+```
+    </Tab>
+</Tabs>
+
+Additionally, if you're using `typia` in the NodeJS project especially for the backend development, *Setup Guide Documents* of [`nestia`](https://github.com/samchon/nestia) would be helpful. Even though you're not using NestJS, you can still utilize below documents, and "Single JS file only" mode would be especially helpful for you.
+
+  - [Nestia > Setup > Webpack](https://nestia.io/docs/setup/#webpack)
+    - [With `node_modules`](https://nestia.io/docs/setup/#with-node_modules)
+    - [Single JS file only](https://nestia.io/docs/setup/#single-js-file-only)
+
+
+## NX
+<Tabs items={['npm', 'pnpm', 'yarn']}>
+    <Tab>
+```bash filename="Terminal" copy showLineNumbers
+npm install --save typia
+npx typia setup
+```
+    </Tab>
+    <Tab>
+```bash filename="Terminal" copy showLineNumbers
+pnpm install --save typia
+pnpm typia setup --manager pnpm
+```
+    </Tab>
+    <Tab>
+```bash filename="Terminal" copy showLineNumbers
+# YARN BERRY IS NOT SUPPORTED
+yarn add typia
+yarn typia setup --manager yarn
+```
+    </Tab>
+</Tabs>
+
+After install `typia` like above, you have to modify `project.json` on each app like below.
+
+```javascript filename="project.json" showLineNumbers copy
+ "targets": {
+    "build": {
+      ...
+      "options": {
+        ...
+        "target": "node",
+        "compiler": "tsc",
+        "transformers": [
+          "typia/lib/transform",
+        ]
+      }
+    },
+    ...
+ }
+```
diff --git a/website/public/sitemap-0.xml b/website/public/sitemap-0.xml
@@ -1,23 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">
-<url><loc>https://typia.io/</loc><lastmod>2023-12-29T05:39:38.586Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/json/parse/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/json/schema/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/json/stringify/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/misc/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/protobuf/decode/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/protobuf/encode/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/protobuf/message/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/pure/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/random/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/setup/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/utilization/nestjs/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/utilization/prisma/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/utilization/trpc/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/validators/assert/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/validators/is/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/validators/tags/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/docs/validators/validate/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
-<url><loc>https://typia.io/playground/</loc><lastmod>2023-12-29T05:39:38.587Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/</loc><lastmod>2023-12-30T15:49:02.590Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/json/parse/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/json/schema/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/json/stringify/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/misc/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/protobuf/decode/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/protobuf/encode/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/protobuf/message/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/pure/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/random/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/setup/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/utilization/nestjs/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/utilization/prisma/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/utilization/trpc/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/validators/assert/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/validators/is/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/validators/tags/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/docs/validators/validate/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
+<url><loc>https://typia.io/playground/</loc><lastmod>2023-12-30T15:49:02.591Z</lastmod><changefreq>daily</changefreq><priority>0.7</priority></url>
 </urlset>