create-mirta 0.3.5 → 0.4.4

package/{dist/templates/base/_gitignore → templates/shared/base/content/_.gitignore}

@@ -15,10 +15,8 @@ coverage
 
 # dotenv environment variable files
 .env
-.env.development.local
-.env.test.local
-.env.production.local
 .env.local
+.env.*.local
 
 # Editor directories and files
 .vscode/*

package/templates/shared/base/content/_.node-version

@@ -0,0 +1 @@
+24.12.0

package/{dist/templates/base/.vscode → templates/shared/base/content/_.vscode}/settings.json

@@ -1,5 +1,14 @@
 {
   "files.eol": "\n",
+  "files.associations": {
+    "mirta.config.json": "jsonc"
+  },
+  "json.schemas": [{
+    "fileMatch": ["mirta.config.json"],
+    "schema": {
+      "allowTrailingCommas": true
+    }
+  }],
   "task.autoDetect": "off",
   "todohighlight.keywords": [
     {
@@ -37,5 +46,7 @@
     "cursor": "pointer",
     "fontWeight": "bold",
     "borderRadius": "2px"
-  }
+  },
+  "npm.packageManager": "pnpm",
+  "npm.scriptRunner": "pnpm"
 }

package/templates/shared/base/content/package.json

@@ -0,0 +1,19 @@
+{
+  "private": true,
+  "type": "module",
+  "scripts": {},
+  "dependencies": {},
+  "devDependencies": {
+    "@mirta/cli": "0.4.4",
+    "@mirta/globals": "0.4.4",
+    "@mirta/rollup": "0.4.4",
+    "@mirta/tsconfig": "0.4.4",
+    "@types/node": "^24.10.1",
+    "cross-env": "^10.1.0",
+    "rollup": "^4.55.1",
+    "typescript": "^5.8.3"
+  },
+  "engines": {
+    "node": ">=24.12.0"
+  }
+}

package/templates/shared/base/features/connection/_.env.local.tt

@@ -0,0 +1 @@
+WB_CONN_SECRET={{connectionString}}

package/templates/shared/base/features/connection/mirta.config.json

@@ -0,0 +1,6 @@
+{
+  "connections": {
+    // Строка подключения находится в файле .env.local
+    "default": "${WB_CONN_SECRET}"
+  }
+}

package/templates/shared/base/features/eslint/package.json

@@ -0,0 +1,9 @@
+{
+  "devDependencies": {
+    "@eslint/js": "^9.39.2",
+    "@stylistic/eslint-plugin": "^5.6.1",
+    "eslint": "^9.39.2",
+    "globals": "^17.0.0",
+    "typescript-eslint": "^8.49.0"
+  }
+}

package/templates/shared/base/features/examples/mirta.config.json.tt

@@ -0,0 +1,51 @@
+{
+  "connections": {
+    "default": "{{defaultConnectionString}}"
+  },
+  "deploy": {
+    // Наборы правил копирования файлов: из папки проекта в папку контроллера.
+    "mappings": {
+      // Стандартный набор для wb-rules под Duktape на ES5.
+      "wb-rules-es5": [
+        // Копирование модулей.
+        {
+          "from": "dist/es5/wb-rules-modules/",
+          "to": "/mnt/data/etc/wb-rules-modules/",
+
+          // Очистить целевое расположение от других файлов.
+          "cleanup": true
+        },
+        // Копирование скриптов.
+        {
+          "from": "dist/es5/wb-rules/",
+          "to": "/mnt/data/etc/wb-rules/",
+
+          // Очистить целевое расположение от других файлов.
+          "cleanup": true,
+
+          // Предотвратить очистку для указанных файлов, они останутся.
+          // Можно использовать wildcard.
+          "protect": ["alarms.conf"]
+        }
+      ],
+      // Расширенный набор: добавляем ещё и шаблоны устройств.
+      "templates": [
+        {
+          "from": "templates/",
+          "to": "/etc/wb-mqtt-serial.conf.d/templates/",
+
+          // Существующие шаблоны не удаляем.
+          "cleanup": false
+        }
+      ]
+    },
+    // Профили деплоя.
+    "profiles": {
+      // Встроенный профиль (здесь переопределён явно)
+      "default": {
+        "connection": "default",
+        "mappings": ["wb-rules-es5"]
+      }
+    }
+  }
+}

package/templates/shared/base/features/github/_.github/workflows/build.yml.tt

@@ -0,0 +1,56 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - {{githubBranch}}
+  pull_request:
+    branches:
+      - {{githubBranch}}
+
+jobs:
+{{#if features.vitest}}
+  test:
+    if: ${{ !startsWith(github.event.head_commit.message, 'release') }}
+    uses: ./.github/workflows/test.yml
+{{/if features.vitest}}
+  build:
+    # Prevents this action from running on forks.
+    if: github.repository == '{{githubOwner}}/{{githubRepository}}'
+{{#if features.vitest}}
+    needs: test
+{{/if features.vitest}}
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: '.node-version'
+          cache: 'pnpm'
+
+      - name: Install Dependencies
+        run: pnpm install
+
+      - name: Build
+        run: pnpm build
+{{#if templates.packages}}
+      - name: Continuous Release
+        # Prevents this step from running on pull requests.
+        # Runs only when commit message starts with 'fix' or 'feat'.
+        if: |
+          github.event_name == 'push' && (
+            startsWith(github.event.head_commit.message, 'fix') ||
+            startsWith(github.event.head_commit.message, 'feat')
+          )
+        # NOTE: --compact is temporarily removed
+        # because some packages in ./packages/* are not yet published to npm.
+        # It will be re-enabled once all packages are published or we add filtering.
+        run: pnpx pkg-pr-new publish --pnpm './packages/*' --template './sites/*'
+{{/if templates.packages}}

package/templates/shared/base/features/github-vitest/_.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Test
+
+on: workflow_call
+
+permissions:
+  contents: read # To fetch code (actions/checkout)
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: '.node-version'
+          cache: 'pnpm'
+
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run tests
+        run: pnpm run test

package/templates/shared/base/features/vitest/package.json

@@ -0,0 +1,10 @@
+{
+  "scripts": {
+    "test": "vitest run --config @mirta/testing/config"
+  },
+  "devDependencies": {
+    "@mirta/testing": "0.4.4",
+    "vitest": "^4.0.8",
+    "vitest-mock-extended": "^3.1.0"
+  }
+}

package/templates/shared/base/features/vitest-eslint/package.json

@@ -0,0 +1,5 @@
+{
+  "devDependencies": {
+    "@vitest/eslint-plugin": "^1.6.4"
+  }
+}

package/templates/shared/base/template.json

@@ -0,0 +1,17 @@
+{
+  "hidden": true,
+  "features": {
+    "global": {
+      "examples": "recommended",
+      "connection": "recommended",
+      "eslint": "recommended",
+      "vitest": "optional",
+      "github": "optional"
+    },
+    "compound": [
+      "github-vitest",
+      "vitest-eslint"
+    ]
+  },
+  "order": 0
+}

package/dist/locales/en-US.json

@@ -1,85 +0,0 @@
-{
-  "title": "The Framework to write wb-rules in TypeScript",
-  "captions": {
-    "intro": "Project Settings",
-    "deploy": "Deploy Settings"
-  },
-  "projectName": {
-    "message": "Project Name (target directory):"
-  },
-  "packageName": {
-    "message": "Package name:",
-    "errorMessage": "Format is not valid"
-  },
-  "shouldOverwrite": {
-    "directory": {
-      "current": "Current directory",
-      "target": "Target directory"
-    },
-    "message": "is not empty.",
-    "confirmDelete": "Remove existing files before continue?"
-  },
-  "ssh": {
-    "username": "🔑 SSH Username:",
-    "host": "🌐 SSH Host:",
-    "port": "🚩 SSH Port:",
-    "useRutoken": "Use Rutoken ECP"
-  },
-  "featureSelection": {
-    "message": "Select features to include in your project:",
-    "hint": "↑/↓ to navigate, space to select, A to toggle all, Enter to confirm"
-  },
-  "addEslint": {
-    "message": "ESLint",
-    "hint": "error prevention"
-  },
-  "addVitest": {
-    "message": "Mirta Testing",
-    "hint": "Vitest, unit-testing and simulations"
-  },
-  "addStore": {
-    "message": "Mirta Store",
-    "hint": "state management"
-  },
-  "validation": {
-    "required": "Must be provided"
-  },
-  "status": {
-    "success": "Success",
-    "error": "Error",
-    "canceled": "Canceled",
-    "scaffolding": "Scaffolding project in",
-    "scaffolded": "The project has been scaffolded",
-    "installingDependencies": "Calling the package manager"
-  },
-  "accent": {
-    "recommended": "(recommended)",
-    "ifConfigured": "(if configured)"
-  },
-  "dependencies": {
-    "question": "Install project dependencies?",
-    "current": {
-      "message": "Yes, use"
-    },
-    "pnpm": {
-      "message": "Yes, use PNPM",
-      "hint": "recommended"
-    },
-    "yarn": {
-      "message": "Yes, use Yarn"
-    },
-    "npm": {
-      "message": "Yes, use NPM"
-    },
-    "bun": {
-      "message": "Yes, use Bun"
-    },
-    "no": {
-      "message": "No, I will handle that myself"
-    }
-  },
-  "errors": {
-    "operationCanceled": "Operation canceled",
-    "rootIsNotRelative": "Location is out of working directory"
-  }
-}

package/dist/locales/ru-RU.json

@@ -1,86 +0,0 @@
-{
-  "title": "Фреймворк для создания правил wb-rules на TypeScript",
-  "captions": {
-    "intro": "Параметры проекта",
-    "deploy": "Параметры деплоя на контроллер"
-  },
-  "projectName": {
-    "message": "Название (целевая директория):",
-    "errorMessage": "Требуется указать значение"
-  },
-  "packageName": {
-    "message": "Название пакета:",
-    "errorMessage": "Недопустимый формат ввода"
-  },
-  "shouldOverwrite": {
-    "directory": {
-      "current": "Текущая директория",
-      "target": "Указанная директория"
-    },
-    "message": "содержит файлы.",
-    "confirmDelete": "Удалить их?"
-  },
-  "ssh": {
-    "username": "🔑 Пользователь SSH:",
-    "host": "🌐 Хост SSH:",
-    "port": "🚩 Порт SSH:",
-    "useRutoken": "Использовать Рутокен ЭЦП?"
-  },
-  "featureSelection": {
-    "message": "Выберите добавляемый функционал:",
-    "hint": "↑/↓ для навигации, пробел для выбора, A - выбрать всё, Enter - подтвердить"
-  },
-  "addEslint": {
-    "message": "ESLint",
-    "hint": "предотвращение потенциальных проблем в коде"
-  },
-  "addVitest": {
-    "message": "Mirta Testing",
-    "hint": "Юнит-тесты и имитатор запуска на контроллере"
-  },
-  "addStore": {
-    "message": "Mirta Store",
-    "hint": "хранилище состояний"
-  },
-  "validation": {
-    "required": "Требуется указать значение"
-  },
-  "status": {
-    "success": "Успешно",
-    "error": "Ошибка",
-    "canceled": "Отменено",
-    "scaffolding": "Генерация файлов проекта в",
-    "scaffolded": "Проект создан",
-    "installingDependencies": "Вызов менеджера пакетов"
-  },
-  "accent": {
-    "recommended": "(рекомендуется)",
-    "ifConfigured": "(если настроен)"
-  },
-  "dependencies": {
-    "question": "Установить требуемые зависимости?",
-    "current": {
-      "message": "Да, используя"
-    },
-    "pnpm": {
-      "message": "Да, используя pnpm",
-      "hint": "рекомендуется"
-    },
-    "yarn": {
-      "message": "Да, используя yarn"
-    },
-    "npm": {
-      "message": "Да, используя npm"
-    },
-    "bun": {
-      "message": "Да, используя bun"
-    },
-    "no": {
-      "message": "Нет, разберусь с этим самостоятельно"
-    }
-  },
-  "errors": {
-    "operationCanceled": "Операция прервана",
-    "rootIsNotRelative": "Расположение находится вне рабочей директории"
-  }
-}

package/dist/templates/base/package.json

@@ -1,27 +0,0 @@
-{
-  "private": true,
-  "engines": {
-    "node": ">=20.6.0"
-  },
-  "type": "module",
-  "imports": {
-    "#wb/*": [
-      "./src/wb-rules/*.js"
-    ],
-    "#wbm/*": [
-      "./src/wb-rules-modules/*.js"
-    ]
-  },
-  "scripts": {
-    "build": "cross-env NODE_ENV=production rollup -c",
-    "build:dev": "cross-env NODE_ENV=development rollup -c"
-  },
-  "dependencies": {
-    "mirta": "0.3.5"
-  },
-  "devDependencies": {
-    "@mirta/rollup": "0.3.5",
-    "cross-env": "^10.1.0",
-    "rollup": "^4.52.4"
-  }
-}

package/dist/templates/base/rollup.config.mjs

@@ -1,15 +0,0 @@
-import { defineConfig } from '@mirta/rollup'
-
-export default defineConfig({
-  dotenv: {
-    /**
-     * При использовании префикса, переменные
-     * окружения будут отфильтрованы по нему.
-     *
-     * Например, префиксу APP_ соответствует
-     * переменная окружения APP_NAME.
-     *
-     **/
-    prefix: '^APP_',
-  },
-})

