create-mirta 0.3.5 → 0.4.4

package/templates/mono/core/content/package.json

@@ -0,0 +1,6 @@
+{
+  "workspaces": [
+    "packages/*",
+    "sites/*"
+  ]
+}

package/templates/mono/core/content/pnpm-workspace.yaml

@@ -0,0 +1,3 @@
+packages:
+  - packages/*
+  - sites/*

package/templates/mono/core/content/tsconfig.json

@@ -0,0 +1,31 @@
+{
+  "extends": "@mirta/tsconfig",
+  "compilerOptions": {
+    "rootDir": ".",
+    "baseUrl": ".",
+    "types": [
+      "@mirta/globals",
+      "node"
+    ]
+  },
+  "include": [
+    "*.ts",
+    "*.mts",
+
+    // === JS ===
+
+    "packages/*/src/**/*.js",
+    "packages/*/tests/**/*.js",
+
+    "sites/*/src/**/*.js",
+    "sites/*/tests/**/*.js",
+
+    // === TS ===
+
+    "packages/*/src/**/*.ts",
+    "packages/*/tests/**/*.ts",
+
+    "sites/*/src/**/*.ts",
+    "sites/*/tests/**/*.ts"
+  ]
+}

package/templates/mono/core/features/eslint/eslint.config.mjs.tt

@@ -0,0 +1,126 @@
+import js from '@eslint/js'
+import globals from 'globals'
+import globalsMirta from '@mirta/globals/eslint'
+import tseslint from 'typescript-eslint'
+import stylistic from '@stylistic/eslint-plugin'
+{{#if features.vitest}}
+import vitest from '@vitest/eslint-plugin'
+{{/if features.vitest}}
+import { defineConfig, globalIgnores } from 'eslint/config'
+
+export default defineConfig([
+  {
+    files: ['**/*.{js,mjs,cjs,ts,mts,cts}'],
+    plugins: { js },
+    extends: ['js/recommended'],
+  },
+  {
+    files: ['**/*.{js,mjs,cjs,ts,mts,cts}'],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globalsMirta,
+      },
+    },
+  },
+  // TypeScript Defaults
+  ...tseslint.configs.strictTypeChecked.map(config => ({
+    ...config,
+    files: ['**/*.ts'],
+  })),
+  ...tseslint.configs.stylisticTypeChecked.map(config => ({
+    ...config,
+    files: ['**/*.ts'],
+  })),
+  // TypeScript Overrides
+  {
+    files: ['**/*.ts'],
+    rules: {
+      // Позволяет работать с dev['deviceId']['controlId']
+      '@typescript-eslint/dot-notation': 'off',
+      // Разрешает интерполяцию базовых типов
+      '@typescript-eslint/restrict-template-expressions': ['error', {
+        allowAny: false,
+        allowBoolean: true,
+        allowNullish: true,
+        allowNumber: true,
+        allowRegExp: true,
+      }],
+      // Разрешает неиспользуемые переменные с символом подчёркивания
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        {
+          'args': 'all',
+          'argsIgnorePattern': '^_',
+          'caughtErrors': 'all',
+          'caughtErrorsIgnorePattern': '^_',
+          'destructuredArrayIgnorePattern': '^_',
+          'varsIgnorePattern': '^_',
+          'ignoreRestSiblings': true,
+        },
+      ],
+      '@typescript-eslint/prefer-nullish-coalescing': ['error', {
+        'ignorePrimitives': {
+          'string': true,
+        },
+      }],
+    },
+    languageOptions: {
+      parserOptions: {
+        project: [
+          './tsconfig.json',
+          './packages/*/tsconfig.json',
+          './sites/*/tsconfig.json',
+        ],
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  // Stylistic Defaults
+  {
+    files: ['**/*.{js,mjs,cjs,ts,mts,cts}'],
+    ...stylistic.configs.customize({
+      quotes: 'single',
+      quoteProps: 'consistent',
+      indent: 2,
+    }),
+  },
+  // Stylistic Overrides
+  {
+    files: ['**/*.{js,mjs,cjs,ts,mts,cts}'],
+    rules: {
+      '@stylistic/comma-dangle': ['error', {
+        'arrays': 'always-multiline',
+        'objects': 'always-multiline',
+      }],
+      '@stylistic/curly-newline': ['error', 'always'],
+      '@stylistic/nonblock-statement-body-position': ['error', 'below'],
+      '@stylistic/padded-blocks': ['error', {
+        'blocks': 'always',
+      }],
+    },
+  },
+{{#if features.vitest}}
+  // Vitest Defaults
+  {
+    files: ['packages/*/tests/**', 'sites/*/tests/**'],
+    plugins: {
+      vitest,
+    },
+    rules: {
+      ...vitest.configs.recommended.rules,
+    },
+    languageOptions: {
+      globals: {
+        ...vitest.environments.env.globals,
+      },
+    },
+  },
+{{/if features.vitest}}
+  globalIgnores([
+    'node_modules/',
+    'dist/',
+    'packages/*/dist/',
+    'sites/*/dist/',
+  ]),
+])

package/templates/mono/core/template.json

@@ -0,0 +1,5 @@
+{
+  "extends": "base",
+  "hidden": true,
+  "order": 2000
+}

package/templates/mono/package/content/package.json

@@ -0,0 +1,6 @@
+{
+  "scripts": {
+    "build": "cross-env NODE_ENV=production pnpm --filter ./packages/* --filter ./sites/* run build:mono",
+    "build:dev": "pnpm --filter ./packages/* --filter ./sites/* run build:mono"
+  }
+}

package/templates/mono/package/features/package/packages/{{package}}/package.json.tt

@@ -0,0 +1,28 @@
+{
+  "name": "{{packageFull}}",
+  "version": "0.0.0",
+  "keywords": [
+    "mirta",
+    "wb-rules"
+  ],
+  "type": "module",
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      }
+    }
+  },
+  "imports": {
+    "#src/*": "./src/*.js"
+  },
+  "scripts": {
+    "build:mono": "rollup -c node:@mirta/rollup/config-package"
+  }
+}

package/templates/mono/package/features/package/packages/{{package}}/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src"
+  },
+  "include": [
+    "src/**/*.js",
+    "src/**/*.ts"
+  ]
+}

