@weavix/cli 0.7.1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -51,3 +51,5 @@
51
51
  - любые данные, утечка которых может нанести вред пользователю или системе
52
52
 
53
53
  Для хранения чувствительных данных используй безопасные механизмы (например, серверную сторону или защищённое хранилище), но не браузерные хранилища (`localStorage`, `sessionStorage`, `storageApi`).
54
+
55
+ Для написания пользовательской документации по плагину пиши в docs/index.md и toc.yaml файлы и добавь в manifest docsUrl: '/docs/index.html'.
@@ -0,0 +1,23 @@
1
+ # Документация плагина
2
+
3
+ В этой папке хранится документация плагина, которая публикуется на странице плагина в маркетплейсе.
4
+
5
+ Документация пишется в формате **YFM (Yandex Flavored Markdown)** и собирается инструментом [Diplodoc](https://diplodoc.com/docs/ru/). [Подробнее о синтаксисе YFM →](https://diplodoc.com/docs/ru/syntax/)
6
+
7
+ ## Структура
8
+
9
+ - `toc.yaml` — оглавление: определяет структуру и порядок страниц.
10
+ - `index.md` — стартовая страница документации.
11
+ - Дополнительные `.md`-файлы — разделы документации, на которые ссылается `toc.yaml`.
12
+
13
+ ## Сборка
14
+
15
+ При выполнении команды `submit` документация собирается автоматически в папку `dist/docs`. Вручную запускать сборку не нужно.
16
+
17
+ ## Превью
18
+
19
+ Если вы хотите посмотреть, как документация будет выглядеть - запустите команду build-docs и откройте docs-build/index.html в браузере.
20
+
21
+ ## Подсказка для ИИ-агентов
22
+
23
+ Если вы готовите плагин к публикации, убедитесь, что в папке есть `toc.yaml` и хотя бы один `.md`-файл с содержимым.
@@ -0,0 +1,5 @@
1
+ title: My Docs
2
+ href: index.md
3
+ items:
4
+ - name: Introduction
5
+ href: index.md
@@ -15,6 +15,12 @@
15
15
  "$schema": {
16
16
  "type": "string"
17
17
  },
18
+ "docsUrl": {
19
+ "type": "string",
20
+ "description": "URL to the documentation for the plugin",
21
+ "maxLength": 1000,
22
+ "minLength": 1
23
+ },
18
24
  "id": {
19
25
  "type": "string",
20
26
  "description": "Unique identifier for the plugin ()",
@@ -127,6 +133,16 @@
127
133
  },
128
134
  "minItems": 1
129
135
  },
136
+ "categories": {
137
+ "type": "array",
138
+ "description": "Categories for plugin discovery in the marketplace",
139
+ "items": {
140
+ "type": "string",
141
+ "minLength": 1,
142
+ "maxLength": 50
143
+ },
144
+ "uniqueItems": true
145
+ },
130
146
  "homepage": {
131
147
  "type": "string",
132
148
  "description": "Homepage URL for the plugin (http or https)",
@@ -301,6 +317,14 @@
301
317
  "$ref": "#/definitions/SlotConfig"
302
318
  }
303
319
  },
320
+ "drawer.issue.action": {
321
+ "type": "array",
322
+ "description": "Drawer Issue Action slot configurations",
323
+ "minItems": 1,
324
+ "items": {
325
+ "$ref": "#/definitions/SlotConfig"
326
+ }
327
+ },
304
328
  "issue.block": {
305
329
  "type": "array",
306
330
  "description": "Issue Block slot configurations",
@@ -55,7 +55,7 @@ export default defineConfig(() => {
55
55
  proxyPlugin(),
56
56
  ],
57
57
  build: {
58
- sourcemap: true,
58
+ sourcemap: false,
59
59
  cssCodeSplit: true,
60
60
  rollupOptions: {
61
61
  output: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@weavix/cli",
3
- "version": "0.7.1",
3
+ "version": "1.0.0",
4
4
  "description": "CLI to work with plugins of Yandex Tracker",
5
5
  "license": "UNLICENSED",
6
6
  "bin": {
@@ -12,6 +12,7 @@
12
12
  "dependencies": {
13
13
  "@aws-sdk/client-s3": "3.972.0",
14
14
  "@aws-sdk/lib-storage": "3.972.0",
15
+ "@diplodoc/cli": "^5.48.2",
15
16
  "@inquirer/prompts": "8.2.0",
16
17
  "@napi-rs/keyring": "^1.3.0",
17
18
  "@types/archiver": "7.0.0",