feat: add --clean flag for build to auto rimraf dist

sanity-io · Apr 10, 2024 · 35b609a · 35b609a
1 parent 3f4f66e
commit 35b609a
Show file tree

Hide file tree

Showing 21 changed files with 41 additions and 19 deletions.
diff --git a/playground/babel-plugin/package.json b/playground/babel-plugin/package.json
@@ -17,7 +17,7 @@
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   },
   "devDependencies": {

diff --git a/playground/browser-bundle/package.json b/playground/browser-bundle/package.json
@@ -16,7 +16,7 @@
   },
   "main": "./dist/index.cjs",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   }
 }
diff --git a/playground/custom-dist/package.json b/playground/custom-dist/package.json
@@ -18,7 +18,7 @@
   "module": "./lib/index.esm.js",
   "types": "./lib/index.d.ts",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf lib"
   }
 }
diff --git a/playground/default-export/package.json b/playground/default-export/package.json
@@ -16,7 +16,7 @@
   },
   "main": "./dist/index.cjs",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   }
 }
diff --git a/playground/dummy-commonjs/package.json b/playground/dummy-commonjs/package.json
@@ -44,7 +44,7 @@
     "src"
   ],
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   }
 }
diff --git a/playground/dummy-lodash-es/package.json b/playground/dummy-lodash-es/package.json
@@ -22,7 +22,7 @@
     "src"
   ],
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist",
     "test": "node test.cjs && node test.mjs"
   },

diff --git a/playground/dummy-lodash/package.json b/playground/dummy-lodash/package.json
@@ -22,7 +22,7 @@
     "src"
   ],
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist",
     "test": "node test.cjs && node test.mjs"
   },

diff --git a/playground/dummy-module/package.json b/playground/dummy-module/package.json
@@ -51,7 +51,7 @@
     "src"
   ],
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   }
 }
diff --git a/playground/extra-bundles/package.json b/playground/extra-bundles/package.json
@@ -15,7 +15,7 @@
   },
   "main": "./dist/index.js",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   }
 }
diff --git a/playground/js/package.json b/playground/js/package.json
@@ -15,7 +15,7 @@
   },
   "main": "./dist/index.js",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   }
 }
diff --git a/playground/multi-export/package.json b/playground/multi-export/package.json
@@ -63,7 +63,7 @@
     }
   },
   "scripts": {
-    "build": "run-s clean && pkg build --strict && svelte-kit sync && svelte-package -i ./src/svelte -o dist-svelte && pkg check --strict",
+    "build": "pkg build --strict --clean && svelte-kit sync && svelte-package -i ./src/svelte -o dist-svelte && pkg check --strict",
     "clean": "rimraf dist"
   },
   "devDependencies": {

diff --git a/playground/multi-exports-commonjs/package.json b/playground/multi-exports-commonjs/package.json
@@ -35,7 +35,7 @@
     }
   },
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist plugin.js"
   }
 }
diff --git a/playground/reference-esm-only/package.json b/playground/reference-esm-only/package.json
@@ -41,7 +41,7 @@
     "src"
   ],
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   },
   "devDependencies": {

diff --git a/playground/styled-components-module/package.json b/playground/styled-components-module/package.json
@@ -21,7 +21,7 @@
     "src"
   ],
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist",
     "test": "node test.mjs"
   },

diff --git a/playground/ts-bundler/package.json b/playground/ts-bundler/package.json
@@ -17,7 +17,7 @@
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   }
 }
diff --git a/playground/ts-node16/package.json b/playground/ts-node16/package.json
@@ -17,7 +17,7 @@
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   }
 }
diff --git a/playground/ts/package.json b/playground/ts/package.json
@@ -17,7 +17,7 @@
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "check:types": "tsc",
     "clean": "rimraf dist"
   }

diff --git a/playground/use-client-directive/package.json b/playground/use-client-directive/package.json
@@ -18,7 +18,7 @@
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "run-s clean && pkg build --strict --check",
+    "build": "pkg build --strict --check --clean",
     "clean": "rimraf dist"
   },
   "devDependencies": {

diff --git a/src/cli/buildAction.ts b/src/cli/buildAction.ts
@@ -5,13 +5,15 @@ export async function buildAction(options: {
   emitDeclarationOnly?: boolean
   strict?: boolean
   tsconfig?: string
+  clean?: boolean
 }): Promise<void> {
   try {
     await build({
       cwd: process.cwd(),
       emitDeclarationOnly: options.emitDeclarationOnly,
       strict: options.strict,
       tsconfig: options.tsconfig,
+      clean: options.clean,
     })
   } catch (err) {
     handleError(err)

diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -21,6 +21,7 @@ cli
   .option('--strict', 'Strict mode')
   .option('--tsconfig [tsconfig]', '[string] tsconfig.json')
   .option('--check', 'Run the check command after build (same as running `pkg build && pkg check`)')
+  .option('--clean', 'Clean the dist directory before building')
   .action(async (options) => {
     const {check = false, ...buildOptions} = options
     const {buildAction} = await import('./buildAction')

diff --git a/src/node/build.ts b/src/node/build.ts
@@ -1,3 +1,7 @@
+import path from 'node:path'
+
+import rimraf from 'rimraf'
+
 import {loadConfig, loadPkgWithReporting} from './core'
 import {createLogger} from './logger'
 import {resolveBuildContext} from './resolveBuildContext'
@@ -29,11 +33,19 @@ export async function build(options: {
   emitDeclarationOnly?: boolean
   strict?: boolean
   tsconfig?: string
+  clean?: boolean
 }): Promise<void> {
-  const {cwd, emitDeclarationOnly, strict = false, tsconfig: tsconfigOption} = options
+  const {
+    cwd,
+    emitDeclarationOnly,
+    strict = false,
+    tsconfig: tsconfigOption,
+    clean = false,
+  } = options
   const logger = createLogger()
 
   const config = await loadConfig({cwd})
+
   const legacyExports = config?.legacyExports ?? false
   const pkg = await loadPkgWithReporting({cwd, logger, strict, legacyExports})
 
@@ -49,6 +61,13 @@ export async function build(options: {
     tsconfig,
   })
 
+  if (clean) {
+    logger.log(
+      `Cleaning the contents of the \`dist\` folder: './${path.relative(cwd, ctx.distPath)}'`,
+    )
+    await rimraf(ctx.distPath)
+  }
+
   const buildTasks = resolveBuildTasks(ctx)
 
   for (const task of buildTasks) {