bpkg.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://json.schemastore.org/bpkg.json",
  "properties": {
    "name": {
      "description": "Where the dependency is located in `deps/`.\n\nSee more: https://github.com/bpkg/bpkg#name",
      "type": "string",
      "default": ""
    },
    "version": {
      "description": "The current version of the dependency.\n\nSee more: https://github.com/bpkg/bpkg#version-optional",
      "type": "string",
      "default": "v0.1.0"
    },
    "description": {
      "description": "Human-readable description of the functionality of the package.\n\nSee more: https://github.com/bpkg/bpkg#description",
      "type": "string",
      "examples": ["Terminal utility functions"]
    },
    "global": {
      "type": "string",
      "default": "",
      "description": "Whether the package is only intended be installed as a global script. Allows the omission of the `--global` flag when installing.\n\nSee more: https://github.com/bpkg/bpkg#global",
      "examples": ["true"]
    },
    "install": {
      "type": "string",
      "description": "Shell script used to invoke in the install script. Required if package is being installed as a global script.\n\nSee more: https://github.com/bpkg/bpkg#install-1",
      "default": "make install",
      "examples": ["make install"]
    },
    "scripts": {
      "description": "An array of scripts to install into a project. See more: https://github.com/bpkg/bpkg#scripts",
      "type": "array",
      "items": {
        "type": "string",
        "examples": ["script.sh"]
      }
    },
    "files": {
      "description": "An array of non-script files to install into a project. See more: https://github.com/bpkg/bpkg#files-optional",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "dependencies": {
      "description": "Hash of dependencies of this project. Use either a tagged release identifier or `master`.\n\nSee more: https://github.com/bpkg/bpkg#dependencies-optional",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "dependencies-dev": {
      "description": "Hash of development dependencies of this project. Use either a tagged release identifier or `master`.\n\nSee more: https://github.com/bpkg/bpkg#dependencies-dev-optional",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "commands": {
      "description": "A hash of runnable commands for `bpkg run`.\n\nSee more: https://github.com/bpkg/bpkg#commands-optional",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "commands-description": {
      "description": "A hash of descriptions for each command in `commands`.\n\nSee more: https://github.com/bpkg/bpkg#commands-description-optional",
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    }
  },
  "required": ["name", "description", "global", "install", "scripts"],
  "type": "object"
}