environment-schema.json

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "title": "conda environment yaml",
    "description": "Validate the environment.yml file for an nf-core module",
    "type": "object",
    "properties": {
        "channels": {
            "type": "array",
            "items": {
                "type": "string",
                "not": {
                    "const": "default"
                }
            }
        },
        "dependencies": {
            "type": "array",
            "items": {
                "oneOf": [
                    {
                        "type": "string",
                        "pattern": "^.*[^><]=[^><].*$",
                        "$comment": "The above pattern ensures that all packages are pinned to a specific version. This ensures the reproducibility of the environment"
                    },
                    {
                        "type": "object",
                        "properties": {
                            "pip": {
                                "type": "array",
                                "items": {
                                    "type": "string",
                                    "pattern": "^.*==.*$",
                                    "$comment": "The above pattern ensures that all packages are pinned to a specific version. This ensures the reproducibility of the environment"
                                }
                            }
                        }
                    }
                ]
            }
        }
    },
    "required": ["channels", "dependencies"],
    "not": { "required": ["name"] }
}