@morda-dev/create-sdk 1.0.1 → 1.1.0

package/template/docusaurus-build/docs/project-architecture.md

@@ -1,125 +0,0 @@
----
-sidebar_position: 5
-title: Архитектура проекта
----
-
-# 🏛 Архитектура проекта
-
-Архитектура основана на принципах Clean Architecture, SOLID, и чётком разделении ответственности между слоями.  
-Это обеспечивает масштабируемость, лёгкость поддержки и предсказуемость поведения системы.
-
----
-
-## 🎯 Основная идея
-
-Все зависимости в проекте направлены внутрь, к бизнес-логике.  
-Это позволяет:
-
-- заменять инфраструктурные детали без переписывания логики  
-- тестировать систему в изоляции  
-- поддерживать стабильную внутреннюю структуру  
-- гарантировать, что логика не зависит от внешних библиотек
-
----
-
-## 🧩 Архитектурные слои
-┌────────────────────────────────────────┐ │         Presentation Layer             │  ← UI, CLI, API Endpoints └────────────────────────────────────────┘ ↓ зависимость внутрь ┌────────────────────────────────────────┐ │         Application Layer              │  ← use-cases, services └────────────────────────────────────────┘ ↓ зависимость внутрь ┌────────────────────────────────────────┐ │           Domain Layer                 │  ← бизнес-логика, сущности └────────────────────────────────────────┘ ↓ зависимость внутрь ┌────────────────────────────────────────┐ │        Infrastructure Layer            │  ← имплементации API, БД └────────────────────────────────────────┘
-
----
-
-## 📦 Domain Layer (ядро)
-
-Содержит:
-- сущности (Entities)
-- бизнес-правила
-- value objects
-- доменные сервисы
-
-Особенности:
-- не зависит ни от одного слоя
-- чистый TypeScript
-- легко тестируется
-- стабилен долгие годы
-
----
-## ⚙️ Application Layer (use-cases)
-
-Содержит:
-- сценарии использования (Use Cases)
-- application-services
-- входные и выходные DTO
-
-Особенности:
-- содержит бизнес-процессы (но НЕ бизнес-логику)
-- зависит только от Domain Layer
-- не знает ничего о БД, HTTP и UI
-
----
-
-## 🌐 Infrastructure Layer
-
-Содержит:
-- API-клиенты
-- репозитории
-- базы данных
-- интеграции
-- логирование
-- адаптеры
-
-Особенности:
-- знает детали работы внешних сервисов
-- меняется чаще всех
-- подменяется моками в тестах
-
----
-
-## 🖥 Presentation Layer
-
-Содержит:
-- CLI
-- REST API endpoints
-- UI (если есть)
-- слой взаимодействия с пользователем
-
-Особенности:
-- преобразует запросы → вызывает use-cases → возвращает результат
-- не содержит логики
-
----
-## 🧪 Как архитектура упрощает тесты?
-
-- Domain тестируется отдельно
-- Application тестируется через изолированные сценарии
-- Infrastructure мокаем
-- Presentation тестируется минимально
-
-Результат:
-- быстрые тесты
-- надёжная логика
-- минимальная связность слоёв
-
----
-
-## 🚀 Преимущества выбранной архитектуры
-
-- Масштабируемость без боли  
-- Чёткое разделение ответственности  
-- Простота для новых разработчиков  
-- Минимальная связность  
-- Лёгкая смена технологий (БД, API, UI)  
-- Строгая типизация на всех уровнях  
-
----
-
-## 💬 Почему это важно?
-
-Потому что этот template — основа для production-уровня проекта, который должен развиваться годами.
-
-Такая архитектура обеспечивает:
-- предсказуемость  
-- стабильность  
-- гибкость  
-- контроль качества  
-
-Это фундамент всей экосистемы, которую мы сейчас строим.
-

package/template/docusaurus-build/docs/project-template/architecture.md

@@ -1,82 +0,0 @@
----
-title: Архитектура проекта
-sidebar_label: Architecture
----
-
-# Архитектура Project Template
-
-Документ описывает основные принципы архитектуры, используемые слои, связи между компонентами, а также общий подход к организации проекта.
-
----
-
-## Основные принципы
-
-- **KISS** — проект должен быть простым для понимания и расширения.
-- **SOLID** — разбиваем функциональность на независимые модули.
-- **DRY** — избегаем дублирования логики.
-- **YAGNI** — реализуем только реально используемую функциональность.
-- **Чёткое разделение ответственности**.
-
----
-
-## Архитектурные слои
-
-Структура проекта организована по слоям:
-
-### 1. **Presentation Layer**
-- HTTP endpoints  
-- контроллеры  
-- адаптеры входящих запросов  
-- валидация входящих данных  
-
-### 2. **Application Layer**
-- Use Cases  
-- сервисы оркестрации бизнес-логики  
-- обработчики команд  
-- работа с DTO  
-
-### 3. **Domain Layer**
-- бизнес-модели  
-- правила предметной области  
-- интерфейсы репозиториев  
-- чистая бизнес-логика  
-
-### 4. **Infrastructure Layer**
-- реальные реализации репозиториев  
-- работа с внешними API  
-- интеграции  
-- клиенты БД  
-- логирование  
-- конфигурация окружения  
-
----
-
-## Диаграмма архитектурных слоёв
-
-```mermaid
-flowchart TD
-
-    A[Presentation Layer] --> B[Application Layer]
-    B[Application Layer] --> C[Domain Layer]
-    C[Domain Layer] --> D[Infrastructure Layer]
-
-    A -.-> C
-    B -.-> D
-## Поток данных в системе
-
-```mermaid
-sequenceDiagram
-    participant User as Client/User
-    participant API as API Layer
-    participant App as Application
-    participant Domain as Domain Logic
-    participant Infra as Infrastructure
-
-    User->>API: HTTP Request
-    API->>App: Вызов Use Case / Handler
-    App->>Domain: Проверка правил / моделирование
-    Domain->>Infra: Запрос к внешним ресурсам / данным
-    Infra-->>Domain: Результат / данные
-    Domain-->>App: Валидированный результат
-    App-->>API: Формирование ответа
-    API-->>User: HTTP Response

