peekit-plugins/plugin-schema.json at main · kobaltgit/peekit-plugins · 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
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "PeekIt Plugin Manifest Schema",
  "type": "object",
  "required": [
    "id",
    "name",
    "version",
    "author",
    "description",
    "extensions",
    "entry",
    "min_peekit_version"
  ],
  "properties": {
    "$schema": {
      "type": "string"
    },
    "id": {
      "type": "string",
      "pattern": "^[a-z0-9-]+(\\.[a-z0-9-]+)+$",
      "description": "Уникальный идентификатор плагина в стиле обратного домена (например: com.peekit.font-viewer)"
    },
    "name": {
      "type": "string",
      "minLength": 2,
      "maxLength": 60,
      "description": "Человекочитаемое название плагина"
    },
    "version": {
      "type": "string",
      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
      "description": "Семантическая версия (SemVer 2.0)"
    },
    "author": {
      "type": "string",
      "description": "Имя или никнейм автора/организации"
    },
    "description": {
      "type": "string",
      "maxLength": 300,
      "description": "Краткое описание назначения и возможностей плагина"
    },
    "extensions": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string",
        "pattern": "^(\\.[a-zA-Z0-9_-]+|<folder>|folder)$"
      },
      "description": "Список расширений файлов, обрабатываемых плагином (начиная с точки, например ['.stl', '.obj'] или '<folder>')"
    },
    "entry": {
      "type": "string",
      "default": "index.html",
      "description": "Входная HTML-точка плагина"
    },
    "min_peekit_version": {
      "type": "string",
      "pattern": "^\\d+\\.\\d+\\.\\d+$",
      "description": "Минимальная требуемая версия PeekIt"
    },
    "permissions": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "read_file",
          "clipboard_write"
        ]
      },
      "description": "Запрашиваемые привилегии"
    },
    "icon": {
      "type": "string",
      "description": "Путь к файлу иконки внутри директории плагина (SVG или PNG)"
    },
    "homepage": {
      "type": "string",
      "format": "uri",
      "description": "Ссылка на репозиторий или сайт плагина"
    },
    "default_dimensions": {
      "type": "object",
      "properties": {
        "width": {
          "type": "integer",
          "minimum": 320,
          "maximum": 3840
        },
        "height": {
          "type": "integer",
          "minimum": 240,
          "maximum": 2160
        }
      },
      "description": "Рекомендуемые начальные размеры окна"
    },
    "category": {
      "type": "string",
      "description": "Категория плагина в каталоге (например: 3D, Documents, Spreadsheets, Fonts, Presentations, Graphics, Utilities)"
    }
  },
  "additionalProperties": false
}