package/templates/mono/package/features/package/sites/{{package}}-demo/package.json.tt

@@ -0,0 +1,19 @@
+{
+  "name": "{{package}}-demo",
+  "private": true,
+  "imports": {
+    "#wb/*": [
+      "./src/wb-rules/*.js"
+    ],
+    "#wbm/*": [
+      "./src/wb-rules-modules/*.js"
+    ]
+  },
+  "scripts": {
+    "build:mono": "rollup -c node:@mirta/rollup/config",
+    "wb:deploy": "mirta deploy"
+  },
+  "dependencies": {
+    "{{packageFull}}": "workspace:*"
+  }
+}

package/templates/mono/package/features/package/sites/{{package}}-demo/tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "."
+  },
+  "include": [
+    "src/**/*.js",
+    "src/**/*.ts"
+  ]
+}

package/templates/mono/package/features/package-examples/packages/{{package}}/src/index.ts

@@ -0,0 +1,2 @@
+export { useThermostat } from './thermostat'
+export type { ThermostatOptions } from './types'

package/templates/mono/package/features/package-examples/packages/{{package}}/src/thermostat.ts

@@ -0,0 +1,99 @@
+import { isNumber, isString } from '@mirta/basics'
+
+import { type ThermostatOptions } from './types'
+
+// Thermostat Module Example
+
+// Примечание авторам модулей: обязательно используйте комментарии в формате JSDoc,
+// чтобы документировать ваши конструкции удобными всплывающими подсказками.
+
+/**
+ * Логика температурного регулятора.
+ *
+ * @param options Параметры термостата.
+ *
+ * @example
+ * ```ts
+ * import { useThermostat } from '@nickname/mirta-thermostat'
+ *
+ * const thermostat = useThermostat({
+ *   sensorTopic: 'A60-M1W3/External Sensor 1',
+ *   heaterTopic: 'wb-gpio/EXT4_R3A1',
+ *   targetTemp: 22,
+ *   hysteresis: 0.5
+ * })
+ *
+ * // Установить новое значение целевой температуры:
+ * thermostat.setTargetTemp(24)
+ *
+ * ```
+ **/
+export function useThermostat(options: ThermostatOptions) {
+
+  const { sensorTopic, heaterTopic, hysteresis = 0.5 } = options
+
+  let targetTemp = options.targetTemp
+
+  defineRule({
+
+    // При изменении показаний в топике датчика температуры...
+    whenChanged: sensorTopic,
+
+    // ...проверяем, не вышла ли температура за пределы допустимых значений.
+    then: (newValue) => {
+
+      let currentTemp: number | undefined
+
+      // Проверяем, является ли значение текущей температуры допустимым.
+
+      if (isNumber(newValue)) {
+
+        currentTemp = newValue
+
+      }
+      else if (isString(newValue)) {
+
+        currentTemp = parseFloat(newValue)
+
+      }
+
+      if (currentTemp === undefined || isNaN(currentTemp)) {
+
+        // Отключаем нагреватель, если значение температуры не удаётся прочитать.
+        dev[heaterTopic] = false
+
+        // Записываем в лог сообщение об ошибке.
+        log.error('[Thermostat Module] Invalid temperature value: {}', newValue)
+
+        // Прерываем дальше выполнения правила.
+        return
+
+      }
+
+      if (currentTemp <= (targetTemp - hysteresis)) {
+
+        // Если температура ниже минимальной, включаем нагреватель.
+        dev[heaterTopic] = true
+
+      }
+      else if (currentTemp >= (targetTemp + hysteresis)) {
+
+        // Если температура выше максимальной, выключаем нагреватель.
+        dev[heaterTopic] = false
+
+      }
+
+    },
+  })
+
+  return {
+
+    /** Позволяет установить новое значение целевой температуры. */
+    setTargetTemp(newValue: number) {
+
+      targetTemp = newValue
+
+    },
+  }
+
+}

