Документация

HCM Forge — CLI, транспилятор и генерация типов для WebSoft HCM. Всё, что нужно для начала работы.

Быстрый старт

Шаг 1. Установите CLI

pnpm add -g @hcmforge/cli

Требуется Node.js 20+ и pnpm 9+. Проверить: node --version и pnpm --version.

Шаг 2. Инициализируйте проект

cd ваш-проект
wshcm init

Создастся hcmforge.config.json, папки src/ и dist/.

Шаг 3. Соберите проект

wshcm build

Все .ts из src/ превратятся в .js в dist/. Дальше — загружайте в WebSoft HCM.

Установка типов

Команда wshcm types add генерирует .d.ts для стандартных функций WebSoft HCM (SelectDoc, XQuery, GetCurUserID и др.). После этого в VS Code работает автодополнение и подсказки типов.

wshcm types add

Файлы появятся в types/hcmforge/. Убедитесь, что tsconfig.json включает эту папку:

  "include": ["src/**/*", "types/**/*.d.ts"]

⚠️ Команда требует лицензии Team или выше. Без неё вернётся ошибка.

Команды CLI

КомандаЧто делает
wshcm initСоздать hcmforge.config.json и папки src/ и dist/
wshcm buildТранспилировать все .ts из src/ в dist/
wshcm watchТо же, но следить за изменениями (Ctrl+C для выхода)
wshcm types addСгенерировать .d.ts для HCM (требует Team)
wshcm activate <key>Активировать лицензионный ключ
wshcm statusПоказать текущую лицензию
wshcm removeУдалить лицензию с этого устройства
wshcm --versionПоказать версию
wshcm --helpПоказать справку

Лицензирование

Как это работает:

  • Ключ выпускается подписью Ed25519 и проверяется offline.
  • При активации ключ сохраняется в ~/.hcmforge/license.json.
  • Никакие данные не покидают вашу машину.

Как активировать:

wshcm activate HCMF-team.eyJ2IjoxLC...

Проверить текущий статус:

wshcm status

VS Code Extension

Расширение HCM Forge доступно в VS Code Marketplace (публикация планируется). Пока — устанавливается вручную. Функции:

  • IntelliSense для HCM-типов
  • Сборка из палитры команд (Ctrl+Shift+P → «HCM Forge: Build»)
  • Диагностика синтаксиса в Problems
  • Статус-бар с текущим уровнем лицензии

Получение поддержки