vite-plugin-stopdev
v1.3.2
Published
Vite plugin to stop the dev server
Downloads
8
Readme
vite-plugin-stopdev
Stops your (local or CI)-Vite development server after a given time or a given time of inactivity. With a callback to use before the dev server is stopped and another to use before the node process is terminated. Usefull to run tests on development server with to let the development server run forever. Or to prevent your dev server from running for days on your local maschine.
Install
node version: >=12.0.0
vite version: >=2.0.0
# if using npm
npm i vite-plugin-stopdev -D
# if using yarn
yarn add vite-plugin-stopdev -D
Usage
Config plugin in vite.config.ts with a fix time to die or an object with options
import { defineConfig } from 'vite'
import stopdev from 'vite-plugin-stopdev'
// in commonjs use require ->
// const stopdev = require('vite-plugin-stopdev').default
export default defineConfig({
plugins: [
// kills the dev server after 5 secounds
stopdev()
]
})
import { defineConfig } from 'vite'
import stopdev from 'vite-plugin-stopdev'
export default defineConfig({
plugins: [
stopdev({
// kills the dev server after 3 secounds
// this property will be ignored when afterIdle is set
stopTime: 3000,
// kills the dev server after 2 hours without an http request
afterIdleHours: 2,
// afterIdle will be ignored when afterIdleHours is set
afterIdle: 6000,
// will be called with await before the dev server will be stopped
// a good place to run tests with await
beforeStop: () => {
console.log('goint to stop vite dev server')
},
// will be called with await after the dev server was stopped and before the node process will be exited
afterStop: () => {
console.log('stopped vite dev server')
}
} as stopdevOptions)
]
})
Exported types by Module
type stopdevOptions = {
stopTime?: number
beforeStop?: () => void
afterStop?: () => void
afterIdle?: number
afterIdleHours?: number
}
License
MIT