Add dry run feature

Author: ernilambar

README.md

@@ -24,10 +24,13 @@ CLI sub-commands:
 npx wp-deployer --help
 npx wp-deployer --version
 npx wp-deployer --assets
+npx wp-deployer --dry-run
 ```
 
 Use `--assets` when you only want to push the assets directory (e.g. screenshots, banner) to WordPress.org and skip trunk and tag deployment.
 
+Use `--dry-run` to run checkout, clear/copy, and local `svn add` / `svn delete` preparation only. No `svn commit` or remote tag copy runs, so nothing is pushed—useful to inspect the working copy before a real deploy.
+
 Or add a script to `package.json` and run it:
 
 ```sh

index.js

@@ -28,7 +28,7 @@ const exec = promisify(execCb)
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
 const argv = minimist(process.argv.slice(2), {
-  boolean: ['help', 'version', 'assets'],
+  boolean: ['help', 'version', 'assets', 'dry-run'],
   alias: { h: 'help', v: 'version' }
 })
 
@@ -41,6 +41,7 @@ Options:
   --help, -h        Show this message
   --version, -v     Print wp-deployer version
   --assets          Deploy only the assets directory (plugin only; skips trunk and tag)
+  --dry-run         Prepare working copy and local SVN changes only; no commit or remote tag copy
 `)
 }
 
@@ -71,6 +72,10 @@ process.on('SIGINT', () => {
 })
 
 const wpDeployer = async () => {
+  const dryRun = Boolean(argv['dry-run'])
+  if (dryRun) {
+    console.log(chalk.yellow('Dry run: SVN checkout and local prep will run; commits and remote operations are skipped.'))
+  }
   console.log(chalk.cyan('Processing...'))
 
   let { settings, error, errorMessage } = resolveSettings(pkg)
@@ -130,7 +135,7 @@ const wpDeployer = async () => {
     throw e
   }
 
-  const helpers = { exec, fs, awk, noRunIfEmpty }
+  const helpers = { exec, fs, awk, noRunIfEmpty, dryRun }
   const steps = settings.repoType === 'plugin'
     ? createPluginSteps(settings, helpers)
     : createThemeSteps(settings, helpers)
@@ -140,7 +145,11 @@ const wpDeployer = async () => {
     for (const step of steps) {
       s = await step(s)
     }
-    console.log(chalk.green('Finished successfully.'))
+    if (dryRun) {
+      console.log(chalk.green('Dry run finished — working copy prepared; no changes were pushed to WordPress.org.'))
+    } else {
+      console.log(chalk.green('Finished successfully.'))
+    }
     return EXIT_SUCCESS
   } catch (err) {
     console.error(chalk.red(err?.message || err))

lib/steps.js

@@ -14,7 +14,7 @@ function copyDirectory (fs, srcDir, destDir) {
   fs.copySync(srcDir, destDir)
 }
 
-export function createPluginSteps (settings, { exec, fs, awk, noRunIfEmpty }) {
+export function createPluginSteps (settings, { exec, fs, awk, noRunIfEmpty, dryRun = false }) {
   const clearTrunk = (s) => {
     return async function (s) {
       console.log('Clearing trunk.')
@@ -111,19 +111,19 @@ export function createPluginSteps (settings, { exec, fs, awk, noRunIfEmpty }) {
     settings.deployTrunk ? clearTrunk(settings) : null,
     settings.deployTrunk ? copyBuild(settings) : null,
     settings.deployTrunk ? addFiles(settings) : null,
-    settings.deployTrunk ? commitToTrunk(settings) : null,
-    settings.deployTag ? commitTag(settings) : null,
+    settings.deployTrunk && !dryRun ? commitToTrunk(settings) : null,
+    settings.deployTag && !dryRun ? commitTag(settings) : null,
     settings.deployAssets ? checkoutDir('assets', settings) : null,
     settings.deployAssets ? clearAssets(settings) : null,
     settings.deployAssets ? copyAssets(settings) : null,
     settings.deployAssets ? addAssets(settings) : null,
-    settings.deployAssets ? commitToAssets(settings) : null
+    settings.deployAssets && !dryRun ? commitToAssets(settings) : null
   ].filter(function (val) { return val !== null })
 
   return steps
 }
 
-export function createThemeSteps (settings, { exec, fs, awk, noRunIfEmpty }) {
+export function createThemeSteps (settings, { exec, fs, awk, noRunIfEmpty, dryRun = false }) {
   const prepareThemeTmp = (s) => {
     return async function (s) {
       console.log('Preparing temporary folder.')
@@ -195,8 +195,8 @@ export function createThemeSteps (settings, { exec, fs, awk, noRunIfEmpty }) {
     clearTheme(settings),
     copyTheme(settings),
     addThemeFiles(settings),
-    commitTheme(settings)
-  ]
+    dryRun ? null : commitTheme(settings)
+  ].filter(function (val) { return val !== null })
 
   return steps
 }

test/cli-flags.test.js

@@ -41,4 +41,10 @@ describe('CLI flags', () => {
     assert.strictEqual(r.status, 0, r.stderr)
     assert.match(r.stdout, /--assets\b/)
   })
+
+  it('--help documents --dry-run', () => {
+    const r = spawnSync(process.execPath, [indexJs, '--help'], { encoding: 'utf8' })
+    assert.strictEqual(r.status, 0, r.stderr)
+    assert.match(r.stdout, /--dry-run\b/)
+  })
 })

test/steps.test.js

@@ -56,6 +56,35 @@ describe('createPluginSteps', () => {
     })
   })
 
+  it('plugin dry-run omits commit and remote tag; still checks out, clears, adds', async () => {
+    const fs = createRecordingFs()
+    const exec = createRecordingExec()
+    const steps = createPluginSteps(baseSettings, { exec, fs, awk, noRunIfEmpty, dryRun: true })
+    let s = baseSettings
+    for (const step of steps) {
+      s = await step(s)
+    }
+
+    const trunk = path.join(svnPath, 'trunk')
+    const url = baseSettings.url
+    const addCmd =
+      'svn resolve --accept working -R . && svn status |awk \'/^[?]/{print $2}\' | xargs svn add;' +
+      'svn status | awk \'/^[!]/{print $2}\' | xargs svn delete;'
+
+    assert.deepStrictEqual(exec.calls, [
+      {
+        cmd: `svn co --force-interactive --username="jane" ${url}trunk/ ${trunk}`,
+        opts: { maxBuffer: baseSettings.maxBuffer }
+      },
+      { cmd: `rm -fr ${trunk}/*`, opts: {} },
+      { cmd: addCmd, opts: { cwd: trunk } }
+    ])
+
+    assert.deepStrictEqual(fs.copies, [
+      { src: 'dist/', dest: path.join(svnPath, 'trunk') + path.sep }
+    ])
+  })
+
   it('full plugin (deployTrunk + deployTag) runs expected exec commands and cwd', async () => {
     const fs = createRecordingFs()
     const exec = createRecordingExec()
@@ -135,6 +164,39 @@ describe('createPluginSteps', () => {
     ])
   })
 
+  it('plugin with deployAssets and dryRun skips trunk, tag, and assets commits', async () => {
+    const fs = createRecordingFs()
+    const exec = createRecordingExec()
+    const settings = { ...baseSettings, deployAssets: true }
+    const steps = createPluginSteps(settings, { exec, fs, awk, noRunIfEmpty, dryRun: true })
+    let s = settings
+    for (const step of steps) {
+      s = await step(s)
+    }
+
+    const trunk = path.join(svnPath, 'trunk')
+    const assets = path.join(svnPath, 'assets')
+    const url = settings.url
+    const addCmd =
+      'svn resolve --accept working -R . && svn status |awk \'/^[?]/{print $2}\' | xargs svn add;' +
+      'svn status | awk \'/^[!]/{print $2}\' | xargs svn delete;'
+
+    assert.strictEqual(exec.calls.length, 6)
+    assert.strictEqual(exec.calls[0].cmd, `svn co --force-interactive --username="jane" ${url}trunk/ ${trunk}`)
+    assert.strictEqual(exec.calls[1].cmd, `rm -fr ${trunk}/*`)
+    assert.strictEqual(exec.calls[2].cmd, addCmd)
+    assert.strictEqual(exec.calls[2].opts.cwd, trunk)
+    assert.strictEqual(exec.calls[3].cmd, `svn co --force-interactive --username="jane" ${url}assets/ ${assets}`)
+    assert.strictEqual(exec.calls[4].cmd, `rm -fr ${assets}/*`)
+    assert.strictEqual(exec.calls[5].cmd, addCmd)
+    assert.strictEqual(exec.calls[5].opts.cwd, assets)
+
+    const noCommit = exec.calls.every((c) => !c.cmd.includes('svn commit'))
+    assert.strictEqual(noCommit, true)
+    const noRemoteTag = exec.calls.every((c) => !c.cmd.includes('tags/'))
+    assert.strictEqual(noRemoteTag, true)
+  })
+
   it('plugin with deployAssets true includes assets checkout, copy, svn add, commit with cwd', async () => {
     const fs = createRecordingFs()
     const exec = createRecordingExec()
@@ -221,6 +283,39 @@ describe('createThemeSteps', () => {
     })
   })
 
+  it('theme dry-run omits final svn commit', async () => {
+    const fs = createRecordingFs()
+    const exec = createRecordingExec()
+    const steps = createThemeSteps(baseSettings, { exec, fs, awk, noRunIfEmpty, dryRun: true })
+    let s = baseSettings
+    for (const step of steps) {
+      s = await step(s)
+    }
+
+    const verDir = path.join(svnPath, baseSettings.newVersion)
+    const addCmd =
+      'svn resolve --accept working -R . && svn status |awk \'/^[?]/{print $2}\' | xargs svn add;' +
+      'svn status | awk \'/^[!]/{print $2}\' | xargs svn delete;'
+
+    assert.deepStrictEqual(exec.calls, [
+      { cmd: `rm -fr ${svnPath}`, opts: {} },
+      {
+        cmd: `svn co --force-interactive --username="jane" ${baseSettings.url}/ ${svnPath}`,
+        opts: { maxBuffer: baseSettings.maxBuffer }
+      },
+      {
+        cmd: 'svn copy 1.0.0 2.0.0',
+        opts: { cwd: svnPath }
+      },
+      { cmd: `rm -fr ${verDir}/*`, opts: {} },
+      { cmd: addCmd, opts: { cwd: verDir } }
+    ])
+
+    assert.deepStrictEqual(fs.copies, [
+      { src: 'dist/', dest: path.join(svnPath, '2.0.0') + path.sep }
+    ])
+  })
+
   it('theme pipeline runs expected exec commands, cwd, and copySync destinations', async () => {
     const fs = createRecordingFs()
     const exec = createRecordingExec()