package/dist/templates/config/typescript/package.json

@@ -1,8 +0,0 @@
-{
-  "devDependencies": {
-    "@mirta/globals": "0.3.5",
-    "@mirta/tsconfig": "0.3.5",
-    "@types/node": "^24.9.1",
-    "typescript": "^5.8.3"
-  }
-}

package/dist/templates/config/vitest/package.json

@@ -1,10 +0,0 @@
-{
-  "scripts": {
-    "test": "vitest run"
-  },
-  "devDependencies": {
-    "@mirta/testing": "0.3.5",
-    "vitest": "^3.2.4",
-    "vitest-mock-extended": "^3.1.0"
-  }
-}

package/dist/templates/config/vitest/tests/setup/dotenv.ts

@@ -1,5 +0,0 @@
-import { env as dotenv } from '@dotenv-run/core'
-
-dotenv({
-  prefix: '^APP_',
-})

package/dist/templates/config/vitest/tests/setup/mirta.ts

@@ -1,41 +0,0 @@
-import { vi } from 'vitest'
-import { mock } from 'vitest-mock-extended'
-
-// Базовая (подавляющая) имитация API движка wb-rules.
-// Для каждого файла с тестами этот код выполняется заново.
-//
-// Используется с целью перехвата и подавления обращений
-// к отсутствующим на компьютере функциям контроллера.
-//
-// В файлах тестов можно переопределить поведение подавления
-// на выдачу заготовленного ответа. Пригодится для симуляции
-// внештатных ситуаций и оценки работы алгоритма
-// в этих условиях.
-
-const createLogger = () => {
-
-  const logger = vi.fn() as unknown as WbRules.Log
-
-  logger.info = vi.fn()
-  logger.debug = vi.fn()
-  logger.warning = vi.fn()
-  logger.error = vi.fn()
-
-  return logger
-
-}
-
-global.module = mock<NodeJS.Module>()
-
-global.log = createLogger()
-global.debug = vi.fn() as WbRules.Debug
-global.dev = mock<WbRules.Dev>()
-global.defineVirtualDevice = vi.fn()
-global.getDevice = vi.fn(() => mock<WbRules.Device>({
-  getControl: () => mock<WbRules.Control>(),
-}))
-global.getControl = vi.fn()
-global.trackMqtt = vi.fn()
-global.defineRule = vi.fn()
-global.Notify = mock<WbRules.Notify>()
-global.Alarms = mock<WbRules.Alarms>()

