nf_core.lint¶
See also
See the Lint Tests docs for information about specific linting functions.
Linting policy for nf-core pipeline projects.
Tests Nextflow-based pipelines to check that they adhere to the nf-core community guidelines.
-
nf_core.lint.run_linting(pipeline_dir, release_mode=False, fix=(), show_passed=False, fail_ignored=False, md_fn=None, json_fn=None)¶ Runs all nf-core linting checks on a given Nextflow pipeline project in either release mode or normal mode (default). Returns an object of type
PipelineLintafter finished.- Parameters
pipeline_dir (str) – The path to the Nextflow pipeline root directory
release_mode (bool) – Set this to True, if the linting should be run in the release mode. See
PipelineLintfor more information.
- Returns
An object of type
PipelineLintthat contains all the linting results.
-
class
nf_core.lint.PipelineLint(wf_path, release_mode=False, fix=(), fail_ignored=False)¶ Bases:
nf_core.utils.PipelineObject to hold linting information and results.
Inherits
nf_core.utils.Pipelineclass.Use the
PipelineLint._lint_pipeline()function to run lint tests.- Parameters
path (str) – The path to the nf-core pipeline directory.
-
failed¶ A list of tuples of the form:
(<test-name>, <reason>)- Type
list
-
ignored¶ A list of tuples of the form:
(<test-name>, <reason>)- Type
list
-
lint_config¶ The parsed nf-core linting config for this pipeline
- Type
dict
-
passed¶ A list of tuples of the form:
(<test-name>, <reason>)- Type
list
-
release_mode¶ True, if you the to linting was run in release mode, False else.
- Type
bool
-
warned¶ A list of tuples of the form:
(<warned no>, <reason>)- Type
list
-
_get_results_md()¶ Create a markdown file suitable for posting in a GitHub comment.
- Returns
Formatting markdown content
- Return type
markdown (str)
-
_lint_pipeline()¶ Main linting function.
Takes the pipeline directory as the primary input and iterates through the different linting checks in order. Collects any warnings or errors into object attributes:
passed,ignored,warnedandfailed.
-
_print_results(show_passed=False)¶ Print linting results to the command line.
Uses the
richlibrary to print a set of formatted tables to the command line summarising the linting results.
-
_save_json_results(json_fn)¶ Function to dump lint results to a JSON file for downstream use
- Parameters
json_fn (str) – File path to write JSON to.
-
_strip_ansi_codes(string, replace_with='')¶ Strip ANSI colouring codes from a string to return plain text.
Solution found on Stack Overflow: https://stackoverflow.com/a/14693789/713980
-
_wrap_quotes(files)¶ Helper function to take a list of filenames and format with markdown.
- Parameters
files (list) –
List of filenames, eg:
['foo', 'bar', 'baz']
- Returns
Formatted string of paths separated by word
or, eg:`foo` or bar` or `baz`
- Return type
markdown (str)