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

Rich click #1411

Merged
merged 7 commits into from
Feb 18, 2022
Merged

Rich click #1411

merged 7 commits into from
Feb 18, 2022

Conversation

ewels
Copy link
Member

@ewels ewels commented Feb 11, 2022

🆕 CLI help command groups 🤩

Sorting of commands but also breaking up into multiple panels with their own headers:

image

image

@ewels
Copy link
Member Author

ewels commented Feb 11, 2022

Need to do a release of rich-click for this to work for everyone else, but shouldn't hurt to merge in ahead of that I think. It should start working once the new release is out.

@codecov
Copy link

codecov bot commented Feb 11, 2022

Codecov Report

Merging #1411 (46a8fe4) into dev (84b5485) will increase coverage by 0.10%.
The diff coverage is 97.56%.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev    #1411      +/-   ##
==========================================
+ Coverage   66.77%   66.87%   +0.10%     
==========================================
  Files          50       50              
  Lines        5713     5688      -25     
==========================================
- Hits         3815     3804      -11     
+ Misses       1898     1884      -14     
Impacted Files Coverage Δ
nf_core/__main__.py 52.60% <97.56%> (-2.90%) ⬇️
nf_core/modules/lint/main_nf.py 80.11% <0.00%> (-1.76%) ⬇️
nf_core/modules/create.py 80.10% <0.00%> (+1.02%) ⬆️
nf_core/utils.py 84.50% <0.00%> (+3.75%) ⬆️

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 84b5485...46a8fe4. Read the comment docs.

Comment on lines +47 to +53
{
"name": "For pipelines",
"commands": ["list", "install", "update", "remove"],
},
{
"name": "Developing new modules",
"commands": ["create", "create-test-yml", "lint", "bump-versions"],
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we mention that one has to be called inside a pipeline repo and one inside the modules repo or will that be too much text?

Copy link
Member Author

Choose a reason for hiding this comment

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

No such thing as too much text now! Instead of being truncated the plug-in will mean that the text just wraps onto a second line if it's long.

We might want to keep it shortish anyway though, still looks better if they're on one line I think.

@ewels
Copy link
Member Author

ewels commented Feb 18, 2022

Updated to use new rich-click usage (no monkey patching, just import rich-click as click).

Needs new release from rich-click to work, but then should be good to merge.

@ewels
Copy link
Member Author

ewels commented Feb 18, 2022

Version 1.0.0 now released, should be good to go here.

Copy link
Member

@drpatelh drpatelh left a comment

Choose a reason for hiding this comment

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

🚀

@drpatelh drpatelh merged commit a1bf2ad into nf-core:dev Feb 18, 2022
@github-actions
Copy link
Contributor

YAML linting is failing

To keep the code consistent with lots of contributors, we run automated code consistency checks.
To fix this CI test, please run:

  • Install yaml-lint
  • Fix the markdown errors
    • Run the test locally: yamllint $(find . -type f -name "*.yml" -o -name "*.yaml") -c ./.yamllint.yml
    • Fix any reported errors in your YAML files

Once you push these changes the test should pass, and you can hide this comment 👍

We highly recommend setting up yaml-lint in your code editor so that this formatting is done automatically on save. Ask about it on Slack for help!

Thanks again for your contribution!

@ewels ewels deleted the rich-click branch February 18, 2022 21:48
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.

3 participants