refactor pipe script and improve debug mode

adobe / adobe-dx

A toolkit for AEM to help build exceptional digital experiences.

Apache License 2.0

35 stars 33 forks source link

refactor pipe script and improve debug mode #201

Closed lukdz closed 1 year ago

lukdz commented 1 year ago

Description

switch to long options to make command more readable
improve debug mode by using set -x, which does show how command arguments are split; echo outputs values without quotes, which makes it difficult to debug arguments split by incorrectly escaped whitespaces
fix indents

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

[x] I have signed the Adobe Open Source CLA.
[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[x] I have read the CONTRIBUTING document.
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

npeltier commented 1 year ago

can you please show examples of what the output is?

npeltier commented 1 year ago

(and good morning, thanks a lot for that contribution :p i forgot to be polite!)

lukdz commented 1 year ago

Hi,

Example of execution of pipe with identical arguments but different debug implementation:

echo doesn't show where pipe_cmd argument starts and ends; user doesn't know if /jcr:root... is interpreted as a part of pipe_cmd or the next curl argument

set -x with single quotes show where pipe_cmd argument starts and ends; user does know that /jcr:root... is interpreted as a part of pipe_cmd

lukdz commented 1 year ago

bump

lukdz commented 1 year ago

Thank you for approval.