feat(nuxt): add new optimizeDeps option (#157)

* feat(nuxt): add new `optimizeDeps` option - optimize `yup` by default * docs(nuxt): update types and default options
gitsindonesia · Mar 21, 2023 · 84ef13a · 84ef13a
1 parent 649f4a3
commit 84ef13a
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 0 deletions.
diff --git a/docs/guide/nuxt.md b/docs/guide/nuxt.md
@@ -137,6 +137,30 @@ export interface ModuleOptions {
    * })
    */
   loadDefaultStyles?: boolean;
+  /**
+   * Determine whether to load dark mode styles.
+   *
+   * @default false
+   * @example
+   * // nuxt.config.ts
+   * export default defineConfig({
+   *  gitsUi: {
+   *   darkMode: true
+   * })
+   */
+  darkMode?: boolean;
+  /**
+   * Determine whether to optimize default deps.
+   *
+   * @default false
+   * @example
+   * // nuxt.config.ts
+   * export default defineConfig({
+   *  gitsUi: {
+   *   optimizeDeps: true
+   * })
+   */
+  optimizeDeps?: boolean;
 }
 ```
 
@@ -150,6 +174,8 @@ defaults: {
   transpileDeps: true,
   loadFloatingVueStyles: true,
   loadDefaultStyles: true,
+  darkMode: false,
+  optimizeDeps: true,
 },
 ```
 

diff --git a/packages/nuxt/src/module.ts b/packages/nuxt/src/module.ts
@@ -50,6 +50,8 @@ const transpile = [
   'floating-vue',
 ];
 
+const optimizeDeps = ['yup'];
+
 const components: AddComponentOptions[] = [
   {
     name: 'VAlert',
@@ -436,6 +438,18 @@ export interface ModuleOptions {
    * })
    */
   darkMode?: boolean;
+  /**
+   * Determine whether to optimize default deps.
+   *
+   * @default false
+   * @example
+   * // nuxt.config.ts
+   * export default defineConfig({
+   *  gitsUi: {
+   *   optimizeDeps: true
+   * })
+   */
+  optimizeDeps?: boolean;
 }
 
 export default defineNuxtModule<ModuleOptions>({
@@ -451,6 +465,7 @@ export default defineNuxtModule<ModuleOptions>({
     loadFloatingVueStyles: true,
     loadDefaultStyles: true,
     darkMode: false,
+    optimizeDeps: true,
   },
   setup(options, nuxt) {
     const runtimeDir = fileURLToPath(new URL('./runtime', import.meta.url));
@@ -465,6 +480,16 @@ export default defineNuxtModule<ModuleOptions>({
       ];
     }
 
+    // optimize deps
+    if (options.optimizeDeps) {
+      if (nuxt.options.vite.optimizeDeps?.include) {
+        nuxt.options.vite.optimizeDeps.include = [
+          ...nuxt.options.vite.optimizeDeps?.include,
+          ...optimizeDeps,
+        ];
+      }
+    }
+
     // use css bundle
     if (options.css) {
       nuxt.options.css.push('@morpheme/ui/styles');