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

Values in comments are read when creating template for meta.yml from input options #3286

Open
zachary-foster opened this issue Nov 18, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@zachary-foster
Copy link

Description of the bug

When running nf-core modules lint --fix, data in meta.yml can be made incorrectly if things that look like inputs appear in comments. For example:

In main.nf for the busco module:

    input:
    tuple val(meta), path('tmp_input/*')
    val mode                              // Required:    One of genome, proteins, or transcriptome
    val lineage                           // Required:    lineage to check against, "auto" enables --auto-lineage instead
    path busco_lineages_path              // Recommended: path to busco lineages - downloads if not set
    path config_file                      // Optional:    busco configuration file

The // Recommended: path to busco causes the - to: {} in meta.yml:

  - - busco_lineages_path:
        type: directory
        description: Path to local BUSCO lineages directory.
    - to: {}

Which causes the following error:

╭─ [✗] 3 Module Tests Failed ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│              ╷                                ╷                                                                                        │
│ Module name  │ File path                      │ Test message                                                                           │
│╶─────────────┼────────────────────────────────┼───────────────────────────────────────────────────────────────────────────────────────╴│
│ busco        │ modules/nf-core/busco/main.nf  │ Local copy of module does not match remote                                             │
│ busco        │ modules/nf-core/busco/meta.yml │ Local copy of module does not match remote                                             │
│ busco        │ modules/nf-core/busco/meta.yml │ The meta.yml of the module busco is not valid: 'type' is a required property. Check    │
│              │                                │ the entry for input.                                                                   │
│              ╵                                ╵                                                                                        │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Command used and terminal output

nf-core modules lint --fix busco

System information

  • nf-core/tools version 3.0.2
  • PopOS 22 Desktop
@zachary-foster zachary-foster added the bug Something isn't working label Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant