+
Skip to content

Add autocompletion for modules / subworkflows and pipeline #3660

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 22 commits into
base: dev
Choose a base branch
from
Open

Add autocompletion for modules / subworkflows and pipeline #3660

wants to merge 22 commits into from

Conversation

LouisLeNezet
Copy link
Contributor

@LouisLeNezet LouisLeNezet commented Jul 8, 2025 •
edited
Loading

The aim here is to make available to autocompletion in the cli the modules / subworkflows and pipelines names.
This just need to add the list of available names to be added to rich.click shell_completion argument.

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

@LouisLeNezet LouisLeNezet marked this pull request as draft July 8, 2025 06:54
@codecov Codecov
Copy link

codecov bot commented Jul 8, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 87.30159% with 8 lines in your changes missing coverage. Please review.

Project coverage is 77.00%. Comparing base (28b76a4) to head (1e2a06d).

Files with missing lines Patch % Lines
nf_core/components/components_completion.py 87.50% 3 Missing ⚠️
nf_core/pipelines/list.py 80.00% 3 Missing ⚠️
nf_core/__main__.py 91.66% 2 Missing ⚠️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@LouisLeNezet
Copy link
Contributor Author

Autocompletion now does work for all modules / subworkflows and pipelines command.
I'm however not sure how does the ctx object does work.
I think the autocompletion should have a different behaviour for install (list all remote modules) and lint (list all local modules).

@LouisLeNezet LouisLeNezet marked this pull request as ready for review July 8, 2025 10:17
@LouisLeNezet LouisLeNezet requested a review from mashehu July 8, 2025 10:17
mashehu
mashehu reviewed Jul 8, 2025
View reviewed changes
@LouisLeNezet LouisLeNezet requested a review from mashehu July 8, 2025 17:29
mashehu
mashehu reviewed Jul 8, 2025
View reviewed changes
@LouisLeNezet LouisLeNezet requested a review from mashehu July 9, 2025 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mashehu mashehu Awaiting requested review from mashehu

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@LouisLeNezet @mashehu
点击 这是indexloc提供的php浏览器服务，不要输入任何密码和下载