Skip to content

Latest commit

 

History

History
53 lines (30 loc) · 1.51 KB

cmd_xmlformat.rst

File metadata and controls

53 lines (30 loc) · 1.51 KB
Raw

ksconf xml-format

Pre-commit hooks

See ksconf_pre_commit for more information about how the xml-format command can be integrated in your git workflow.

NOTE: While it may work on other XML files, it hasn't been tested for other files, and therefore is not recommended as a general-purpose XML formatter. Specific awareness of various Simple XML tags is baked into this product.

Note

This command requires the external lxml Python module.

This package was specifically selected (over the built-in 'xml.etree' interface) because it (1) supports round-trip preservation of CDATA blocks, and (2) already ships with Splunk's embedded Python.

This is an optional requirement, unless you want to use the xml-format command. However, due to packaging limitations and pre-commit hook support, installation of the python package will result in an attempt to install lxml as well. Please reach out <contact_us> if this is causing issues for you; I'm looking into other options too.

Why is this important?

TODO: Note the value of using <!CDATA[[ ]]> blocks.

Value of consistent indentation.

To recursively format xml files

find . -path '*/data/ui/views/*.xml' -o -path '*/data/ui/nav/*.xml' | ksconf xml-format -