cli/schema.json at main · trywpm/cli · 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Schema for wpm configuration file",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
      "maxLength": 164,
      "minLength": 3,
      "description": "The name of the package."
    },
    "version": {
      "type": "string",
      "description": "A Semver-compliant version string."
    },
    "type": {
      "type": "string",
      "enum": ["theme", "plugin"],
      "description": "The type of package in the wp-content directory."
    },
    "description": {
      "type": "string",
      "description": "A brief summary of what the package is about."
    },
    "private": {
      "type": "boolean",
      "default": false,
      "description": "If set to true, wpm will refuse to publish the package."
    },
    "bin": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The binaries associated with the package."
    },
    "requires": {
      "type": "object",
      "properties": {
        "wp": {
          "type": "string",
          "description": "The WordPress versions range supported by the package."
        },
        "php": {
          "type": "string",
          "description": "The PHP versions range supported by the package."
        }
      },
      "additionalProperties": false,
      "description": "The PHP and WordPress version constraints for the package."
    },
    "license": {
      "type": "string",
      "description": "The license under which the package is released. WordPress is licensed under GPLv2 or later."
    },
    "homepage": {
      "type": "string",
      "format": "uri",
      "description": "The URL of the package's homepage."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 5,
      "description": "Tags that help categorize the package."
    },
    "author": {
      "type": "string",
      "minLength": 2,
      "maxLength": 164,
      "description": "The author of the package."
    },
    "dependencies": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The dependencies required by the package."
    },
    "devDependencies": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "The development dependencies required by the package."
    },
    "config": {
      "type": "object",
      "properties": {
        "bin-dir": {
          "type": "string",
          "default": "wp-bin",
          "description": "The path to the directory where the package's binaries are installed."
        },
        "content-dir": {
          "type": "string",
          "default": "wp-content",
          "description": "The path to the WordPress content directory."
        },
        "runtime": {
          "type": "object",
          "properties": {
            "wp": {
              "type": "string",
              "description": "The WordPress runtime version where this project is expected to run."
            },
            "php": {
              "type": "string",
              "description": "The PHP runtime version where this project is expected to run."
            }
          },
          "additionalProperties": false,
          "description": "The actual runtime requirements where this project is expected to run."
        }
      }
    },
    "scripts": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Scripts to run during the package lifecycle or development."
    }
  },
  "required": ["name"],
  "if": {
    "properties": {
      "private": {
        "const": true
      }
    },
    "required": ["private"]
  },
  "else": {
    "required": ["type", "version"]
  }
}