You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@jackrabbit.apache.org by "Dirk Rudolph (JIRA)" <ji...@apache.org> on 2018/02/15 16:28:00 UTC

[jira] [Created] (JCRVLT-271) Support a CLI command to format vault xml files

Dirk Rudolph created JCRVLT-271:
-----------------------------------

             Summary: Support a CLI command to format vault xml files
                 Key: JCRVLT-271
                 URL: https://issues.apache.org/jira/browse/JCRVLT-271
             Project: Jackrabbit FileVault
          Issue Type: New Feature
          Components: Misc
            Reporter: Dirk Rudolph


In our projects we work with vlt IDE integrations (Intellij and Eclpise) to have a easy and feature rich development process. On the other hand there are situations where we are writing vlt xml files manually. To not have huge diffs of formatting changes we tend to commit those vlt xml files formatted in the way as they are produced by exporting the corresponding nodes from a remote repository.

Unfortunately the format can not fully be achieved by formatting using the build in xml formatters of the IDE, nor am I aware of any tooling that would allow us to check the formatting using lets say a commit hook or maven plugin. So the common approach we use at the moment is to push and afterwards pull nodes to or from the remote repository. 

To improve that, only formatting the local files with the format the export uses is much more efficient and can also be automated. 

This is a proposal to introduce a _format_ command for the vlt-cli that:
 * accepts a list of file patterns that should be processed in the current directory tree
 * formats each file included by the patterns or
 * checks if the file is in the right format and fails if not with a list of all malformed files

This can then be used to:
 * automatically format by cli invocation
 * validate the format during build or as pre commit hook



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)