package/dist/templates/config/vitest/tests/tsconfig.json

@@ -1,9 +0,0 @@
-{
-  "extends": "../tsconfig",
-  "compilerOptions": {
-    "paths": {
-      "@wb/*": ["../src/wb-rules/*"],
-      "@wbm/*": ["../src/wb-rules-modules/*"]
-    }
-  }
-}

package/dist/templates/config/vitest/vitest.config.ts

@@ -1,37 +0,0 @@
-import { defineConfig } from 'vitest/config'
-import { fileURLToPath } from 'node:url'
-
-export default defineConfig({
-  define: {
-    __DEV__: true,
-    __TEST__: true,
-  },
-  resolve: {
-    alias: [
-      {
-        find: /^@wb\/(.*?)$/,
-        replacement: fileURLToPath(
-          new URL('./src/wb-rules/$1', import.meta.url)
-        ),
-      },
-      {
-        find: /^@wbm\/(.*?)$/,
-        replacement: fileURLToPath(
-          new URL('./src/wb-rules-modules/$1', import.meta.url)
-        ),
-      },
-    ],
-  },
-  test: {
-    globals: true,
-    include: ['tests/**/*.{test,spec}.[jt]s'],
-    setupFiles: [
-      fileURLToPath(
-        new URL('./tests/setup/dotenv.ts', import.meta.url)
-      ),
-      fileURLToPath(
-        new URL('./tests/setup/mirta.ts', import.meta.url)
-      ),
-    ],
-  },
-})