package/template/docusaurus-build/docs/project-template/getting-started.md

@@ -1,24 +0,0 @@
----
-title: Getting Started
-sidebar_label: Getting Started
----
-
-# Getting Started
-
-Документ описывает, как запустить и настроить проект с нуля.
-
----
-
-## Требования перед началом
-
-Для корректной работы шаблона необходимо установить:
-- **Node.js 18+**
-- **npm или pnpm**
-- Git
-- VS Code (рекомендуется)
-
-Проверьте версии:
-
-```bash
-node -v
-npm -v

package/template/docusaurus-build/docs/project-template/overview.md

@@ -1,78 +0,0 @@
----
-sidebar_position: 11
-title: Project Overview
----
-
-# 🧠 Project Overview
-
-Шаблон Project Template — это продакшен-готовый каркас для быстрого старта TypeScript-проектов.
-
-Он экономит время при запуске нового репозитория и задаёт строгую структуру для кода, тестов,
-релизов и документации.
-
----
-
-## ⚙️ Основная идея
-
-> Сделать старт нового проекта таким же быстрым и предсказуемым, как git clone.
-
-Шаблон помогает:
-1. Ускорить старт разработки  
-2. Обеспечить качество кода  
-3. Масштабировать проект без хаоса  
-
----
-
-## 🧩 Компоненты шаблона
-
-| Компонент | За что отвечает |
-|----------|------------------|
-| TypeScript | строгая типизация |
-| ESLint + Prettier | единый стиль |
-| Vitest | тесты |
-| Husky + lint-staged | защита коммитов |
-| Standard Version | авто-релизы |
-| Docusaurus | документация |
-| GitHub Actions | CI/CD |
-
----
-
-## 🏗 Архитектура проекта
-
-- src/ — исходный код  
-- tests/ — юнит-тесты  
-- .github/workflows/ — CI/CD сценарии  
-- docs/ — документация  
-- package.json — все скрипты проекта  
-
----
-
-## 🚀 Цели проекта
-
-1. Создать единый стандарт качества  
-2. Автоматизировать релизы и деплой  
-3. Сделать документацию частью пайплайна  
-4. Поддержать масштабируемую архитектуру  
-
----
-
-## 🧭 Roadmap
-
-| Этап | Статус | Описание |
-|------|---------|----------|
-| ✅ Инициализация | done | структура и скрипты |
-| ✅ Документация | done | Docusaurus + GitHub Pages |
-| 🔄 API Reference | in progress | оформляем публичные интерфейсы |
-| 🔜 CLI Tools | next | добавить CLI-модули |
-| 🔜 Monorepo | next | поддержка workspaces |
-| 🔜 Docker Dev Setup | next | контейнеризация окружения |
-
----
-
-## 💡 Философия
-
-- Простота > магия — всё понятно и прозрачно  
-- Автоматизация > ручные действия — CI/CD делает всю рутину  
-- Стандарты > хаос — одинаковый код во всех проектах  
-
----

package/template/docusaurus-build/docs/project-template/structure.md

@@ -1,145 +0,0 @@
----
-title: Структура проекта
-sidebar_label: Structure
----
-
-# Структура проекта
-
-Этот документ подробно описывает структуру каталогов проекта, назначение каждой директории и лучшие практики при работе с кодовой базой.
-
----
-
-## Общее устройство проекта
-
-Главные элементы находятся в корне:
-
-project-root/
-│
-├── src/
-├── docs/
-├── project-template/
-├── scripts/
-├── static/
-├── build/
-└── .github/
-
-Каждая директория выполняет чётко определённую роль.
-
----
-
-## 📁 src/ — основной код приложения
-
-src/
-├── api/
-├── application/
-├── domain/
-├── infrastructure/
-├── utils/
-├── config/
-└── index.ts
-
-### **api/**
-Слой взаимодействия с внешним миром:
-
-- контроллеры  
-- роутеры  
-- валидация входящих данных  
-- обработка HTTP-запросов  
-
-### **application/**
-Сценарии бизнес-логики:
-
-- Use Cases  
-- обработчики  
-- DTO  
-- оркестрация запросов  
-
-### **domain/**
-Чистая бизнес-логика:
-
-- сущности  
-- правила предметной области  
-- контракты репозиториев  
-- доменные сервисы  
-
-**Важно:** доменный слой НЕ должен зависеть от инфраструктуры.
-
-### **infrastructure/**
-Реализации инфраструктурных зависимостей:
-
-- работа с внешними API  
-- клиенты БД  
-- репозитории  
-- логирование  
-- интеграции  
-
-### **utils/**
-Чистые вспомогательные функции:
-
-- парсеры  
-- форматтеры  
-- хелперы  
-
-### **config/**
-Конфигурация окружения:
-
-- env-переменные  
-- общие настройки  
-
----
-
-## 📁 docs/ — документация (Docusaurus)
-
-Содержит:
-
-- **api/** — ручная API-документация  
-- **project-template/** — техническая документация  
-- Mermaid-диаграммы  
-- getting-started  
-- structure  
-- architecture  
-
-Это всё, что мы сейчас создаём по шагам.
-
----
-
-## 📁 project-template/
-
-Файлы, относящиеся к шаблону проекта:
-
-- преднастроенные конфиги  
-- базовые правила  
-- шаблонные элементы проекта  
-
----
-
-## 📁 scripts/
-
-Вспомогательные скрипты:
-
-- генераторы  
-- утилиты для CI/CD  
-- автоматизация процессов  
-- форматирование  
-
-Сюда помещают всё, что связано с автоматизацией, а не с кодом проекта.
-
----
-
-## 📁 static/
-
-Статические ресурсы:
-
-- изображения  
-- favicon  
-- логотипы  
-- файлы, доступные напрямую  
-
----
-
-## 📁 build/
-
-Готовая сборка проекта, формируется автоматически командой:
-
-```bash
-npm run build

package/template/docusaurus-build/docs/scripts.md

@@ -1,42 +0,0 @@
----
-sidebar_position: 7
-title: Скрипты проекта
----
-
-# 🧰 Скрипты проекта
-
-Проект использует набор npm-скриптов для запуска, тестирования, форматирования и релизов.
-
-## ▶️ Запуск проекта
-
-\\\bash
-npm run dev
-\\\
-
-## 🧪 Тесты
-
-\\\bash
-npm test
-npm run test:watch
-npm run test:ui
-npm run test:coverage
-\\\
-
-## 🧹 Качество кода
-
-\\\bash
-npm run lint
-npm run format
-\\\
-
-## 📦 Сборка
-
-\\\bash
-npm run build
-\\\
-
-## 🚀 Релизы
-
-\\\bash
-npm run release
-\\\

package/template/docusaurus-build/docs/testing.md

@@ -1,30 +0,0 @@
----
-sidebar_position: 8
-title: Тестирование
----
-
-# 🧪 Тестирование
-
-В проекте используется Vitest — современный и быстрый тестовый раннер для TypeScript/JavaScript.
-
-Он полностью совместим с Jest API, работает быстрее и идеально подходит для TypeScript-проектов.
-
----
-
-## 📦 Установка зависимостей
-
-Vitest уже настроен и установлен автоматически:
-
-- vitest
-- @types/jest (совместимость API)
-- ts-node
-- конфигурация vitest.config.ts
-
----
-
-## ▶️ Как запустить тесты
-
-### 🟦 Полный прогон тестов
-
-ash
-npm test

package/template/docusaurus-build/docusaurus-build/sidebars.ts

@@ -1,30 +0,0 @@
-import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
-
-const sidebars: SidebarsConfig = {
-  docs: [
-    {
-      type: "doc",
-      id: "intro",
-      label: "Введение",
-    },
-    {
-      type: "category",
-      label: "Документация",
-      items: [
-        "getting-started",
-        "project-architecture",
-        "folder-structure",
-        "ci-cd",
-        "testing",
-        "scripts",
-      ],
-    },
-    {
-      type: "link",
-      label: "API Reference",
-      href: "/api/",
-    },
-  ],
-};
-
-export default sidebars;

package/template/docusaurus-build/docusaurus-build/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../tsconfig.json",
-  "compilerOptions": {
-    "noEmit": true
-  },
-  "include": ["../src/**/*.ts"],
-  "exclude": ["./src", "node_modules"]
-}

package/template/docusaurus-build/docusaurus-build/typedoc.tsconfig.json

@@ -1,28 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-
-  "entryPoints": ["../src/index.ts"],
-  "entryPointStrategy": "resolve",
-
-  "out": "static/api",
-
-  "name": "Project Template API",
-
-  "excludePrivate": true,
-  "excludeProtected": true,
-  "excludeInternal": true,
-
-  "excludeExternals": true,
-  "excludeNotDocumented": true,
-
-  "includeVersion": true,
-
-  "categorizeByGroup": true,
-  "sort": ["source-order"],
-
-  "readme": "none",
-
-  "plugin": [],
-
-  "tsconfig": "../tsconfig.json"
-}