nf-core / nf-core/tools

Add `-w`, `--fail-warned` option to `nf-core schema lint`

Open
#3,123 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement good-first-issue
Dominant language
Python
Stars
322
Forks
255
Avg merge
2d 3h
Merged PRs (30d)
5

Description

Description of feature

It would be really nice for linting/CI and development if nf-core schema lint -w, with a new -w and/or --fail-warned, option can exit with a non-zero exit code if warnings are detected.

Thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the entry point for the nf-core schema lint command and trace how lint warnings are collected and converted into an exit status. Add support for -w and/or --fail-warned, then run the schema lint tests or command fixtures to verify that warnings produce a non-zero exit code only when the option is enabled.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.