package/dist/templates/example/base/src/wb-rules/00-dotenv.ts

@@ -1,52 +0,0 @@
-/**
- * @file Пример использования переменных окружения.
- *
- * Для типизации используется файл `types/env.d.ts`
- *
- * Значение каждой переменной определяется в специальных
- * файлах формата `.env`. Эти файлы хранятся отдельно от
- * основного исходного кода, что предотвращает случайную
- * утечку секретных данных в публичные репозитории.
- *
- * Основные файлы конфигурации включают:
- * .env
- * .env.local
- * .env.[mode].local
- *
- * Значение [mode] принимает `development`, `test` или `production`.
- *
- * Команда build:dev первым делом заглядывает
- * в файл `.env.development.local`
- *
- * Команда build обращается к значениям
- * в файле `.env.production.local`
- *
- * Юнит-тесты используют `.env.test.local`
- *
- * Если в обозначенных местах не обнаружилось искомых ключевых пар,
- * поиск выполняется поочерёдно в файлах `.env.local` и `.env`
- *
- * Примечание: переменные окружения
- * допускается передавать через командную строку - обратите
- * внимание на использование cross-env в package.json
- *
- * @since 0.2.1
- *
- **/
-
-// Условие выполнится только при сборке
-// командой `build:dev` (в режиме development).
-//
-// Если собрать проект
-// командой `build` (в режиме production),
-// код этого блока не попадёт на контроллер.
-//
-// Более того, поскольку других конструкций в скрипте нет,
-// то и сам скрипт не появится в каталоге dist.
-//
-if (__DEV__) {
-
-  // Выводим приветствие, подставляя название из переменной окружения.
-  log(`Hello from ${process.env.APP_NAME}`)
-
-}

package/dist/templates/example/base/src/wb-rules/01-count.ts

@@ -1,6 +0,0 @@
-import { useCounter } from '#wbm/counter'
-
-const counter = useCounter()
-
-counter.increment()
-log(`Current Value: ${counter.count}`)

package/dist/templates/example/base/src/wb-rules-modules/counter.ts

@@ -1,14 +0,0 @@
-export function useCounter() {
-
-  let count = 0
-
-  return {
-    get count() {
-      return count
-    },
-    increment() {
-      count += 1
-    }
-  }
-
-}