Skip to content

npm-пакеты для авторов расширений

Публичные пакеты для разработки расширений вне исходного кода лаунчера. Полная документация — на docs.rynt.space.

Три пакета

npmНазначение
@rynt/create-extensionCLI: готовый проект с Hello World
@rynt/extension-buildVite-пресет, host-shim’ы, rynt-extension-pack.ryntextension
@rynt/sdkAPI расширений, UI-кит, типы, маркетплейс

Типичный порядок: create-extension → разработка с extension-build + sdk → установка .ryntextension в лаунчер.


1. Создать проект

bash
npm create @rynt/extension@latest my-extension
cd my-extension
npm install

Используйте @rynt/extension, не @rynt/create-extension — иначе npm ищет несуществующий @rynt/create-create-extension.

Интерактивно спросит каталог, manifest.id, название и автора. Без вопросов:

bash
npx create-rynt-extension my-extension \
  --id @acme/my-extension \
  --name "My Extension" \
  --yes

→ Подробнее на странице Первое расширение (Hello World).


2. Зависимости вручную

Если проект уже есть (свой Vite + Vue), добавьте:

bash
npm install vue
npm install -D @rynt/sdk @rynt/extension-build vite @vitejs/plugin-vue typescript vue-tsc

Минимальный vite.config.ts — см. README @rynt/extension-build или сборку и упаковку.


3. Скрипты

json
{
  "scripts": {
    "dev": "vite build --watch",
    "build": "vite build && rynt-extension-pack",
    "typecheck": "vue-tsc -p tsconfig.json --noEmit"
  }
}
КомандаЧто происходит
npm run devПересборка при изменениях + Extension Dev Bridge
npm run builddist/ и архив .ryntextension для установки

@rynt/sdk: что импортировать

ИмпортКогда
@rynt/sdk/extensiondefineRyntExtension, реестры, useModel, лоадеры
@rynt/sdkUI: Button, Dialog, Block, …
@rynt/sdk/extension-marketplaceREST-клиент каталога (редко в простых расширениях)
@rynt/sdk/extension-expose-mapТипы для useExtensionExpose между пакетами

Обзор subpath’ов: SDK.


Манифест

Обязательно в ryntExtensionViteConfig({ manifest }):

ПолеПример
id@acme/my-extension
nameОтображаемое имя
extensionApi"1"
engines.rynt">=0.9.0"
main"index.js"
icon./assets/icon.png

Манифест и зависимости


Установка в лаунчер

  • Dev: включить dev-hub в «Управление расширениями», запустить npm run dev.
  • Релиз: npm run build, установить .ryntextensionсборка и установка.

Ссылки