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

Lint the modules.json for uninstalled modules #1149

Merged
merged 6 commits into from
Jul 5, 2021

Conversation

KevinMenden
Copy link
Contributor

This PR adds a new pipeline lint check (nf-core lint) which looks for module entries in the modules.json of modules that are not actually installed in the pipeline.

I thought it makes sense to package that into the nf-core lint command as it looks at a general pipeline file (modules.json) and compares that against all installed modules. The nf-core modules lint command is more module-centric, meaning that it runs specific lint tests for every module separately. Therefore I think it is more logical to add this check here.

PR checklist

  • This comment contains a description of changes (with reason)
  • CHANGELOG.md is updated
  • If you've fixed a bug or added code that should be tested, add tests!
  • Documentation in docs is updated

@KevinMenden KevinMenden linked an issue Jul 2, 2021 that may be closed by this pull request
@codecov
Copy link

codecov bot commented Jul 2, 2021

Codecov Report

Merging #1149 (47b83ba) into dev (7b8ae3f) will increase coverage by 0.05%.
The diff coverage is 85.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #1149      +/-   ##
==========================================
+ Coverage   69.27%   69.33%   +0.05%     
==========================================
  Files          50       51       +1     
  Lines        5237     5257      +20     
==========================================
+ Hits         3628     3645      +17     
- Misses       1609     1612       +3     
Impacted Files Coverage Δ
nf_core/lint/modules_json.py 84.21% <84.21%> (ø)
nf_core/lint/__init__.py 75.20% <100.00%> (+0.10%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7b8ae3f...47b83ba. Read the comment docs.

Copy link
Contributor

@ErikDanielsson ErikDanielsson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just found a few minor things.

nf_core/lint/modules_json.py Outdated Show resolved Hide resolved
nf_core/lint/modules_json.py Outdated Show resolved Hide resolved
nf_core/lint/modules_json.py Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@KevinMenden KevinMenden merged commit ec7b5e8 into nf-core:dev Jul 5, 2021
@KevinMenden KevinMenden deleted the lint-modules-json branch July 5, 2021 08:26
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.

Lint for removed modules in modules.json
2 participants