feat: add pattern and throttle options

README.md

@@ -64,9 +64,11 @@ Optionally, you can directly pass a runner or a list of runner to the plugin opt
 | `startup`       | `bool`                         | Whether the command should run when Vite starts                            | `true`  |
 | `name`          | `string`                       | An identifier for the runner, used in logs                                 |         |
 | `condition`     | `() => boolean`                | A function that should return true for a file change to execute the runner |         |
+| `pattern`       | `string` or `string[]`         | A minimatch pattern which files must match                                 |         |
 | `run`           | `() => string[]` or `string[]` | A command executed when a file changed and the condition matches           |         |
 | `onFileChanged` | `() =>void`                    | A callback executed when a file changed and the condition matches          |         |
 | `delay`         | `number`                       | Delay before the command is executed                                       | `50`    |
+| `throttle`      | `number`                       | Delay before the command can be re-executed                                | `50`    |
 
 <p align="center">
 	<br />

package.json

@@ -45,6 +45,7 @@
   "dependencies": {
     "@antfu/utils": "^0.5.2",
     "debug": "^4.3.4",
+    "minimatch": "^6.1.6",
     "picocolors": "^1.0.0"
   }
 }

src/run.ts

@@ -1,21 +1,20 @@
 import { spawn } from 'node:child_process'
+import path from 'node:path'
 import { loadEnv, Plugin } from 'vite'
 import makeDebugger from 'debug'
 import c from 'picocolors'
 import { toArray } from '@antfu/utils'
+import { minimatch } from 'minimatch'
 import type { Options, ResolvedRunOptions, Runner, RunnerHandlerParameters } from './types'
 
 const PLUGIN_NAME = 'vite:plugin:run'
 const debug = makeDebugger(PLUGIN_NAME)
+const throttles: Set<string> = new Set()
 
 function warn(prefix: string, message: string) {
 	process.stdout.write(c.bold(`${c.yellow(`(!) ${prefix}`)} ${message}\n`))
 }
 
-// function log(prefix: string, message: string) {
-// 	process.stdout.write(c.bold(`${c.cyan(`${prefix}`)} ${message}\n`))
-// }
-
 /**
  * Reload when some files are changed.
  */
@@ -51,16 +50,12 @@ export function run(options: Options = []): Plugin {
 				}
 			})
 		},
-		configureServer(server) {
-			server.watcher
-				.on('add', (path) => handleReload(resolvedOptions, { file: path, server, type: 'add' }))
-				.on('change', (path) => handleReload(resolvedOptions, { file: path, server, type: 'change' }))
-				.on('unlink', (path) => handleReload(resolvedOptions, { file: path, server, type: 'unlink' }))
-		},
-		handleHotUpdate({ file }) {
+		handleHotUpdate({ file, server }) {
 			if (resolvedOptions.skipDts && file.endsWith('.d.ts')) {
 				return []
 			}
+
+			handleReload(resolvedOptions, { file, server })
 		},
 	}
 }
@@ -73,12 +68,23 @@ function handleReload(options: ResolvedRunOptions, parameters: RunnerHandlerPara
 			return
 		}
 
-		debug(`${c.gray(file)} changed, applying its handler...`)
+		const patterns = !Array.isArray(runner.pattern)
+			? [runner.pattern!].filter(Boolean)
+			: runner.pattern
+
+		for (const pattern of patterns) {
+			if (!minimatch(file, path.resolve(parameters.server.config.root, pattern))) {
+				return
+			}
+		}
+
 		handleRunner(runner, options, parameters)
 	})
 }
 
 function handleRunner(runner: Runner, options: ResolvedRunOptions, parameters: RunnerHandlerParameters) {
+	debug(`${c.gray(parameters.file)} changed, applying its handler...`)
+
 	try {
 		if (typeof runner.onFileChanged === 'function') {
 			runner.onFileChanged?.(parameters)
@@ -99,9 +105,19 @@ function handleRunnerCommand(options: ResolvedRunOptions, runner: Runner) {
 	}
 
 	const name = getRunnerName(runner)
-	debug(`Running ${name}...`)
 
-	// Run after a delay
+	// Check throttles
+	if (throttles.has(name)) {
+		debug(`${name} is throttled.`)
+		return
+	}
+
+	// Throttles the runner
+	throttles.add(name)
+	setTimeout(() => throttles.delete(name), runner.throttle ?? 500)
+
+	// Runs the runner after the configured delay
+	debug(`Running ${name}...`)
 	setTimeout(() => {
 		const child = spawn(
 			getExecutable(options, getRunnerCommand(runner)),

src/types.ts

@@ -29,7 +29,6 @@ export type RunnerHandler = (parameters: RunnerHandlerParameters) => void
 export interface RunnerHandlerParameters {
 	file: string
 	server: ViteDevServer
-	type: 'add' | 'change' | 'unlink'
 }
 
 export interface Runner {
@@ -49,6 +48,11 @@ export interface Runner {
 	 */
 	condition?: (file: string) => boolean
 
+	/**
+	 * File changes must correspond to the given minimatch pattern.
+	 */
+	pattern?: string | string[]
+
 	/**
 	 * Executed when a watched file meets the condition.
 	 */
@@ -64,4 +68,10 @@ export interface Runner {
    * @default 50 ms
    */
 	delay?: number
+
+	/**
+	 * Delay before the handler can be executed again (in ms)
+	 * @default 500 ms
+	 */
+	throttle?: number
 }