feat: require explicit option to empty outDir when it is out of root

close #1501
vitejs · Jan 12, 2021 · 730d2f0 · 730d2f0
1 parent a09a030
commit 730d2f0
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 2 deletions.
diff --git a/docs/config/index.md b/docs/config/index.md
@@ -415,6 +415,13 @@ export default ({ command, mode }) => {
 
   Set to `false` to disable writing the bundle to disk. This is mostly used in [programmatic `build()` calls](/guide/api-javascript#build) where further post processing of the bundle is needed before writing to disk.
 
+### build.emptyOutDir
+
+- **Type:** `boolean`
+- **Default:** `true` if `outDir` is inside `root`
+
+  By default, Vite will empty the `outDir` on build if it is inside project root. It will emit a warning if `outDir` is outside of root to avoid accidentially removing important files. You can explicitly set this option to suppress the warning. This is also available via command line as `--emptyOutDir`.
+
 ## Dep Optimization Options
 
 - **Related:** [Dependency Pre-Bundling](/guide/dep-pre-bundling)

diff --git a/packages/vite/package.json b/packages/vite/package.json
@@ -85,6 +85,7 @@
     "debug": "^4.3.1",
     "dotenv": "^8.2.0",
     "dotenv-expand": "^5.1.0",
+    "enquirer": "^2.3.6",
     "es-module-lexer": "^0.3.26",
     "etag": "^1.8.1",
     "execa": "^5.0.0",

diff --git a/packages/vite/src/node/build.ts b/packages/vite/src/node/build.ts
@@ -17,7 +17,7 @@ import { buildHtmlPlugin } from './plugins/html'
 import { buildEsbuildPlugin } from './plugins/esbuild'
 import { terserPlugin } from './plugins/terser'
 import { Terser } from 'types/terser'
-import { copyDir, emptyDir, lookupFile } from './utils'
+import { copyDir, emptyDir, lookupFile, normalizePath } from './utils'
 import { manifestPlugin } from './plugins/manifest'
 import commonjsPlugin from '@rollup/plugin-commonjs'
 import { RollupCommonJSOptions } from 'types/commonjs'
@@ -118,6 +118,11 @@ export interface BuildOptions {
    * @default true
    */
   write?: boolean
+  /**
+   * Empty outDir on write.
+   * @default true when outDir is a sub directory of project root
+   */
+  emptyOutDir?: boolean | null
   /**
    * Whether to emit a manifest.json under assets dir to map hash-less filenames
    * to their hashed versions. Useful when you want to generate your own HTML
@@ -176,6 +181,7 @@ export function resolveBuildOptions(
     terserOptions: {},
     cleanCssOptions: {},
     write: true,
+    emptyOutDir: null,
     manifest: false,
     lib: false,
     ssr: false,
@@ -319,7 +325,25 @@ async function doBuild(
     }
 
     if (options.write) {
-      emptyDir(outDir)
+      // warn if outDir is outside of root
+      if (fs.existsSync(outDir)) {
+        const inferEmpty = options.emptyOutDir === null
+        if (
+          options.emptyOutDir ||
+          (inferEmpty && normalizePath(outDir).startsWith(config.root + '/'))
+        ) {
+          emptyDir(outDir)
+        } else if (inferEmpty) {
+          config.logger.warn(
+            chalk.yellow(
+              `\n${chalk.bold(`(!)`)} outDir ${chalk.white.dim(
+                outDir
+              )} is not inside project root and will not be emptied.\n` +
+                `Use --emptyOutDir to override.\n`
+            )
+          )
+        }
+      }
       if (fs.existsSync(publicDir)) {
         copyDir(publicDir, outDir)
       }

diff --git a/packages/vite/src/node/cli.ts b/packages/vite/src/node/cli.ts
@@ -112,6 +112,10 @@ cli
       `or specify minifier to use (default: terser)`
   )
   .option('--manifest', `[boolean] emit build manifest json`)
+  .option(
+    '--emptyOutDir',
+    `[boolean] force empty outDir when it's outside of root`
+  )
   .option('-m, --mode <mode>', `[string] set env mode`)
   .action(async (root: string, options: BuildOptions & GlobalCLIOptions) => {
     const { build } = await import('./build')