package/templates/mono/package/features/package-examples/packages/{{package}}/src/types.ts

@@ -0,0 +1,25 @@
+/** Опции термостата. */
+export interface ThermostatOptions {
+
+  /** MQTT-топик датчика температуры. */
+  sensorTopic: string
+
+  /** MQTT-топик нагревательного элемента. */
+  heaterTopic: string
+
+  /** Начальное значение целевой температуры. */
+  targetTemp: number
+
+  /**
+   * Разница температур для предотвращения частых переключений между включением и выключением нагрева.
+   *
+   * Значение по умолчанию: `0.5` °C.
+   *
+   * Обычно рекомендуется задавать гистерезис в диапазоне
+   * от `0.5` до `2` °C. Чем больше величина гистерезиса,
+   * тем реже будут происходить циклы включения-выключения, однако
+   * точность поддержания заданной температуры снизится.
+   *
+   **/
+  hysteresis?: number
+}

package/templates/mono/package/features/package-examples/sites/{{package}}-demo/src/wb-rules/01-thermo.ts.tt

@@ -0,0 +1,11 @@
+import { useThermostat } from '{{packageFull}}'
+
+const thermostat = useThermostat({
+  sensorTopic: 'A60-M1W3/External Sensor 1',
+  heaterTopic: 'wb-gpio/EXT4_R3A1',
+  targetTemp: 22,
+  hysteresis: 0.5,
+})
+
+// Установить новое значение целевой температуры:
+thermostat.setTargetTemp(24)

package/templates/mono/package/features/package-examples-vitest/packages/{{package}}/tests/mirta-thermostat.test.ts

@@ -0,0 +1,72 @@
+import { useSimulator } from '@mirta/testing'
+import { useThermostat } from '#src/index'
+
+const simulator = useSimulator()
+
+beforeEach(() => {
+
+  simulator.reset()
+
+})
+
+describe('useThermostat', () => {
+
+  const heaterTopic = 'deviceId/heater'
+  const sensorTopic = 'deviceId/sensor'
+
+  beforeEach(() => {
+
+    dev[heaterTopic] = false
+    useThermostat({
+      sensorTopic: sensorTopic,
+      heaterTopic: heaterTopic,
+      targetTemp: 22,
+      hysteresis: 0.5,
+    })
+
+  })
+
+  it('turns on heater when temperature drops below target', () => {
+
+    simulator.defineRule.run({ topic: sensorTopic, value: 21 })
+    expect(dev[heaterTopic]).toBe(true)
+
+  })
+
+  it('turns off heater when temperature above target', () => {
+
+    dev[heaterTopic] = true
+
+    simulator.defineRule.run({ topic: sensorTopic, value: 23 })
+    expect(dev[heaterTopic]).toBe(false)
+
+  })
+
+  it('handles invalid temperature values', () => {
+
+    dev[heaterTopic] = true
+
+    simulator.defineRule.run({ topic: sensorTopic, value: 'invalid_value' })
+    expect(dev[heaterTopic]).toBe(false)
+
+  })
+
+  it('does not toggle heater inside hysteresis band', () => {
+
+    dev[heaterTopic] = true
+
+    simulator.defineRule.run({ topic: sensorTopic, value: 22.4 })
+    expect(dev[heaterTopic]).toBe(true)
+
+  })
+
+  it('does not toggle heater inside hysteresis band (heater off)', () => {
+
+    dev[heaterTopic] = false
+
+    simulator.defineRule.run({ topic: sensorTopic, value: 21.6 })
+    expect(dev[heaterTopic]).toBe(false)
+
+  })
+
+})

package/templates/mono/package/features/package-github/packages/{{package}}/package.json.tt

@@ -0,0 +1,11 @@
+{
+  "homepage": "https://github.com/{{githubOwner}}/{{githubRepository}}/tree/{{githubBranch}}/packages/{{package}}#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/{{githubOwner}}/{{githubRepository}}.git",
+    "directory": "packages/{{package}}"
+  },
+  "bugs": {
+    "url": "https://github.com/{{githubOwner}}/{{githubRepository}}/issues"
+  }
+}

