Vite-plugin-watch NPM

Vite Watcher Runner

A Vite plugin that runs custom shell commands on file changes.

Installation

You can install the package via npm or yarn:

npm i -D vite-plugin-watch
# or
yarn add -D vite-plugin-watch

Usage

Import the package from vite.config.js and configure it.

import { defineConfig } from "vite"
import { watch } from "vite-plugin-watch"

export default defineConfig({
  plugins: [ 
    watch({
      pattern: "app/{Data,Enums}/**/*.php",
      command: "php artisan typescript:transform",
    }),
  ],
})

Once a tracked file changes, the plugin will execute a specified command.

The paths of tracked files are configured as glob patterns:

Use * to match anything except slashes and hidden files
Use ** to match zero or more directories
Use comma separate values between {} to match against a list of options

Plugin options

name	type	description	default
pattern	string\|string[]	Tracked files paths
command	string\|string[]	One or multiple command(s) to be executed on file change
timeout	number	Timeout between triggering the same command	500
silent	boolean	Hide the output in the console	false
onInit	boolean	Run the command on Vite start	true

Advanced Inertia

Take your Inertia.js skills to the next level with my book Advanced Inertia. Learn advanced concepts and make apps with Laravel and Inertia.js a breeze to build and maintain.