feat(vite): add option checkImport (#4362)

ntnyq · web-flow · commit 1e5caa494716 · 2025-01-08T08:11:39.000Z
diff --git a/packages/vite/src/modes/global/build.ts b/packages/vite/src/modes/global/build.ts
@@ -19,6 +19,7 @@ import {
   resolveId,
   resolveLayer,
 } from '../../integration'
+import { MESSAGE_UNOCSS_ENTRY_NOT_FOUND } from './shared'
 
 // https://github.com/vitejs/vite/blob/main/packages/plugin-legacy/src/index.ts#L742-L744
 function isLegacyChunk(chunk: RenderedChunk, options: NormalizedOutputOptions) {
@@ -279,8 +280,11 @@ export function GlobalModeBuildPlugin(ctx: UnocssPluginContext<VitePluginConfig>
           // to replace on current build pipeline, we can skip the warning.
           if (replaced)
             return
-          const msg = '[unocss] Entry module not found. Did you add `import \'uno.css\'` in your main entry?'
-          this.warn(msg)
+
+          if ((await getConfig() as VitePluginConfig).checkImport) {
+            this.warn(MESSAGE_UNOCSS_ENTRY_NOT_FOUND)
+          }
+
           return
         }
 
diff --git a/packages/vite/src/modes/global/dev.ts b/packages/vite/src/modes/global/dev.ts
@@ -5,21 +5,24 @@ import process from 'node:process'
 import { notNull } from '@unocss/core'
 import MagicString from 'magic-string'
 import { getHash, getPath, LAYER_MARK_ALL, resolveId, resolveLayer } from '../../integration'
+import { MESSAGE_UNOCSS_ENTRY_NOT_FOUND } from './shared'
 
 const WARN_TIMEOUT = 20000
 const WS_EVENT_PREFIX = 'unocss:hmr'
 const HASH_LENGTH = 6
 
+type TimeoutTimer = ReturnType<typeof setTimeout> | undefined
+
 export function GlobalModeDevPlugin(ctx: UnocssPluginContext): Plugin[] {
   const { tokens, tasks, flushTasks, affectedModules, onInvalidate, extract, filter, getConfig } = ctx
   const servers: ViteDevServer[] = []
   const entries = new Set<string>()
 
-  let invalidateTimer: any
+  let invalidateTimer: TimeoutTimer
   const lastServedHash = new Map<string, string>()
   let lastServedTime = Date.now()
   let resolved = false
-  let resolvedWarnTimer: any
+  let resolvedWarnTimer: TimeoutTimer
 
   async function generateCSS(layer: string) {
     await flushTasks()
@@ -80,17 +83,20 @@ export function GlobalModeDevPlugin(ctx: UnocssPluginContext): Plugin[] {
     }
   }
 
-  function setWarnTimer() {
-    if (!resolved && !resolvedWarnTimer) {
+  async function setWarnTimer() {
+    if (
+      !resolved
+      && !resolvedWarnTimer
+      && (await getConfig() as VitePluginConfig).checkImport
+    ) {
       resolvedWarnTimer = setTimeout(() => {
         if (process.env.TEST || process.env.NODE_ENV === 'test')
           return
         if (!resolved) {
-          const msg = '[unocss] Entry module not found. Did you add `import \'uno.css\'` in your main entry?'
-          console.warn(msg)
+          console.warn(MESSAGE_UNOCSS_ENTRY_NOT_FOUND)
           servers.forEach(({ ws }) => ws.send({
             type: 'error',
-            err: { message: msg, stack: '' },
+            err: { message: MESSAGE_UNOCSS_ENTRY_NOT_FOUND, stack: '' },
           }))
         }
       }, WARN_TIMEOUT)
diff --git a/packages/vite/src/modes/global/shared.ts b/packages/vite/src/modes/global/shared.ts
@@ -1 +1,3 @@
 export const VIRTUAL_ENTRY_DEFAULT = '/__unocss_entry.css'
+
+export const MESSAGE_UNOCSS_ENTRY_NOT_FOUND = '[unocss] Entry module not found. Did you add `import \'uno.css\'` in your main entry?'
diff --git a/packages/vite/src/types.ts b/packages/vite/src/types.ts
@@ -57,4 +57,11 @@ export interface VitePluginConfig<Theme extends object = object> extends UserCon
    * @default 'cors'
    */
   fetchMode?: 'cors' | 'navigate' | 'no-cors' | 'same-origin'
+
+  /**
+   * Disable `import 'uno.css'` existing check.
+   *
+   * @default true
+   */
+  checkImport?: boolean
 }

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`export const VIRTUAL_ENTRY_DEFAULT = '/__unocss_entry.css'`
	`2`	`+`
	`3`	+export const MESSAGE_UNOCSS_ENTRY_NOT_FOUND = '[unocss] Entry module not found. Did you add `import \'uno.css\'` in your main entry?'