feat(server): add strict-port option (#1453)

docs/config/index.md

@@ -215,6 +215,12 @@ export default ({ command, mode }) => {
 
   Specify server port. Note if the port is already being used, Vite will automatically try the next available port so this may not be the actual port the server ends up listening on.
 
+### server.strictPort
+
+- **Type:** `boolean`
+
+  Set to `true` to exit if port is already in use, instead of automatically try the next available port.
+
 ### server.https
 
 - **Type:** `boolean | https.ServerOptions`

packages/vite/src/node/cli.ts

@@ -61,6 +61,7 @@ cli
   .option('--https', `[boolean] use TLS + HTTP/2`)
   .option('--open [browser]', `[boolean | string] open browser on startup`)
   .option('--cors', `[boolean] enable CORS`)
+  .option('--strict-port', `[boolean] exit if specified port is already in use`)
   .option('-m, --mode <mode>', `[string] set env mode`)
   .option(
     '--force',

packages/vite/src/node/server/index.ts

@@ -98,6 +98,10 @@ export interface ServerOptions {
    * using an object.
    */
   cors?: CorsOptions | boolean
+  /**
+   * If enabled, vite will exit if specified port is already in use
+   */
+  strictPort?: boolean
 }
 
 /**
@@ -402,8 +406,13 @@ async function startServer(
   return new Promise((resolve, reject) => {
     const onError = (e: Error & { code?: string }) => {
       if (e.code === 'EADDRINUSE') {
-        info(`Port ${port} is in use, trying another one...`)
-        httpServer.listen(++port)
+        if (options.strictPort) {
+          httpServer.removeListener('error', onError)
+          reject(new Error(`Port ${port} is already in use`))
+        } else {
+          info(`Port ${port} is in use, trying another one...`)
+          httpServer.listen(++port)
+        }
       } else {
         httpServer.removeListener('error', onError)
         reject(e)