fix: Matcher for chokidar WatchOptions#ignored (#4616)

vitejs · Aug 16, 2021 · 89e7a41 · 89e7a41
1 parent f75e508
commit 89e7a41
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 2 deletions.
diff --git a/packages/vite/src/node/index.ts b/packages/vite/src/node/index.ts
@@ -83,3 +83,4 @@ export type { FSWatcher, WatchOptions } from 'types/chokidar'
 export type { Terser } from 'types/terser'
 export type { RollupCommonJSOptions } from 'types/commonjs'
 export type { RollupDynamicImportVarsOptions } from 'types/dynamicImportVars'
+export type { Matcher, AnymatchPattern, AnymatchFn } from 'types/anymatch'
diff --git a/packages/vite/src/node/server/index.ts b/packages/vite/src/node/server/index.ts
@@ -319,7 +319,11 @@ export async function createServer(
 
   const { ignored = [], ...watchOptions } = serverConfig.watch || {}
   const watcher = chokidar.watch(path.resolve(root), {
-    ignored: ['**/node_modules/**', '**/.git/**', ...ignored],
+    ignored: [
+      '**/node_modules/**',
+      '**/.git/**',
+      ...(Array.isArray(ignored) ? ignored : [ignored])
+    ],
     ignoreInitial: true,
     ignorePermissionErrors: true,
     disableGlobbing: true,

diff --git a/packages/vite/types/anymatch.d.ts b/packages/vite/types/anymatch.d.ts
@@ -0,0 +1,5 @@
+export type AnymatchFn = (testString: string) => boolean
+export type AnymatchPattern = string | RegExp | AnymatchFn
+type AnymatchMatcher = AnymatchPattern | AnymatchPattern[]
+
+export { AnymatchMatcher as Matcher }
diff --git a/packages/vite/types/chokidar.d.ts b/packages/vite/types/chokidar.d.ts
@@ -29,6 +29,7 @@ THE SOFTWARE.
 /// <reference types="node" />
 
 import * as fs from 'fs'
+import { Matcher } from './anymatch'
 
 export interface FSWatcher extends fs.FSWatcher {
   options: WatchOptions
@@ -117,7 +118,7 @@ export interface WatchOptions {
    * (the path), second time with two arguments (the path and the
    * [`fs.Stats`](https://nodejs.org/api/fs.html#fs_class_fs_stats) object of that path).
    */
-  ignored?: any
+  ignored?: Matcher
 
   /**
    * If set to `false` then `add`/`addDir` events are also emitted for matching paths while