planemo lint
Check for common errors and best practices.
Synopsis
planemo lint [OPTIONS] TOOL_PATHArguments
| Argument | Type | Required | Help |
|---|---|---|---|
| TOOL_PATH | path | — | — |
Options
| Option | Type | Default | Required | Help |
|---|---|---|---|---|
| —report_level | choice | all | — | — |
| —report_xunit | path | — | — | Output an XUnit report, useful for CI testing |
| —fail_level | choice | warn | — | — |
| -s, —skip | text | — | — | Comma-separated list of lint tests to skip (e.g. passing —skip ‘citations,xml_order’ would skip linting of citations and best-practice XML ordering. |
| —skip_file | file | — | — | File containing a list of lint tests to skip |
| -r, —recursive | flag | false | — | Recursively perform command for subdirectories. |
| —urls | flag | false | — | Check validity of URLs in XML files |
| —doi | flag | false | — | Check validity of DOIs in XML files |
| —conda_requirements | flag | false | — | Check tool requirements for availability in best practice Conda channels. |
| —biocontainer, —biocontainers | flag | false | — | Check best practice BioContainer namespaces for a container definition applicable for this tool. |
Output
Console output is human-oriented; use the process exit status as the pass/fail gate.
Examples
planemo lint <tool_dir>Gotchas
No Foundry-specific gotchas recorded yet.