recipe.v1.json

/*
  initial, non complete spec...
*/
{
  "$id": "https://mamba.pm/boa/recipe.v1.schema.json",
  "title": "Boa Recipe V1",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "context": {
      "type": "object",
      "description": "The recipe context."
    },
    "package": {
      "type": "object",
      "description": "The package name and version.",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string",
          "description": "The package name"
        },
        "version": {
          "type": "string",
          "description": "The package version"
        }
      }
    },
    "source": {
      "type": "array",
      "description": "The package name and version.",
      "additionalProperties": false,
      "items": [
        {
          "type": "object",
          "properties": {
            "url": {"type": "string"},
            "sha256": {"type": "string"},
            "md5": {"type": "string"},
            "sha1": {"type": "string"},
            "patches": {"type": "array", "items": {"type": "string"}}
          }
        }
      ]
    },
    "outputs": {
      "type": "array",
      "items": { "$ref": "#/definitions/output" }
    },
    "features": {
      "type": "array"
    },
    "extra": {
      "type": "object"
    },
    "build": {
      "type": "object"
    },
    "about": {
      "type": "object"
    }
  },
  "definitions": {
    "build": {
      "type": "object",
      "required": ["number"],
      // 'build/script': list,
      // 'build/script_env': list,
      // 'build/run_exports': list,
      // 'build/track_features': list,
      // 'build/osx_is_app': bool,
      // 'build/preserve_egg_dir': bool,
      // 'build/binary_relocation': bool,
      // 'build/noarch': text_type,
      // 'build/noarch_python': bool,
      // 'build/detect_binary_files_with_prefix': bool,
      // 'build/skip': bool,
      // 'build/skip_compile_pyc': list,
      // 'build/preferred_env': text_type,
      // 'build/preferred_env_executable_paths': list,
      // 'build/ignore_run_exports': list,
      // 'build/ignore_run_exports_from': list,
      // 'build/requires_features': dict,
      // 'build/provides_features': dict,
      // 'build/pre-link': text_type,
      // 'build/post-link': text_type,
      // 'build/pre-unlink': text_type,
      // 'build/string': text_type,
      // 'build/pin_depends': text_type,
      // 'build/force_use_keys': list,
      // 'build/force_ignore_keys': list,
      // 'build/merge_build_host': bool,
      // 'build/msvc_compiler': text_type,
      "properties": {
        "number": {"type": "integer", "minimum": 0},
        "string": {"type": "string"},
        "run_exports": {"type": "object"},
        "skip": {"type": "array", "items": {"type": "string"}},
        "noarch": {"type": "string"},
        "pre-link": {"type": "string"},
        "post-link": {"type": "string"},
        "pre-unlink": {"type": "string"},
        "ignore_run_exports": {"type": "array", "items": {"type": "string"}},
        "ignore_run_exports_from": {"type": "array", "items": {"type": "string"}},
      }
    },
    "output": {
      "type": "object",
      "required": [ "package" ],
      "properties": {
        "package": {
          "type": "object",
          "description": "The package name.",
          "required": [ "name" ],
          "properties": {
            "name": {"type": "string"},
            "version": {"type": "string"},
          }
        },
        "build": {
          "type": "object",
        },
        "requirements": {
          "type": "object",
          "properties": {
            "build": {"type": "array", "items": {"type": "string"}},
            "host": {"type": "array", "items": {"type": "string"}},
            "run": {"type": "array", "items": {"type": "string"}},
            "run_constrained": {"type": "array", "items": {"type": "string"}},
          }
        },
        "test": { "$ref": "#/definitions/test" }
      }
    },
    "test": {
      "type": "object",
      "required": [],
      "properties": {
        "files": {
          "type": "array",
          "description": "Test files that are copied from the recipe into the temporary test directory and are needed during testing.",
          "items": {"type": "string"}
        },
        "source_files": {
          "type": "array",
          "description": "Test files that are copied from the source work directory into the temporary test directory and are needed during testing.",
          "items": {"type": "string"}
        },
        "requires": {
          "type": "array",
          "description": "In addition to the runtime requirements, you can specify requirements needed during testing.",
          "items": {"type": "string"}
        },
        "imports": {
          "type": "array",
          "description": "Test importing modules.",
          "items": {"type": "string"}
        },
        "commands": {
          "type": "array",
          "description": "The test commands to execute.",
          "items": {"type": "string"}
        },
      }
    }

  }
}