skernel/skernel.schema.json at main · super-kernel/skernel · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://raw.githubusercontent.com/super-kernel/skernel/main/skernel.schema.json",
    "title": "SKERNEL configuration",
    "description": "The settings of a project for SKERNEL's commands, read from skernel.json or skernel.json.dist in the project root. A setting left out keeps its default.",
    "type": "object",
    "additionalProperties": false,
    "properties": {
        "$schema": {
            "description": "The schema that describes this file.",
            "type": "string",
            "minLength": 1
        },
        "php": {
            "description": "The managed PHP version: major.minor for that branch's latest release, or an exact major.minor.patch; by default the latest release that the root package's require.php allows.",
            "type": "string",
            "pattern": "^[1-9][0-9]*\\.[0-9]+(\\.[0-9]+)?$",
            "examples": [
                "8.4",
                "8.4.27"
            ]
        },
        "composer": {
            "description": "The Composer that build, run, and package use: a path, relative to the project root when it contains a /, or a name looked up in PATH; by default the first working Composer 2 or else SKERNEL's own.",
            "type": "string",
            "minLength": 1
        },
        "run": {
            "description": "Settings of the run command.",
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "watch": {
                    "description": "Whether run rebuilds and restarts the application when a watched file changes.",
                    "type": "boolean",
                    "default": false
                },
                "watch-files": {
                    "description": "The name patterns of the watched files, with *, ?, and [...]; the vendor directory, target/, and directories whose name starts with a dot are never watched.",
                    "type": "array",
                    "minItems": 1,
                    "items": {
                        "type": "string",
                        "minLength": 1
                    },
                    "default": [
                        "*.php",
                        ".env",
                        ".env.*",
                        "composer.json",
                        "composer.lock"
                    ]
                }
            }
        },
        "package": {
            "description": "Settings of the package command.",
            "type": "object",
            "additionalProperties": false,
            "properties": {
                "runtime": {
                    "description": "A micro.sfx that replaces the managed micro runtime, relative to the project root.",
                    "type": "string",
                    "minLength": 1
                },
                "output": {
                    "description": "The package path, relative to the project root; by default target/<name>, or target/<name>.phar for a PHAR.",
                    "type": "string",
                    "minLength": 1
                },
                "dev": {
                    "description": "Whether the development dependencies are installed into the package.",
                    "type": "boolean",
                    "default": false
                },
                "phar": {
                    "description": "Whether packaging stops at the PHAR instead of a standalone binary.",
                    "type": "boolean",
                    "default": false
                }
            }
        }
    }
}