schema/package-meta.json at main · jscrates/schema · 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
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "JSON schema Application Package Manager",
  "type": "object",
  "definitions": {
    "person": {
      "description": "A person or an organization who has been involved in creating or maintaining this package.",
      "type": [
        "object",
        "string"
      ],
      "required": [
        "name"
      ],
      "properties": {
        "name": {
          "type": "string"
        },
        "url": {
          "type": "string",
          "format": "uri"
        },
        "email": {
          "type": "string",
          "format": "email"
        }
      }
    },
    "dependency": {
      "description": "Record of dependencies used by the current package",
      "type": "object"
    }
  },
  "properties": {
    "name": {
      "description": "The name of the package.",
      "type": "string",
      "maxLength": 199,
      "minLength": 1,
      "pattern": "^(?:@[a-z0-9-*~][a-z0-9-*._~]*/)?[a-z0-9-~][a-z0-9-._~]*$"
    },
    "version": {
      "description": "Version of the package following the Semantic Versioning system.",
      "type": "string"
    },
    "description": {
      "description": "Description of the package",
      "type": "string"
    },
    "author": {
      "$ref": "#/definitions/person"
    },
    "contributors": {
      "description": "Individuals who have contributed in the development of this package.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/person"
      }
    },
    "maintainers": {
      "description": "Individuals who regularly maintain this package.",
      "type": "array",
      "items": {
        "$ref": "#/definitions/person"
      }
    },
    "license": {
      "description": "License included with the package",
      "type": "string"
    },
    "homepage": {
      "description": "Link to the project's homepage or website",
      "type": "string"
    },
    "repository": {
      "description": "Link to where the code of this package live like Git, SVN or Mercurial.",
      "type": [
        "object",
        "string"
      ],
      "properties": {
        "type": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "directory": {
          "type": "string"
        }
      }
    },
    "dependencies": {
      "$ref": "#/definitions/dependency"
    },
    "devDependencies": {
      "$ref": "#/definitions/dependency"
    },
    "peerDependencies": {
      "$ref": "#/definitions/dependency"
    },
    "bundledDependencies": {
      "$ref": "#/definitions/dependency"
    },
    "optionalDependencies": {
      "$ref": "#/definitions/dependency"
    },
    "scripts": {
      "description": "The list of commands to be executed at various lifecycle events in the package.",
      "type": "object"
    }
  }
}