feat: --success arg (#659)

README.md

@@ -282,7 +282,7 @@ This convention keeps shared modules private while enabling efficient bundling a
 
 ### CLI
 
-#### CLI Options
+#### Options
 
 `bunchee` CLI provides few options to create different bundles or generating types. Call `bunchee --help` to see the help information in the terminal.
 
@@ -317,6 +317,14 @@ bunchee --no-external
 
 This will include all dependencies within your output bundle.
 
+#### Build Successful Command
+
+A command to be executed after a build is successful can be specified using the `--success` option, which is useful for development watching mode:
+
+```sh
+bunchee --watch --success "node ./dist/index.js"
+```
+
 #### Prepare Package
 
 ```sh

src/bin/index.ts

@@ -39,6 +39,7 @@ Options:
   --no-dts               do not generate types, default: undefined
   --tsconfig             path to tsconfig file, default: tsconfig.json
   --dts-bundle           bundle type declaration files, default: false
+  --success <cmd>     run command after build success
 `
 
 function help() {
@@ -135,6 +136,10 @@ async function parseCliArgs(argv: string[]) {
       type: 'boolean',
       description: 'auto setup package.json for building',
     })
+    .option('success', {
+      type: 'string',
+      description: 'run command after build success',
+    })
     .command(
       'prepare',
       'auto configure package.json exports for building',
@@ -193,6 +198,7 @@ async function parseCliArgs(argv: string[]) {
     clean: args['clean'] !== false,
     env: args['env'],
     tsconfig: args['tsconfig'],
+    onSuccess: args['success'],
   }
 
   // When minify is enabled, sourcemap should be enabled by default, unless explicitly opted out
@@ -222,6 +228,7 @@ async function run(args: CliArgs) {
     env,
     clean,
     tsconfig,
+    onSuccess,
   } = args
   const cwd = args.cwd || process.cwd()
   const file = args.file ? path.resolve(cwd, args.file) : undefined
@@ -243,6 +250,7 @@ async function run(args: CliArgs) {
     env: env?.split(',') || [],
     clean,
     tsconfig,
+    onSuccess,
   }
 
   const cliEntry = source ? path.resolve(cwd, source) : ''

src/bundle.ts

@@ -23,6 +23,7 @@ import {
 } from './typescript'
 import { collectEntriesFromParsedExports } from './entries'
 import { createAssetRollupJobs } from './rollup-job'
+import { spawn } from 'child_process'
 
 function assignDefault(
   options: BundleConfig,
@@ -46,7 +47,7 @@ function hasMultiEntryExport(exportPaths: object): boolean {
 
 async function bundle(
   cliEntryPath: string,
-  { cwd: _cwd, ...options }: BundleConfig = {},
+  { cwd: _cwd, onSuccess, ...options }: BundleConfig = {},
 ): Promise<void> {
   const cwd = resolve(process.cwd(), _cwd || '')
   assignDefault(options, 'format', 'esm')
@@ -181,6 +182,24 @@ async function bundle(
     )
 
     options._callbacks?.onBuildEnd?.(assetJobs)
+
+    // Finished building successfully
+    if (onSuccess) {
+      if (typeof onSuccess === 'string') {
+        const successProg = spawn(onSuccess, {
+          shell: true,
+          stdio: 'inherit',
+          cwd,
+        })
+        successProg.on('exit', (code) => {
+          if (code) {
+            process.exitCode = code
+          }
+        })
+      } else {
+        await onSuccess()
+      }
+    }
   } catch (error) {
     options._callbacks?.onBuildError?.(error)
     return Promise.reject(error)

src/types.ts

@@ -44,6 +44,7 @@ type BundleConfig = {
   pkg?: PackageMetadata
   clean?: boolean
   tsconfig?: string
+  onSuccess?: string | (() => void | Promise<void>)
 
   // hooks
   /*
@@ -107,6 +108,7 @@ type CliArgs = {
   prepare?: boolean
   clean?: boolean
   tsconfig?: string
+  onSuccess?: string
 }
 
 type BundleOptions = BundleConfig

test/integration/success-cmd/index.test.ts

@@ -0,0 +1,15 @@
+import { describe, expect, it } from 'vitest'
+import { createJob } from '../../testing-utils'
+
+describe('integration - success arg', () => {
+  const { job } = createJob({
+    directory: __dirname,
+    args: ['--success', 'node dist/index.js'],
+  })
+
+  it('should work', async () => {
+    console.log(job.stdout + job.stderr)
+    expect(job.code).toBe(0)
+    expect(job.stdout).toContain('Log from --success')
+  })
+})

test/integration/success-cmd/package.json

@@ -0,0 +1,5 @@
+{
+  "name": "on-success",
+  "main": "./dist/index.js",
+  "type": "module"
+}

test/integration/success-cmd/src/index.js

@@ -0,0 +1,5 @@
+function main() {
+  console.log('Log from --success')
+}
+
+main()