create-ts-vite-project 0.1.0

package/.gitignore

@@ -0,0 +1,58 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# Dependencies
+node_modules/
+.pnp*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/versions
+
+# Build outputs
+dist/
+dist-ssr/
+build/
+coverage/
+*.tsbuildinfo
+
+# Environment variables
+.env
+.env.*
+!.env.example
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea/
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# OS generated files
+Thumbs.db
+
+# Temporary folders
+tmp/
+temp/
+.out/
+
+# Jest
+jest-cache/
+
+# ESLint cache
+.eslintcache
+
+# Optional
+out/
+android/

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 fwmakc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,388 @@
+# Шаблон для приложений
+
+Шаблон поддерживает мультиплатформенную разработку приложений под web, Windows / MacOS / Linux / Android / IOS.
+
+- TypeScript, Vite,
+- сборка под desktop с помощью Electron,
+- сборка под mobile с помощью Capacitor,
+- автопроверки и форматирование ESLint, Prettier,
+- автотесты Vitest,
+- модули ECMAScript (вместо CommonJS),
+- стандарт ES2022.
+
+# Начало работы
+
+Выполняем
+
+```
+yarn create ts-vite-project
+# npm create ts-vite-project
+```
+
+Проект будет установлен в папку с названием проекта.
+
+> Первым аргументом можно указать название проекта. Тогда будет выполнена автоматическая ускоренная установка без дополнительных вопросов. Также автоматически будут установлены базовые зависимости.
+
+# Быстрый запуск
+
+В режиме разработки:
+
+```
+yarn dev
+# npm run dev
+```
+
+Сборка проекта:
+
+```
+yarn build
+# npm run build
+```
+
+> Во время сборки запускается линтер, прохождение тестов, компиляция TypeScript и минификация.
+
+Можно выполнить только компиляцию:
+
+```
+yarn compile
+# npm run compile
+```
+
+Запуск:
+
+```
+yarn preview
+# npm run preview
+```
+
+# Запуск под десктоп
+
+В режиме разработки
+
+```
+yarn electron:dev
+```
+
+# Билд под десктопные устройства
+
+## Общие настройки
+
+Следующие настройки берутся из **package.json**:
+
+- name, имя пакета,
+- productName, название приложения,
+- version, версия,
+- author, автор,
+- description, описание.
+
+## Electron Builder
+
+Это более классический установщик.
+
+За билд отвечает **electron builder**, файл настроек **electron-builder.config.js**.
+
+Общий конфиг для всех устройств задается в корневых полях.
+
+За билд под ОС **Windows** отвечает секция **win**. В поле **target** указан **nsis**.
+
+Группа **nsis** отвечает за настройки этого установщика.
+
+Собираем приложение под десктоп
+
+```
+yarn electron:build
+```
+
+Готовое приложение будет лежать в каталоге
+
+```
+out/electron-builder
+```
+
+## Electron Forge
+
+Это более новый установщик.
+
+За билд отвечает **electron forge**, файл настроек **forge.config.js**.
+
+Общий конфиг для всех устройств задается в секции **packagerConfig**:
+
+- icon, иконка приложения,
+- asar, упаковщик ресурсов,
+- asarUnpack, внутренние ресурсы, которые будут запакованы,
+- extraResource, внешние ресурсы, которые не будут оставлены снаружи приложения.
+
+За билд под ОС **Windows** отвечает **maker-squirrel**.
+
+Здесь прописаны иконки:
+
+- iconUrl, намеренно оставлена пустой,
+- setupIcon, иконка для установки,
+- loadingGif, изображение во время установки.
+
+и другие настройки.
+
+Собираем приложение под десктоп
+
+```
+yarn electron:make
+```
+
+Готовое приложение будет лежать в каталоге
+
+```
+out/make/squirrel.windows
+```
+
+## Билд под MacOS
+
+* информация не проверена
+
+Добавить в **forge.config.js**:
+
+```
+  packagerConfig: {
+    name: 'YourApp',
+    executableName: 'YourApp',
+    appBundleId: 'com.yourcompany.yourapp',
+    appCategoryType: 'public.app-category.productivity',
+    osxSign: {
+      identity: 'Developer ID Application: Your Name (TEAM_ID)',
+      'hardened-runtime': true,
+      entitlements: 'entitlements.plist',
+      'entitlements-inherit': 'entitlements.plist',
+      'signature-flags': 'library'
+    },
+    osxNotarize: {
+      tool: 'notarytool',
+      appleId: process.env.APPLE_ID,
+      appleIdPassword: process.env.APPLE_PASSWORD,
+      teamId: process.env.APPLE_TEAM_ID
+    }
+  },
+```
+
+Упрощенная конфигурация (без подписи):
+
+```
+  packagerConfig: {
+    name: 'YourApp',
+    osxSign: {},
+    osxNotarize: {
+      tool: 'notarytool',
+    }
+  },
+```
+
+Сборка приложения:
+
+```
+# Только упаковать приложение (без установщиков)
+npm run package
+
+# Создать установщики (DMG, ZIP)
+npm run make
+
+# Собрать только для macOS
+npm run make -- --platform darwin
+
+# Собрать для конкретной архитектуры
+npm run make -- --platform darwin --arch x64
+npm run make -- --platform darwin --arch arm64
+npm run make -- --platform darwin --arch universal
+```
+
+Для подписи и нотификации cоздайте файл **entitlements.plist**:
+
+```
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>com.apple.security.cs.allow-jit</key>
+    <true/>
+    <key>com.apple.security.cs.allow-unsigned-executable-memory</key>
+    <true/>
+    <key>com.apple.security.cs.debugger</key>
+    <true/>
+    <key>com.apple.security.automation.apple-events</key>
+    <true/>
+</dict>
+</plist>
+```
+
+Подписать приложение:
+
+```
+npm run build --electron-mac-sign --product-id="your-product-id" --app-id="your-app-id" --name="Your-app-name" --version="version-number" --keystore-path=path/to/keystore-file.p12 --store-password=password
+```
+
+## Подготовка к сборке под мобильные устройства
+
+Сборку делаем через capacitor. Полностью все происходит в несколько шагов.
+
+Для настройки отредактируйте файл
+
+```
+capacitor.config.ts
+```
+
+Добавляем мобильное устройство. Это нужно сделать один раз после развертывания проекта.
+
+```
+yarn cap add android
+```
+
+Созданный каталог android содержит множество настроек приложения, которые хотелось бы сохранить в репозитории. Но он также содержит много временных файлов и копии проекта и поэтому получается слишком большим.
+
+Мы создали другой каталог app, где вы можете хранить все настройки и ресурсы для сборки.
+
+Перед сборкой вам просто нужно скопировать его содержимое
+
+```
+cp -rf app/android/* android/app/src/main
+```
+
+или
+
+```
+xcopy app\android\* android\app\src\main /E /H /C /I /Y
+```
+
+Выполняем предварительную сборку
+
+```
+yarn build
+```
+
+Копируем собранный проект для следующего этапа
+
+```
+yarn cap copy
+```
+
+## Билд под мобильные устройства
+
+Для дальнейшей сборки под android лучше всего работать в контейнере nodejs из проекта https://github.com/isengine/server.git
+
+Перейдем в каталог
+
+```
+cd android
+```
+
+Билд в режиме дебаг:
+
+```
+./gradlew assembleDebug
+```
+
+Готовое приложение будет лежать в каталоге
+
+```
+android/app/build/outputs/apk/debug/app-debug.apk
+```
+
+Билд в продакшн:
+
+```
+./gradlew assembleRelease
+```
+
+Готовое приложение теперь будет лежать в каталоге
+
+```
+android/app/build/outputs/apk/release/app-release-unsigned.apk
+```
+
+Дальнейшие действия лучше выполнять из корневого каталога проекта
+
+```
+cd ..
+```
+
+Создаем ключ для подписи
+
+```
+keytool -genkey -v -keystore MY_RELEASE_KEY.jks -keyalg RSA -keysize 2048 -validity 10000 -alias MY_KEY_ALIAS
+
+```
+
+Запишите созданные пароли и alias, так как они понадобятся вам в дальнейшем.
+
+Создаем копию приложения
+
+```
+cp android/app/build/outputs/apk/release/app-release-unsigned.apk android/app/build/outputs/apk/release/app-release.apk
+```
+
+Подписываем приложение
+
+```
+apksigner sign --ks MY_RELEASE_KEY.jks --ks-key-alias MY_KEY_ALIAS --ks-pass pass:YOUR_KEYSTORE_PASSWORD --key-pass pass:YOUR_KEY_PASSWORD android/app/build/outputs/apk/release/app-release.apk
+```
+
+Можно проверить подпись
+
+```
+apksigner verify android/app/build/outputs/apk/release/app-release.apk
+```
+
+Если APK подписан правильно, вы не увидите никаких ошибок.
+
+# Тестирование
+
+Тестируем с помощью **Vitest**.
+
+**Vitest** очень похож на **Jest**, но сразу оптимизирован для использования с **TypeScript** и **Vite**. С его помощью можно также тестировать DOM-элементы.
+
+Примеры использования приведены в проекте.
+
+Файлы для тестирования должны называться по маске **.test.ts** или **.spec.ts**:
+
+```
+src/intro.test.ts
+```
+
+Можно использовать наборы кейсов для тестирования. Они должны называться по маске **.case.ts**:
+
+```
+src/intro.case.ts
+```
+
+Хорошей практикой может быть помещать тесты и кейсы в отдельные папки:
+
+```
+tests/
+├── cases/
+|   ├── ....case.ts
+│   └── intro.case.ts
+├── ....test.ts
+└── intro.test.ts
+```
+
+Для запуска всех тестов используем команду
+
+```
+yarn test
+# npm run test
+```
+
+Чтобы запустить какой-либо определенный тест, указываем его в качестве аргумента:
+
+```
+yarn test ./src/tests/example.test.ts
+# npm run test ./src/tests/example.test.ts
+```
+
+# Поддержка
+
+Больше интересных библиотек в репозитории.
+
+Если проект понравился, и вы хотите меня поддержать, не пожалейте поставить звездочку.
+
+А сейчас просто обнимите своих родных и близких, скажите им, как вы их любите.
+
+# Лицензия
+
+Лицензия MIT, 2025

