Skip to content

Conversation

@bentsherman
Copy link
Member

Redo of #4201

This PR uses the config scope classes (in the new compiler module) to validate the config at runtime, for the config and run commands.

Validation occurs after plugins are loaded, and the validator uses the plugin system to collect all implementations of the ConfigScope interface, so plugins can use this interface to declare their config options to Nextflow.

I suggest we merge this in an upcoming release and advise plugin developers to implement this interface before 25.04, to make the transition to next stable as smooth as possible.

This work is also a prerequisite to recognizing third-party plugin config in VS Code.

Signed-off-by: Ben Sherman <[email protected]>
@bentsherman bentsherman requested a review from a team as a code owner February 25, 2025 21:56
@netlify
Copy link

netlify bot commented Feb 25, 2025

Deploy Preview for nextflow-docs-staging canceled.

Name Link
🔨 Latest commit 9ef853d
🔍 Latest deploy log https://app.netlify.com/sites/nextflow-docs-staging/deploys/67d81725f468830007165e40

Signed-off-by: Ben Sherman <[email protected]>
@bentsherman bentsherman mentioned this pull request Feb 25, 2025
5 tasks
@bentsherman bentsherman marked this pull request as draft February 26, 2025 01:34
@bentsherman

This comment was marked as resolved.

Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Signed-off-by: Ben Sherman <[email protected]>
Comment on lines -2 to +1
@@ -3,3 +1,4 @@
outputDir = 'results'
Copy link
Member Author

Choose a reason for hiding this comment

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

Had to pick some valid config option here. Alternatively we could leave the invalid options and include the warnings for them in the expected stdout

@bentsherman bentsherman removed the request for review from tom-seqera February 27, 2025 19:01
@bentsherman bentsherman marked this pull request as ready for review February 27, 2025 19:45
@christopher-hakkaart
Copy link
Collaborator

The documentation looks good.

@bentsherman bentsherman changed the title Validate config schema Config schema checking Mar 9, 2025
Signed-off-by: Ben Sherman <[email protected]>
@pditommaso pditommaso merged commit 2430ea6 into master Mar 17, 2025
23 checks passed
@pditommaso pditommaso deleted the config-schema branch March 17, 2025 18:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants