annabe1la/vite-plugin-dynamic-import

Enhance Vite builtin dynamic import

vite-plugin-dynamic-import

Enhance Vite builtin dynamic import

English | 简体中文

• Support alias
• Try to fix the wizard import path
• Compatible @rollup/plugin-dynamic-import-vars restrictions

Install

npm i vite-plugin-dynamic-import -D

Usage

import dynamicImport from 'vite-plugin-dynamic-import'

export default {
  plugins: [
    dynamicImport()
  ]
}

Cases 👉 vite-plugin-dynamic-import/test

API

DynamicImport([options])

options: DynamicImportOptions

export interface DynamicImportOptions {
  filter?: (id: string) => false | void
  /**
   * This option will change `./*` to `./** /*`
   * @default true
   */
  depth?: boolean
  /**
   * If you want to exclude some files  
   * e.g `type.d.ts`, `interface.ts`
   */
  onFiles?: (files: string[], id: string) => typeof files | void
  /**
   * It will add `@vite-ignore`  
   * `import(/*@vite-ignore* / 'import-path')`
   */
  viteIgnore?: (rawImportee: string, id: string) => true | void
}

How and why?

We assume that the project structure is as follows

├─┬ src
│ ├─┬ views
│ │ ├─┬ foo
│ │ │ └── index.js
│ │ └── bar.js
│ └── router.js
└── vite.config.js

// vite.config.js
export default {
  resolve: {
    alias: {
      // "@" -> "/User/project-root/src/views"
      '@': path.join(__dirname, 'src/views'),
    },
  },
}

Dynamic import is not well supported in Vite, such as

• Alias are not supported

// router.js
❌ import(`@/views/${variable}.js`)

• Must be relative

// router.js
❌ import(`/User/project-root/src/views/${variable}.js`)

• Must have extension

// router.js
❌ import(`./views/${variable}`)

We try to fix these problems

For the alias in import(), we can calculate the relative path according to UserConfig.root

// router.js
✅ import(`./views/${variable}.js`)

If the import path has no suffix, we use glob to find the file according to UserConfig.resolve.extensions and supplement the suffix of the import path.
So we need to list all the possibilities

1. transpire dynamic import variable, yout can see @rollup/plugin-dynamic-import-vars

./views/${variable} -> ./views/*

2. generate runtime code

- // import(`./views/${variable}`)
+ __variableDynamicImportRuntime(`./views/${variable}`)

+ function __variableDynamicImportRuntime(path) {
+   switch (path) {
+     case 'foo':
+     case 'foo/index':
+     case 'foo/index.js':
+       return import('./views/foo/index.js');
+ 
+     case 'bar':
+     case 'bar.js':
+       return import('./views/bar.js');
+ }

TODO

• support alias.customResolver