Skip to content

hardis:project:clean:manageditems

Description

Command Behavior

Removes unwanted managed package items from your Salesforce DX project sources.

This command helps clean up your local Salesforce project by deleting metadata files that belong to a specific managed package namespace. This is particularly useful when you retrieve metadata from an org that contains managed packages, and you only want to keep the unmanaged or custom metadata in your local repository.

Key functionalities:

  • Namespace-Based Filtering: Requires a --namespace flag to specify which managed package namespace's files should be removed.
  • Targeted File Deletion: Scans for files and folders that start with the specified namespace prefix (e.g., yourNamespace__*).
  • Intelligent Folder Handling: Prevents the deletion of managed folders if they contain local custom items. This ensures that if you have custom metadata within a managed package's folder structure, only the managed components are removed, preserving your local customizations.
  • Object Metadata Preservation: Specifically, it will not remove .object-meta.xml files if there are local custom items defined within that object's folder.
Technical explanations

The command's technical implementation involves:

  • Namespace Validation: Ensures that a namespace is provided, throwing an SfError if it's missing.
  • File Discovery: Uses glob to find all files and directories within the specified folder (defaults to force-app) that match the managed package namespace pattern (**/${this.namespace}__*).
  • Folder Content Check: For identified managed folders, the folderContainsLocalItems function is called. This function uses glob again to check for the presence of any files within that folder that do not start with the managed package namespace, indicating local customizations.
  • Conditional Deletion: Based on the folderContainsLocalItems check, it conditionally removes files and folders using fs.remove. If a managed folder contains local items, it is skipped to prevent accidental deletion of custom work.
  • Logging: Provides clear messages about which managed items are being removed.

Parameters

Name Type Description Default Required Options
debug
-d		 boolean Activate debug mode (more logs)
flags-dir option undefined
folder
-f		 option Root folder force-app
json boolean Format output as json.
namespace
-n		 option Namespace to remove
skipauth boolean Skip authentication check when a default username is required
websocket option Websocket host:port for VsCode SFDX Hardis UI integration

Examples

$ sf hardis:project:clean:manageditems --namespace crta