Acna 3518 clean all build artifacts (#858)

dthampy · Jesse MacFadyen · commit ae3117d5804f · 2025-11-10T12:43:18.000-08:00
* feat: add initial commit for clean command

* fix:  fix the dist directory path

* chore: update readme

* fix: lint errors

* chore: fixing tests and adding missing coverage

* chore: add additional test coverage

* fix: lint error

* fix: remove unnecessary comments

* feat: add 100% coverage

* fix: comments

* fix: added the missing lint fix

* fix: refactored to simplify the command to clean all the artifacts to give a clean state

* fix: lint errors

* fix: extracted tracking filenames into separate constants for future maintenance

* fix: revert README changes from local prepack script run
diff --git a/README.md b/README.md
@@ -1,5 +1,4 @@
-aio-cli-plugin-app
-==================
+# aio-cli-plugin-app
 
 Create, Build and Deploy Adobe I/O Apps
 
@@ -10,13 +9,14 @@ Create, Build and Deploy Adobe I/O Apps
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-app/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-app/)
 
-
 <!-- toc -->
-* [Usage](#usage)
-* [Commands](#commands)
+
+- [Usage](#usage)
+- [Commands](#commands)
 <!-- tocstop -->
 
 # Usage
+
 ```sh-session
 $ aio plugins:install -g @adobe/aio-cli-plugin-app
 $ # OR
@@ -25,36 +25,38 @@ $ aio app --help
 ```
 
 # Commands
+
 <!-- commands -->
-* [`aio app`](#aio-app)
-* [`aio app add`](#aio-app-add)
-* [`aio app add action`](#aio-app-add-action)
-* [`aio app add ci`](#aio-app-add-ci)
-* [`aio app add event`](#aio-app-add-event)
-* [`aio app add extension`](#aio-app-add-extension)
-* [`aio app add service`](#aio-app-add-service)
-* [`aio app add web-assets`](#aio-app-add-web-assets)
-* [`aio app build`](#aio-app-build)
-* [`aio app create [PATH]`](#aio-app-create-path)
-* [`aio app delete`](#aio-app-delete)
-* [`aio app delete action [ACTION-NAME]`](#aio-app-delete-action-action-name)
-* [`aio app delete ci`](#aio-app-delete-ci)
-* [`aio app delete extension`](#aio-app-delete-extension)
-* [`aio app delete service`](#aio-app-delete-service)
-* [`aio app delete web-assets`](#aio-app-delete-web-assets)
-* [`aio app deploy`](#aio-app-deploy)
-* [`aio app get-url [ACTION]`](#aio-app-get-url-action)
-* [`aio app info`](#aio-app-info)
-* [`aio app init [PATH]`](#aio-app-init-path)
-* [`aio app install PATH`](#aio-app-install-path)
-* [`aio app list`](#aio-app-list)
-* [`aio app list extension`](#aio-app-list-extension)
-* [`aio app logs`](#aio-app-logs)
-* [`aio app pack [PATH]`](#aio-app-pack-path)
-* [`aio app run`](#aio-app-run)
-* [`aio app test`](#aio-app-test)
-* [`aio app undeploy`](#aio-app-undeploy)
-* [`aio app use [CONFIG_FILE_PATH]`](#aio-app-use-config_file_path)
+
+- [`aio app`](#aio-app)
+- [`aio app add`](#aio-app-add)
+- [`aio app add action`](#aio-app-add-action)
+- [`aio app add ci`](#aio-app-add-ci)
+- [`aio app add event`](#aio-app-add-event)
+- [`aio app add extension`](#aio-app-add-extension)
+- [`aio app add service`](#aio-app-add-service)
+- [`aio app add web-assets`](#aio-app-add-web-assets)
+- [`aio app build`](#aio-app-build)
+- [`aio app create [PATH]`](#aio-app-create-path)
+- [`aio app delete`](#aio-app-delete)
+- [`aio app delete action [ACTION-NAME]`](#aio-app-delete-action-action-name)
+- [`aio app delete ci`](#aio-app-delete-ci)
+- [`aio app delete extension`](#aio-app-delete-extension)
+- [`aio app delete service`](#aio-app-delete-service)
+- [`aio app delete web-assets`](#aio-app-delete-web-assets)
+- [`aio app deploy`](#aio-app-deploy)
+- [`aio app get-url [ACTION]`](#aio-app-get-url-action)
+- [`aio app info`](#aio-app-info)
+- [`aio app init [PATH]`](#aio-app-init-path)
+- [`aio app install PATH`](#aio-app-install-path)
+- [`aio app list`](#aio-app-list)
+- [`aio app list extension`](#aio-app-list-extension)
+- [`aio app logs`](#aio-app-logs)
+- [`aio app pack [PATH]`](#aio-app-pack-path)
+- [`aio app run`](#aio-app-run)
+- [`aio app test`](#aio-app-test)
+- [`aio app undeploy`](#aio-app-undeploy)
+- [`aio app use [CONFIG_FILE_PATH]`](#aio-app-use-config_file_path)
 
 ## `aio app`
 
@@ -810,4 +812,5 @@ DESCRIPTION
 ```
 
 _See code: [src/commands/app/use.js](https://github.com/adobe/aio-cli-plugin-app/blob/13.3.0/src/commands/app/use.js)_
+
 <!-- commandsstop -->
diff --git a/src/commands/app/build.js b/src/commands/app/build.js
@@ -79,7 +79,7 @@ class Build extends BaseCommand {
           aioLogger.debug(`run hook for 'build-actions' for actions in '${name}' returned ${script}`)
           spinner.start(`Building actions for '${name}'`)
           if (!script) {
-            builtList = await RuntimeLib.buildActions(config, filterActions, flags['force-build']) // skipCheck is false
+            builtList = await RuntimeLib.buildActions(config, filterActions, flags['force-build'])
           }
           if (builtList.length > 0) {
             spinner.succeed(chalk.green(`Built ${builtList.length} action(s) for '${name}'`))
diff --git a/src/commands/app/clean-build.js b/src/commands/app/clean-build.js
@@ -0,0 +1,110 @@
+/*
+Copyright 2025 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+
+const ora = require('ora')
+const chalk = require('chalk')
+const fs = require('fs-extra')
+const path = require('path')
+
+const BaseCommand = require('../../BaseCommand')
+const aioLogger = require('@adobe/aio-lib-core-logging')('@adobe/aio-cli-plugin-app:clean-build', { provider: 'debug' })
+const { LAST_BUILT_ACTIONS_FILENAME, LAST_DEPLOYED_ACTIONS_FILENAME } = require('../../lib/defaults')
+
+class CleanBuild extends BaseCommand {
+  async run () {
+    const { flags } = await this.parse(CleanBuild)
+    const configs = await this.getAppExtConfigs(flags)
+
+    const spinner = ora()
+
+    try {
+      for (const [name, config] of Object.entries(configs)) {
+        await this.cleanAllBuildArtifacts(name, config, spinner)
+      }
+
+      this.log(chalk.green(chalk.bold('Build artifacts cleaned up successfully!')))
+    } catch (error) {
+      spinner.stop()
+      throw error
+    }
+  }
+
+  async cleanAllBuildArtifacts (name, config, spinner) {
+    try {
+      spinner.start(`Cleaning build artifacts for '${name}'`)
+
+      if (!config || !config.root) {
+        spinner.info(`No root directory found for extension '${name}'`)
+        return
+      }
+
+      const locations = []
+
+      if (config.app && config.app.dist && fs.existsSync(config.app.dist)) {
+        locations.push(config.app.dist)
+      }
+
+      if (config.dist && fs.existsSync(config.dist)) {
+        locations.push(config.dist)
+      }
+
+      const rootDist = path.join(config.root, 'dist')
+      if (fs.existsSync(rootDist)) {
+        locations.push(rootDist)
+      }
+
+      aioLogger.debug(`Cleaning locations for ${name}: ${locations.join(', ')}`)
+
+      // Clean all possible locations
+      for (const location of locations) {
+        // First try to remove tracking files explicitly
+        const builtPath = path.join(location, LAST_BUILT_ACTIONS_FILENAME)
+        const deployedPath = path.join(location, LAST_DEPLOYED_ACTIONS_FILENAME)
+
+        if (fs.existsSync(builtPath)) {
+          await fs.remove(builtPath)
+          aioLogger.debug(`Removed tracking file: ${builtPath}`)
+        }
+
+        if (fs.existsSync(deployedPath)) {
+          await fs.remove(deployedPath)
+          aioLogger.debug(`Removed tracking file: ${deployedPath}`)
+        }
+
+        // Then empty the directory
+        await fs.emptyDir(location)
+        aioLogger.debug(`Emptied directory: ${location}`)
+      }
+
+      spinner.succeed(chalk.green(`Cleaned build artifacts for '${name}'`))
+    } catch (err) {
+      aioLogger.debug(`Error cleaning artifacts for ${name}: ${err.message}`)
+      spinner.fail(chalk.red(`Failed to clean build artifacts for '${name}': ${err.message}`))
+      throw err
+    }
+  }
+}
+
+CleanBuild.description = `Remove all build artifacts from the local machine
+This command completely cleans all build artifacts from the dist directory including:
+- Action build files
+- Web assets (both production and development)
+- Build tracking files
+- Deployment tracking files
+
+Note that this will require a full rebuild on your next build command.`
+
+CleanBuild.flags = {
+  ...BaseCommand.flags
+}
+
+module.exports = CleanBuild
diff --git a/src/lib/defaults.js b/src/lib/defaults.js
@@ -36,5 +36,8 @@ module.exports = {
   LEGACY_RUNTIME_MANIFEST: 'manifest.yml',
   INCLUDE_DIRECTIVE: '$include',
   APPLICATION_CONFIG_KEY: 'application',
-  EXTENSIONS_CONFIG_KEY: 'extensions'
+  EXTENSIONS_CONFIG_KEY: 'extensions',
+  // Adding tracking file constants
+  LAST_BUILT_ACTIONS_FILENAME: 'last-built-actions.json',
+  LAST_DEPLOYED_ACTIONS_FILENAME: 'last-deployed-actions.json'
 }
diff --git a/test/commands/app/clean-build.test.js b/test/commands/app/clean-build.test.js

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ class Build extends BaseCommand {`
`79`	`79`	aioLogger.debug(`run hook for 'build-actions' for actions in '${name}' returned ${script}`)
`80`	`80`	spinner.start(`Building actions for '${name}'`)
`81`	`81`	`if (!script) {`
`82`		`- builtList = await RuntimeLib.buildActions(config, filterActions, flags['force-build']) // skipCheck is false`
	`82`	`+ builtList = await RuntimeLib.buildActions(config, filterActions, flags['force-build'])`
`83`	`83`	`}`
`84`	`84`	`if (builtList.length > 0) {`
`85`	`85`	spinner.succeed(chalk.green(`Built ${builtList.length} action(s) for '${name}'`))