ebely 0.0.2 → 0.0.4

package/Readme.md

@@ -0,0 +1,34 @@
+### Быстрый старт из шаблона
+
+Склонировать готовый тест-проект (как `create-react-app`):
+
+```sh
+npx ebely create my-tests   # в новую/пустую папку
+# или
+npx ebely create            # в текущую папку
+```
+
+Затем:
+
+```sh
+cd my-tests
+pnpm install
+# отредактируй ebely/ebely.ts (url, путь к swagger) под свой бэкенд
+pnpm run client:generate
+pnpm test
+```
+
+### Алгоритм действий для пользователя библиотекой
+
+
+#### 1. Установить библиотеку
+`pnpm add -D ebely`
+
+#### 2. Один раз разложить скиллы в проект
+`npx ebely skills`
+
+#### 3. Открыть проект в Claude Code и вызвать настройку
+`/ebely-setup `            # настроит конфиг, сгенерирует клиент, стор, хуки
+
+#### 4. Дальше при написании любых тестов
+`/ebely-write-tests `      # опишет сценарий — тесты напишутся сами

package/bin/ebely.mjs

@@ -1,12 +1,13 @@
 #!/usr/bin/env node
-import { cp, mkdir, readdir, stat } from 'node:fs/promises'
+import { cp, mkdir, readdir, readFile, writeFile } from 'node:fs/promises'
 import { existsSync } from 'node:fs'
-import { dirname, join, resolve } from 'node:path'
+import { basename, dirname, join, resolve, sep } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
 const __dirname = dirname(fileURLToPath(import.meta.url))
 const pkgRoot = resolve(__dirname, '..')
 const skillsSrc = join(pkgRoot, 'skills')
+const templateSrc = join(pkgRoot, 'clone', 'tests')
 
 async function listSkills() {
   const entries = await readdir(skillsSrc, { withFileTypes: true })
@@ -38,10 +39,101 @@ async function installSkills({ toUser }) {
   )
 }
 
+const STANDALONE_TSCONFIG = `{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "lib": ["es2022", "dom", "dom.iterable"],
+    "types": ["node"],
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "verbatimModuleSyntax": true,
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "allowJs": true,
+    "noEmit": true
+  },
+  "include": ["ebely", "tests"]
+}
+`
+
+async function ownVersion() {
+  const pkg = JSON.parse(await readFile(join(pkgRoot, 'package.json'), 'utf8'))
+  return pkg.version
+}
+
+/** Имя npm-пакета из имени папки: lowercase, без недопустимых символов. */
+function toPackageName(name) {
+  const cleaned = name
+    .toLowerCase()
+    .replace(/[^a-z0-9._-]+/g, '-')
+    .replace(/^[-_.]+|[-_.]+$/g, '')
+  return cleaned || 'ebely-tests'
+}
+
+async function createProject({ dir }) {
+  const target = resolve(process.cwd(), dir ?? '.')
+
+  if (!existsSync(templateSrc)) {
+    console.error(`ebely: шаблон не найден по пути ${templateSrc}`)
+    process.exit(1)
+  }
+
+  // Существующая непустая папка — отказ, чтобы не затереть чужие файлы.
+  if (existsSync(target)) {
+    const entries = await readdir(target)
+    if (entries.length > 0) {
+      console.error(
+        `ebely: папка «${target}» не пуста.\n` +
+          `Укажи несуществующую или пустую папку, либо очисти эту.`,
+      )
+      process.exit(1)
+    }
+  } else {
+    await mkdir(target, { recursive: true })
+  }
+
+  // Копируем шаблон целиком, кроме node_modules.
+  await cp(templateSrc, target, {
+    recursive: true,
+    filter: (src) => !src.split(sep).includes('node_modules'),
+  })
+
+  // package.json: имя по папке + реальная версия ebely вместо workspace:*.
+  const version = await ownVersion()
+  const pkgPath = join(target, 'package.json')
+  const pkg = JSON.parse(await readFile(pkgPath, 'utf8'))
+  pkg.name = toPackageName(basename(target))
+  pkg.dependencies = { ...pkg.dependencies, ebely: `^${version}` }
+  await writeFile(pkgPath, JSON.stringify(pkg, null, 2) + '\n')
+
+  // Самодостаточный tsconfig (в шаблоне он расширяет конфиг монорепо).
+  await writeFile(join(target, 'tsconfig.json'), STANDALONE_TSCONFIG)
+
+  // Базовый .gitignore.
+  await writeFile(join(target, '.gitignore'), 'node_modules\n')
+
+  const shown = dir && dir !== '.' ? dir : '.'
+  console.log(
+    `\nГотово. Шаблон ebely создан в «${target}».\n\n` +
+      `Дальше:\n` +
+      (shown === '.' ? '' : `  cd ${shown}\n`) +
+      `  pnpm install                 # установить зависимости\n` +
+      `  # отредактируй ebely/ebely.ts (url, путь к swagger) под свой бэкенд\n` +
+      `  pnpm run client:generate     # сгенерировать типизированный клиент\n` +
+      `  pnpm test                    # запустить пример тестов\n`,
+  )
+}
+
 function help() {
   console.log(`ebely — CLI
 
 Использование:
+  npx ebely create [dir]    Склонировать шаблон тест-проекта в папку
+                            (без аргумента или «.» — в текущую папку)
   npx ebely skills          Установить скиллы в .claude/skills проекта (рекомендуется)
   npx ebely skills --user   Установить скиллы глобально в ~/.claude/skills
   npx ebely help            Показать эту справку
@@ -54,6 +146,9 @@ function help() {
 const [cmd, ...rest] = process.argv.slice(2)
 
 switch (cmd) {
+  case 'create':
+    await createProject({ dir: rest.find((a) => !a.startsWith('-')) })
+    break
   case 'skills':
     await installSkills({ toUser: rest.includes('--user') })
     break

package/clone/tests/ebely/ebely.ts

@@ -0,0 +1,21 @@
+import type { EbelyConfig } from "ebely";
+import { generateClient } from 'ebely'
+import { UserStore } from "./userStore";
+import { WorldStore } from "./worldStore";
+import { hooks } from "./hooks";
+
+export const ebely = {
+    userStore: UserStore, // внутренние переменные одного пользователя
+    worldStore: WorldStore, // внутренние переменные/сценарии всего приложения
+
+    url: 'http://localhost:3000', // url бекенда, который нужно тестировать
+    swagger: { pathToFile: 'swagger.json', }, // путь к swagger-схеме
+    generateClientTo: 'ebely/generated.ts', // путь к генерируемому клиенту
+    hooks, // before/after-хуки (объявлены в ./hooks.ts, типизированы)
+    mode: 'test', // test - не-2xx статусы не бросаются.
+} satisfies EbelyConfig
+
+// запустить в другом файле для генерации клиента
+export const generateEbelyClient = async () => {
+    await generateClient(ebely)
+}

package/clone/tests/ebely/generate-client.ts

@@ -0,0 +1,3 @@
+import { generateEbelyClient } from "./ebely";
+
+generateEbelyClient();