schema.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "description": "Settings used to build a new PHAR using Box.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "$schema": {
            "description": "JSON schema location, e.g. ``vendor\/humbug\/box\/res\/schema.json``",
            "type": [ "string", "null"]
        },
        "algorithm": {
            "description": "The algorithm to use for signing the PHAR.",
            "type": ["string", "null"]
        },
        "alias": {
            "description": "The internal PHAR alias used for I/O streams.",
            "type": ["string", "null"]
        },
        "annotations": {
            "description": "The PHP annotation compactor settings.",
            "type": ["boolean", "object", "null"],
            "properties": {
                "ignore": {
                    "description": "A list of annotation names to ignore.",
                    "items": {
                        "type": "string"
                    },
                    "type": ["array", "null"]
                }
            }
        },
        "banner": {
            "description": "The header comment for the generated stub.",
            "type": ["array", "boolean", "string", "null"]
        },
        "banner-file": {
            "description": "The header comment file for the generated stub.",
            "type": ["string", "null"]
        },
        "base-path": {
            "description": "The base path where relative paths are resolved to.",
            "type": ["string", "null"]
        },
        "blacklist": {
            "description": "A list of file paths to skip.",
            "items": {
                "type": "string"
            },
            "type": ["array", "null"]
        },
        "check-requirements": {
            "description": "If enabled, the PHAR will be able to check if the PHP environment used meets all the requirements to run the application.",
            "type": ["boolean", "null"]
        },
        "chmod": {
            "description": "The permission mode for the new PHAR.",
            "type": ["string", "null"]
        },
        "compactors": {
            "description": "The list of file contents compactor classes to register.",
            "items": {
                "type": "string"
            },
            "type": ["array", "string", "null"]
        },
        "compression": {
            "description": "The compression algorithm to use for the PHAR.",
            "type": ["string", "null"]
        },
        "datetime": {
            "description": "The replacement date for the current date and time.",
            "type": ["string", "null"]
        },
        "datetime-format": {
            "description": "The format for the current date and time.",
            "type": ["string", "null"]
        },
        "datetime_format": {
            "description": "The format for the current date and time.",
            "type": ["string", "null"]
        },
        "directories": {
            "description": "A list of directory paths to search for scripts.",
            "items": {
                "type": "string"
            },
            "type": ["array", "null"]
        },
        "directories-bin": {
            "description": "A list of directory paths to search for binary safe files.",
            "items": {
                "type": "string"
            },
            "type": ["array", "null"]
        },
        "dump-autoload": {
            "description": "Will dump the optimized Composer autoloader.",
            "type": ["boolean", "null"]
        },
        "exclude-composer-files": {
            "description": "Will remove the composer.json, composer.lock and installed.json files from the PHAR",
            "type": ["boolean", "null"]
        },
        "exclude-dev-files": {
            "description": "Will remove the files from dev only packages from the PHAR",
            "type": ["boolean", "null"]
        },
        "files": {
            "description": "A list of file paths to include.",
            "items": {
                "type": "string"
            },
            "type": ["array", "null"]
        },
        "files-bin": {
            "description": "A list of binary safe file paths to include.",
            "items": {
                "type": "string"
            },
            "type": ["array", "null"]
        },
        "finder": {
            "description": "A list of Finder configuration settings.",
            "items": {
                "type": "object"
            },
            "type": ["array", "null"]
        },
        "finder-bin": {
            "description": "A list of Finder configuration settings for binary safe files.",
            "items": {
                "type": "object"
            },
            "type": ["array", "null"]
        },
        "force-autodiscovery": {
            "description": "Forces the auto-discovery of files.",
            "type": ["boolean", "null"]
        },
        "git": {
            "description": "The replacement name for the current pretty git version format.",
            "type": ["string", "null"]
        },
        "git-commit": {
            "description": "The replacement name for the current git full commit hash.",
            "type": ["string", "null"]
        },
        "git-commit-short": {
            "description": "The replacement name for the current git short commit hash.",
            "type": ["string", "null"]
        },
        "git-tag": {
            "description": "The replacement name for the current git tag.",
            "type": ["string", "null"]
        },
        "git-version": {
            "description": "The replacement name for the current git tag or commit hash.",
            "type": ["string", "null"]
        },
        "intercept": {
            "description": "Allow the PHAR to intercept file functions?",
            "type": ["boolean", "null"]
        },
        "key": {
            "description": "The path to the private key used for signing.",
            "type": ["string", "null"]
        },
        "key-pass": {
            "description": "The password or prompt flag used for the private key.",
            "type": ["boolean", "string", "null"]
        },
        "main": {
            "description": "The file path to the main script.",
            "type": ["boolean", "string", "null"]
        },
        "map": {
            "description": "The mapping of file system paths to phar paths.",
            "type": ["array", "null"],
            "items": {
                "type": "object"
            }
        },
        "metadata": {
            "description": "Extra PHAR metadata."
        },
        "output": {
            "description": "The file name or path of the new PHAR.",
            "type": ["string", "null"],
            "not": {
                "enum": ["", ".", ".."]
            }
        },
        "php-scoper": {
            "description": "Path to the PHP-Scoper configuration file.",
            "type": ["string", "null"]
        },
        "replacement-sigil": {
            "description": "The sigil that surrounds the replacement names.",
            "type": ["string", "null"]
        },
        "replacements": {
            "description": "A list of replacement names and their values.",
            "type": ["object", "null"]
        },
        "shebang": {
            "description": "The shebang line to use for the generated stub.",
            "type": ["string", "boolean", "null"]
        },
        "stub": {
            "description": "The relative file path to the stub file, or the flag to use the default stub.",
            "type": ["boolean", "string", "null"]
        },
        "timestamp": {
            "description": "The time at which the PHAR timestamp will be set.",
            "type": ["string", "null"]
        }
    }
}