package/templates/mono/package/template.json

@@ -0,0 +1,16 @@
+{
+  "extends": "core",
+  "features": {
+    "global": {
+      "package": "required",
+      "github": "recommended",
+      "vitest": "recommended"
+    },
+    "compound": [
+      "package-github",
+      "package-examples",
+      "package-examples-vitest"
+    ]
+  },
+  "order": 2020
+}

package/templates/mono/sites/content/mirta.config.json

@@ -0,0 +1,37 @@
+{
+  "deploy": {
+    // Профили деплоя.
+    "profiles": {
+      // Стабильные разработки
+      "home": {
+        // Использовать подключение по умолчанию.
+        "connection": "default",
+
+        // Предустановки копирования директорий.
+        "mappings": ["wb-rules-es5"]
+      },
+      // Экспериментальный код
+      "home-staging": {
+
+        /**
+         * Варианты значений для connection:
+         *
+         * Явная строка подключения (не рекомендуется для публичных репозиториев)
+         * "connection": "ssh://user@192.168.42.1",
+         *
+         * Переменные окружения и их комбинации:
+         * "connection": "${WB_CONN_WORK};wsl=${WB_WSL}",
+         *
+         * Предопределённая строка подключения из `connections`:
+         * "connection": "work",
+         **/
+
+        // Использовать подключение по умолчанию.
+        "connection": "default",
+
+        // Предустановки копирования директорий.
+        "mappings": ["wb-rules-es5"]
+      }
+    }
+  }
+}

package/templates/mono/sites/content/package.json

@@ -0,0 +1,6 @@
+{
+  "scripts": {
+    "build": "cross-env NODE_ENV=production pnpm --filter ./sites/* run build:mono",
+    "build:dev": "pnpm --filter ./sites/* run build:mono"
+  }
+}

package/templates/mono/sites/content/sites/home/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "home",
+  "private": true,
+  "type": "module",
+  "imports": {
+    "#wb/*": [
+      "./src/wb-rules/*.js"
+    ],
+    "#wbm/*": [
+      "./src/wb-rules-modules/*.js"
+    ]
+  },
+  "scripts": {
+    "build:mono": "rollup -c node:@mirta/rollup/config",
+    "wb:deploy": "mirta deploy --profile=home"
+  }
+}

package/templates/mono/sites/content/sites/home-staging/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "home-staging",
+  "private": true,
+  "type": "module",
+  "imports": {
+    "#wb/*": [
+      "./src/wb-rules/*.js"
+    ],
+    "#wbm/*": [
+      "./src/wb-rules-modules/*.js"
+    ]
+  },
+  "scripts": {
+    "build:mono": "rollup -c node:@mirta/rollup/config",
+    "wb:deploy": "mirta deploy --profile=home-staging"
+  }
+}

package/templates/mono/sites/features/examples/sites/home/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "home",
+  "private": true,
+  "type": "module",
+  "imports": {
+    "#wb/*": [
+      "./src/wb-rules/*.js"
+    ],
+    "#wbm/*": [
+      "./src/wb-rules-modules/*.js"
+    ]
+  },
+  "scripts": {
+    "build:mono": "rollup -c node:@mirta/rollup/config",
+    "wb:deploy": "mirta deploy --profile=home"
+  }
+}

package/templates/mono/sites/features/examples/sites/home/src/wb-rules/01-startup.ts

@@ -0,0 +1 @@
+log('This is fine.')

package/templates/mono/sites/features/examples/sites/home-staging/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "work",
+  "private": true,
+  "type": "module",
+  "imports": {
+    "#wb/*": [
+      "./src/wb-rules/*.js"
+    ],
+    "#wbm/*": [
+      "./src/wb-rules-modules/*.js"
+    ]
+  },
+  "scripts": {
+    "build:mono": "rollup -c node:@mirta/rollup/config",
+    "wb:deploy": "mirta deploy --profile=home-staging"
+  }
+}

package/templates/mono/sites/features/examples/sites/home-staging/src/wb-rules/01-startup.ts

@@ -0,0 +1 @@
+log('This is fine staging.')

package/templates/mono/sites/template.json

@@ -0,0 +1,4 @@
+{
+  "extends": "core",
+  "order": 2010
+}

package/{dist/templates/base/_editorconfig → templates/shared/base/content/_.editorconfig}

@@ -1,4 +1,4 @@
-[*]
+[*.{js,jsx,mjs,cjs,ts,tsx,mts,cts,json,yml,yaml}]
 charset = utf-8
 insert_final_newline = true
 end_of_line = lf