package/index.js

@@ -0,0 +1,239 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+const readline = require('readline');
+const { execSync } = require('child_process');
+
+// Задаем значения по-умолчанию
+const defaults = {
+  projectName: 'ts-vite-project',
+  version: '0.1.0',
+  productName: 'TS Vite Project',
+  description: 'TypeScript Vite application',
+  repository: '',
+  author: '',
+}
+
+const rl = readline.createInterface({
+  input: process.stdin,
+  output: process.stdout
+});
+
+function copyFile(filename, src, dest) {
+  fs.copyFileSync(path.join(src, filename), path.join(dest, filename));
+}
+
+function copyRecursive(src, dest) {
+  const entries = fs.readdirSync(src);
+
+  for (const entry of entries) {
+    const srcPath = path.join(src, entry);
+    const destPath = path.join(dest, entry);
+
+    const stat = fs.statSync(srcPath);
+
+    if (stat.isDirectory()) {
+      fs.mkdirSync(destPath, { recursive: true });
+      copyRecursive(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+function detectPackageManager() {
+  try {
+    // Проверяем, установлен ли yarn
+    execSync('yarn --version', { stdio: 'ignore' });
+    return 'yarn';
+  } catch (error) {
+    // Если yarn не установлен, используем npm
+    return 'npm';
+  }
+}
+
+async function executeNextSteps(targetDir, silent = false) {
+  console.log('\n🔧 Executing next steps...\n');
+
+  try {
+    // 1. Переходим в директорию проекта
+    process.chdir(targetDir);
+    console.log('📁 Changed to project directory');
+
+    // 2. Автоматическое определение или выбор менеджера пакетов
+    const detectedManager = detectPackageManager();
+    let selectedPackageManager = detectedManager;
+    if (!silent) {
+      const packageManagerAnswer = await question(`Package manager (npm/yarn, default: ${detectedManager}): `) || detectedManager;
+      const validPackageManagers = ['npm', 'yarn'];
+      selectedPackageManager = validPackageManagers.includes(packageManagerAnswer.toLowerCase()) 
+        ? packageManagerAnswer.toLowerCase() 
+        : detectedManager;
+    }
+    console.log(`📦 Using package manager: ${selectedPackageManager}`);
+
+    // 3. Устанавливаем зависимости
+    console.log('📦 Installing dependencies...');
+    execSync(`${selectedPackageManager} install`, { stdio: 'inherit' });
+    console.log('✅ Dependencies installed');
+  } catch (error) {
+    console.error('❌ Error executing next steps:', error.message);
+  }
+}
+
+function isDirectoryEmpty(dirPath) {
+  try {
+    if (!fs.existsSync(dirPath)) {
+      return true;
+    }
+
+    const stats = fs.statSync(dirPath);
+    if (!stats.isDirectory()) {
+      console.error(`❌ Path is not a directory: ${dirPath}`);
+      return false;
+    }
+
+    const files = fs.readdirSync(dirPath);
+    return files.length === 0;
+  } catch (error) {
+    console.error(`❌ Error checking directory: ${error.message}`);
+    return false;
+  }
+}
+
+function question(prompt) {
+  return new Promise((resolve) => {
+    rl.question(prompt, resolve);
+  });
+}
+
+function updatePackageJson(targetDir, fields) {
+  const packageJsonPath = path.join(targetDir, 'package.json');
+
+  if (fs.existsSync(packageJsonPath)) {
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+
+    // Обновляем только указанные поля
+    packageJson.name = fields.name;
+
+    if (fields.version) packageJson.version = fields.version;
+    if (fields.productName) packageJson.productName = fields.productName;
+    if (fields.description) packageJson.description = fields.description;
+    if (fields.repository) packageJson.repository = fields.repository;
+    if (fields.author) packageJson.author = fields.author;
+
+    fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));
+  }
+}
+
+async function main() {
+  console.log('🚀 Creating TypeScript + Vite Project');
+  console.log('(will be installed in project name folder)\n');
+
+  // Парсим аргументы командной строки
+  const args = process.argv.slice(2);
+  const projectNameFromArgs = String(args?.[0] || '').trim();
+
+  if (projectNameFromArgs) {
+    defaults.projectName = projectNameFromArgs;
+  } else {
+    defaults.projectName = await question(`Project name (${defaults.projectName}): `) || defaults.projectName;
+
+    const version = await question(`Version (${defaults.version}): `) || defaults.version;
+    const versionParts = version.split('.');
+
+    for (let i = versionParts.length; i < 3; i++) {
+      versionParts.push(0);
+    }
+
+    defaults.version = versionParts.join('.');
+
+    defaults.productName = await question(`Product name (${defaults.productName}): `) || defaults.productName;
+    defaults.description = await question('Description: ') || defaults.description;
+    defaults.repository = await question('Repository url: ') || defaults.repository;
+
+    let author = await question('Author: ') || '';
+    author = author.trim();
+
+    if (author) {
+      let email = await question('Email: ') || '';
+      email = email.trim();
+
+      const authors = [];
+      if (author) {
+        authors.push(author);
+      }
+      if (email && email !== author) {
+        authors.push(`<${email}>`);
+      }
+
+      defaults.author = authors.join(' ');
+    }
+  }
+
+  const targetDir = path.resolve(defaults.projectName);
+
+  // Проверяем, существует ли директория
+  if (!isDirectoryEmpty(targetDir)) {
+    const overwrite = await question(`Directory "${targetDir}" already exists. Overwrite? (y/N): `);
+    if (overwrite.toLowerCase() !== 'y') {
+      console.log('❌ Operation cancelled');
+      rl.close();
+      return;
+    }
+    // Удаляем существующую директорию
+    fs.rmSync(targetDir, { recursive: true, force: true });
+  }
+
+  try {
+    // Создаем директорию
+    fs.mkdirSync(targetDir, { recursive: true });
+
+    // Копируем файлы из template
+    copyRecursive(path.join(__dirname, 'template'), targetDir);
+
+    // Копируем остальные файлы
+    copyFile('.gitignore', __dirname, targetDir);
+    copyFile('LICENSE', __dirname, targetDir);
+    copyFile('README.md', __dirname, targetDir);
+
+    // Обновляем package.json
+    updatePackageJson(targetDir, {
+      name: defaults.projectName.trim(),
+      version: defaults.version.trim(),
+      productName: defaults.productName.trim(),
+      description: defaults.description.trim(),
+      repository: defaults.repository.trim(),
+      author: defaults.author.trim()
+    });
+
+    console.log('\n✅ Project created successfully!');
+
+    // Переходим к Next steps
+    console.log('\nNext steps:');
+    console.log(`📁 cd ${defaults.projectName}`);
+    console.log('📦 npm install');
+    console.log('⭐ npm run dev');
+
+    if (projectNameFromArgs) {
+      await executeNextSteps(targetDir, true);
+    } else {
+      // Запрашиваем выполнение Next steps
+      const executeSteps = await question('\nInstall dependencies automatically? (y/N): ');
+
+      if (executeSteps.toLowerCase() === 'y') {
+        await executeNextSteps(targetDir);
+      }
+    }
+
+    console.log('\nHappy coding! 👋');
+  } catch (error) {
+    console.error('❌ Error creating project:', error);
+  } finally {
+    rl.close();
+  }
+}
+
+// Запускаем основную функцию
+main().catch(console.error);