Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added yaml report format #67

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

c33s
Copy link
Contributor

@c33s c33s commented Mar 8, 2019

No description provided.

@dantleech
Copy link
Owner

Interesting, thanks :) what advantages does publishing to YAML have?

@c33s
Copy link
Contributor Author

c33s commented Mar 8, 2019

better readability for humans. as of #65 i prefer using yaml for output. additionally you can comment in a yaml file without breaking it. one of my main reasons why i am using composer.yaml instead of composer.json

@dantleech
Copy link
Owner

dantleech commented Mar 8, 2019

true, for configuration it can have advantages, but as an output format I'm not sure..

  • I'm not aware of any tools which can process YAML (we have jq for JSON and the standard unix tools for CSV output)
  • If it's multiline, it becomes hard / impossible to process - if it's not we negate any readability advantages.
  • A typical crawl can yield 1000's of URLs ... in which case I'm not sure YAML helps with readability (because you wouldn't want to read it)?
  • Why would we comment the report output?

@c33s
Copy link
Contributor Author

c33s commented Mar 8, 2019

  1. jq as dependency is not as good as symfony/yaml. i can only give you the feedback, that the first thing i have done was converting the ugly json to yaml with an online tool, just to make it more readable. often you have no access which unix tools are installed but php vendor is installable without problems...
  2. what do you mean with impossible to process? automation process? for automation it is not relevant, you parse yaml into a simple php array. it does not matter if multiline or not.
    for human processing, for me it is much easier to process a multiline (for one entry) yaml file than a one line (per entry) json or csv file (only if i load csv into libre calc it can be processed
  3. maybe you don't want to read it, i would want to read it. would i made a PR if i won't use it?
  4. to note what i have fixed, to commen out irrelevant urls, ... whatever.

puppet for example uses yaml as report format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants