Skip to content

hardis:project:clean:xml

Description

Remove XML elements using Glob patterns and XPath expressions

This can be very useful to avoid to always remove manually the same elements in the same XML file.

  • globpattern can be any glob pattern allowing to identify the XML files to update, for example /**/*.flexipage-meta.xml
  • xpath can be any xpath following the format //ns:PARENT-TAG-NAME//ns:TAG-NAME[contains(text(),'TAG-VALUE')]. If an element is found, the whole PARENT-TAG-NAME (with its subtree) will be removed.

How to build cleaning XPath

Note: If globpattern and xpath are not sent, elements defined in property cleanXmlPatterns in .sfdx-hardis.yml config file will be used

Parameters

Name Type Description Default Required Options
debug
-d
boolean Activate debug mode (more logs)
folder
-f
option Root folder force-app
globpattern
-p
option Glob pattern to find files to clean. Ex: /*/.flexipage-meta.xml
json boolean format output as json
loglevel option logging level for this command invocation warn trace
debug
info
warn
error
fatal
namespace
-n
option XML Namespace to use http://soap.sforce.com/2006/04/metadata
skipauth boolean Skip authentication check when a default username is required
websocket option Websocket host:port for VsCode SFDX Hardis UI integration
xpath
-x
option XPath to use to detect the elements to remove. Ex: //ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]

Examples

$ sfdx hardis:project:clean:xml
$ sfdx hardis:project:clean:xml --globpattern "/**/*.flexipage-meta.xml" --xpath "//ns:flexiPageRegions//ns:name[contains(text(),'dashboardName')]"