search

galaxyproject / planemo

Command-line utilities to assist in developing Galaxy and Common Workflow Language artifacts - including tools, workflows, and training materials.
https://planemo.readthedocs.io/
MIT License
89 stars 85 forks source link

planemo lint report (machine-readable) #1139

Open davelopez opened 3 years ago

davelopez commented 3 years ago

I was looking into ways of integrating the rich planemo lint results into the Galaxy Tools VSCode extension in a similar way as the planemo tests.

I found in the planemo lint --help an option to generate a xUnit report with --report_xunit:

Usage: planemo lint [OPTIONS] TOOL_PATH

  Check for common errors and best practices.

Options:
  --report_level [all|warn|error]
  --report_xunit PATH             Output an XUnit report, useful for CI
                                  testing

  --fail_level [warn|error]
...

I tried to use the option but It seems the report file is not generated with the lint command. Anybody else experiencing this?

In case it is not working or there is an error in the --help documentation, I will be happy to implement a new option planemo lint --report_json or at least try to :)

simonbray commented 3 years ago

It looks like it was never implemented: https://github.com/galaxyproject/planemo/pull/349

In case it is not working or there is an error in the --help documentation, I will be happy to implement a new option planemo lint --report_json or at least try to :)

:+1:

davelopez commented 3 years ago

Thanks @simonbray for checking it out! I will try to add this --report_json option. Hope it is ok to replace the --report_xunit with a simpler JSON report tailored specifically for all the linting results.

jmchilton commented 3 years ago

I mean - xunit results would be really cool and work well with other things. But I'm happy to merge a JSON report also.