@bogomolcompany/bogo 0.1.1 → 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 bogomolcompany
+
+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

@@ -1,43 +1,76 @@
 # @bogomolcompany/bogo
 
-CLI-генератор модулей Express API: controller, service, dto, routes, validator.
+[![npm version](https://img.shields.io/npm/v/@bogomolcompany/bogo.svg)](https://www.npmjs.com/package/@bogomolcompany/bogo)
+[![npm downloads](https://img.shields.io/npm/dm/@bogomolcompany/bogo.svg)](https://www.npmjs.com/package/@bogomolcompany/bogo)
+[![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bogomolcomp/bogo/blob/main/LICENSE)
 
-Отдельный npm-пакет, не привязан к конкретному проекту. Настраивается через `.bogorc.json` в целевом репозитории.
+[Русская версия / Russian version](README.ru.md)
 
-## Установка
+**`bogo create app`** — Express + TypeScript project in 10 seconds.  
+**`bogo g users`** — controller, service, dto, routes, validator in one command.  
+**`bogo r users`** — remove a module and clean up the index file.
+
+CLI generator for Express API. Works in any repository — configured via `.bogorc.json`.
+
+![bogo demo](docs/demo/bogo-demo.gif)
+
+## Quick start
+
+```bash
+npx @bogomolcompany/bogo create app
+cp .env.example .env
+npm install
+npm run dev
+
+npx bogo g users -m getList -m createUser
+```
+
+## Why bogo
+
+| | NestJS CLI | express-generator | **bogo** |
+|---|:---:|:---:|:---:|
+| Express without a framework | — | ✓ | ✓ |
+| TypeScript out of the box | ✓ | — | ✓ |
+| DTO + Zod validator | ✓ | — | ✓ |
+| Starter project (server, logger, middleware) | partial | — | ✓ |
+| Minimal dependencies | — | ✓ | ✓ |
+| Generate into an existing project | ✓ | — | ✓ |
+
+bogo is for teams using plain Express + TypeScript who are tired of copying the same file structure every time.
+
+## Installation
 
 ```bash
 npm install -g @bogomolcompany/bogo
-# или локально в проекте
+# or locally
 npm install --save-dev @bogomolcompany/bogo
 npx bogo --help
 ```
 
-Из исходников:
+From source:
 
 ```bash
-git clone <repo-url> bogo-cli
-cd bogo-cli
+git clone https://github.com/bogomolcomp/bogo.git
+cd bogo
 npm install
 npm run build
 npm link
 ```
 
-## Создание нового проекта
+## Create a new project
 
 ```bash
-mkdir my-api && cd my-api
-bogo create app
+bogo create app my-api --with-docker --with-eslint
 ```
 
-Или в подпапку:
+Or into a subdirectory:
 
 ```bash
 bogo create app my-api
 cd my-api
 ```
 
-Создаёт Express + TypeScript проект:
+Creates:
 
 ```
 package.json
@@ -56,7 +89,7 @@ src/
   api/
 ```
 
-Включено: dotenv, body-parser, logger, formatResponse, IP whitelist (через `ALLOWED_IPS`), health-check `/health`, глобальный error handler.
+Includes: dotenv, body-parser, logger, formatResponse, IP whitelist (`ALLOWED_IPS`), `/health`, global error handler.
 
 ```bash
 cp .env.example .env
@@ -64,31 +97,35 @@ npm install
 npm run dev
 ```
 
-## Инициализация в существующем проекте
+## Init in an existing project
 
 ```bash
 cd /path/to/your-express-app
 bogo init
 ```
 
-Создаёт `.bogorc.json`:
+Creates `.bogorc.json`:
 
 ```json
 {
   "apiDir": "src/api",
   "indexFile": "src/index.ts",
-  "routePrefix": "/api"
+  "routePrefix": "/api",
+  "templatesDir": "./bogo-templates"
 }
 ```
 
-## Генерация модуля
+`templatesDir` is optional. Place `controller.template`, `service.template`, etc. to override built-in templates.
+
+## Generate a module
 
 ```bash
-bogo g module analytics -m getStats -m getReport
-bogo g module orders -m createOrder:/create -m getOrder:/:id
+bogo g analytics -m getStats -m getReport
+bogo g orders -m createOrder:POST:/create -m getOrder:GET:/:id
+bogo g posts -m getList:GET:/list -w auth
 ```
 
-Создаёт:
+Creates:
 
 ```
 src/api/analytics/
@@ -99,32 +136,138 @@ src/api/analytics/
   analytics.routes.ts
 ```
 
-И дописывает import + `app.use` в `src/index.ts` (если файл найден).
+Automatically appends import and `app.use` to `src/index.ts` when the file exists.
+
+## Generate a single file
+
+```bash
+bogo g controller users -m getList
+bogo g service users -m getList
+bogo g dto users -m getList -m createUser
+bogo g validator users -m getList
+bogo g routes users -m getList:/list
+```
+
+Parts: `controller`, `service`, `dto`, `validator`, `routes`.
+
+The module folder is created if it does not exist. Generating `routes` updates the index file the same way as a full module.
+
+```bash
+bogo r controller users
+bogo r routes users
+```
+
+## Add a method to an existing module
+
+```bash
+bogo g method users -m getList
+bogo g method users -m createUser -m updateUser:/:id
+```
+
+Adds the method to all existing module files: controller, service, dto, validator, routes.
+
+Specific parts only:
 
-## Опции
+```bash
+bogo g method users -m getList -p controller
+bogo g method users -m getList -p controller -p service -p dto
+```
 
-| Флаг | Описание |
-|------|----------|
-| `-m, --method` | Метод контроллера. Повторяемый. Формат: `getList` или `getList:/custom-path` |
-| `--skip-index` | Не править index-файл |
+`-m` is required. `-p` is optional — without it, all found files are updated.
 
-## Требования к целевому проекту
+## Remove a method
+
+```bash
+bogo r method users -m getList
+bogo r method users -m createUser -p controller -p service
+```
+
+## List modules
+
+```bash
+bogo list
+```
+
+## Doctor
+
+```bash
+bogo doctor
+```
+
+Checks `.bogorc.json`, index file, api directory, and required middleware.
+
+## Interactive mode
+
+```bash
+bogo g --interactive
+```
+
+## Remove a module
+
+```bash
+bogo r analytics
+bogo r orders --skip-index
+```
+
+Removes the module folder and cleans up import + `app.use` in the index file.
+
+## Method spec format
+
+| Example | Result |
+|---------|--------|
+| `getList` | POST `/get-list` |
+| `getList:GET` | GET `/get-list` |
+| `getOrder:GET:/:id` | GET `/:id` |
+| `createOrder:POST:/create` | POST `/create` |
+
+## Options
+
+| Flag | Description |
+|------|-------------|
+| `-m, --method` | Method spec (repeatable). See table above |
+| `-p, --part` | Target a specific part |
+| `-w, --middleware` | Route middleware name (repeatable) |
+| `-i, --interactive` | Interactive generate |
+| `--dry-run` | Preview changes without writing |
+| `--force` | Overwrite existing files |
+| `--skip-index` | Do not patch the index file |
+| `--with-docker` | Add Docker files to `create app` |
+| `--with-eslint` | Add ESLint to `create app` |
+
+## Target project requirements
 
 - Express + TypeScript
-- Zod для валидации
-- Middleware `validate` по пути `src/middlewares/validate`
-- `res.success` / `res.error` через middleware ответа
+- Zod for validation
+- `validate` middleware at `src/middlewares/validate`
+- `res.success` / `res.error` via response middleware
 
-## Разработка пакета
+`bogo create app` scaffolds all of the above.
+
+## Development
 
 ```bash
 npm run build
-npm run dev -- init
-npm run dev -- g module test -m getList
+npm test
+npm run dev -- create app ./tmp-app --with-eslint
+npm run dev -- g test -m getList:GET
+npm run dev -- g method test -m createUser
+npm run dev -- r method test -m createUser
+npm run dev -- list
+npm run dev -- doctor
 ```
 
-## Публикация
+## Links
+
+- npm: https://www.npmjs.com/package/@bogomolcompany/bogo
+- GitHub: https://github.com/bogomolcomp/bogo
+- Issues / feedback: https://github.com/bogomolcomp/bogo/issues
+
+## Publish
 
 ```bash
-npm publish
+npm publish --otp=YOUR_CODE
 ```
+
+## License
+
+MIT

package/README.ru.md

@@ -0,0 +1,266 @@
+# @bogomolcompany/bogo
+
+[![npm version](https://img.shields.io/npm/v/@bogomolcompany/bogo.svg)](https://www.npmjs.com/package/@bogomolcompany/bogo)
+[![npm downloads](https://img.shields.io/npm/dm/@bogomolcompany/bogo.svg)](https://www.npmjs.com/package/@bogomolcompany/bogo)
+[![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/bogomolcomp/bogo/blob/main/LICENSE)
+
+[English version](README.md)
+
+**`bogo create app`** — Express + TypeScript проект за 10 секунд.  
+**`bogo g users`** — controller, service, dto, routes, validator одной командой.  
+**`bogo r users`** — удаляет модуль и убирает роут из index.
+
+CLI-генератор для Express API. Не привязан к конкретному репозиторию — настраивается через `.bogorc.json`.
+
+![bogo demo](docs/demo/bogo-demo.gif)
+
+## Быстрый старт
+
+```bash
+npx @bogomolcompany/bogo create app
+copy .env.example .env
+npm install
+npm run dev
+
+npx bogo g users -m getList -m createUser
+```
+
+## Почему bogo
+
+| | NestJS CLI | express-generator | **bogo** |
+|---|:---:|:---:|:---:|
+| Express без своего фреймворка | — | ✓ | ✓ |
+| TypeScript из коробки | ✓ | — | ✓ |
+| DTO + Zod validator | ✓ | — | ✓ |
+| Стартовый проект (server, logger, middleware) | частично | — | ✓ |
+| Минимальные зависимости | — | ✓ | ✓ |
+| Генерация модулей в существующий проект | ✓ | — | ✓ |
+
+bogo — для тех, кто пишет на чистом Express + TS и устал каждый раз копировать одну и ту же структуру файлов.
+
+## Установка
+
+```bash
+npm install -g @bogomolcompany/bogo
+# или локально
+npm install --save-dev @bogomolcompany/bogo
+npx bogo --help
+```
+
+Из исходников:
+
+```bash
+git clone https://github.com/bogomolcomp/bogo.git
+cd bogo
+npm install
+npm run build
+npm link
+```
+
+## Создание нового проекта
+
+```bash
+bogo create app my-api --with-docker --with-eslint
+```
+
+Создаёт:
+
+```
+package.json
+tsconfig.json
+.env.example
+.bogorc.json
+src/
+  index.ts
+  types/express.d.ts
+  middlewares/
+    logger.ts
+    formatResponse.ts
+    validate.ts
+  utils/
+    getAllowedIps.ts
+  api/
+```
+
+Включено: dotenv, body-parser, logger, formatResponse, IP whitelist (`ALLOWED_IPS`), `/health`, глобальный error handler.
+
+```bash
+copy .env.example .env
+npm install
+npm run dev
+```
+
+## Инициализация в существующем проекте
+
+```bash
+cd /path/to/your-express-app
+bogo init
+```
+
+Создаёт `.bogorc.json`:
+
+```json
+{
+  "apiDir": "src/api",
+  "indexFile": "src/index.ts",
+  "routePrefix": "/api",
+  "templatesDir": "./bogo-templates"
+}
+```
+
+`templatesDir` — опционально. Файлы `controller.template`, `service.template` и т.д. переопределяют встроенные шаблоны.
+
+## Генерация модуля
+
+```bash
+bogo g analytics -m getStats -m getReport
+bogo g orders -m createOrder:POST:/create -m getOrder:GET:/:id
+bogo g posts -m getList:GET:/list -w auth
+```
+
+Создаёт:
+
+```
+src/api/analytics/
+  analytics.controller.ts
+  analytics.service.ts
+  analytics.dto.ts
+  analytics.validator.ts
+  analytics.routes.ts
+```
+
+Автоматически дописывает import и `app.use` в `src/index.ts`, если файл найден.
+
+## Генерация отдельного файла
+
+```bash
+bogo g controller users -m getList
+bogo g service users -m getList
+bogo g dto users -m getList -m createUser
+bogo g validator users -m getList
+bogo g routes users -m getList:/list
+```
+
+Части: `controller`, `service`, `dto`, `validator`, `routes`.
+
+Папка модуля создаётся автоматически, если её ещё нет. При генерации `routes` index обновляется так же, как при полном модуле.
+
+```bash
+bogo r controller users
+bogo r routes users
+```
+
+## Добавление метода в существующий модуль
+
+```bash
+bogo g method users -m getList
+bogo g method users -m createUser -m updateUser:/:id
+```
+
+Добавляет метод во все существующие файлы модуля: controller, service, dto, validator, routes.
+
+Только в конкретные части:
+
+```bash
+bogo g method users -m getList -p controller
+bogo g method users -m getList -p controller -p service -p dto
+```
+
+`-m` обязателен. `-p` — опционально, без него обновляются все найденные файлы.
+
+## Удаление метода
+
+```bash
+bogo r method users -m getList
+bogo r method users -m createUser -p controller -p service
+```
+
+## Список модулей
+
+```bash
+bogo list
+```
+
+## Doctor
+
+```bash
+bogo doctor
+```
+
+Проверяет `.bogorc.json`, index, api-папку и middleware.
+
+## Интерактивный режим
+
+```bash
+bogo g --interactive
+```
+
+## Удаление модуля
+
+```bash
+bogo r analytics
+bogo r orders --skip-index
+```
+
+Удаляет папку модуля и убирает import + `app.use` из index.
+
+## Формат `-m`
+
+| Пример | Результат |
+|--------|-----------|
+| `getList` | POST `/get-list` |
+| `getList:GET` | GET `/get-list` |
+| `getOrder:GET:/:id` | GET `/:id` |
+| `createOrder:POST:/create` | POST `/create` |
+
+## Опции
+
+| Флаг | Описание |
+|------|----------|
+| `-m, --method` | Спецификация метода (повторяемый) |
+| `-p, --part` | Только указанная часть |
+| `-w, --middleware` | Middleware для роута (повторяемый) |
+| `-i, --interactive` | Интерактивная генерация |
+| `--dry-run` | Показать изменения без записи |
+| `--force` | Перезаписать существующие файлы |
+| `--skip-index` | Не править index-файл |
+| `--with-docker` | Docker-файлы в `create app` |
+| `--with-eslint` | ESLint в `create app` |
+
+## Требования к целевому проекту
+
+- Express + TypeScript
+- Zod для валидации
+- Middleware `validate` по пути `src/middlewares/validate`
+- `res.success` / `res.error` через middleware ответа
+
+`bogo create app` создаёт всё это автоматически.
+
+## Разработка
+
+```bash
+npm run build
+npm test
+npm run dev -- create app ./tmp-app --with-eslint
+npm run dev -- g test -m getList:GET
+npm run dev -- g method test -m createUser
+npm run dev -- r method test -m createUser
+npm run dev -- list
+npm run dev -- doctor
+```
+
+## Ссылки
+
+- npm: https://www.npmjs.com/package/@bogomolcompany/bogo
+- GitHub: https://github.com/bogomolcomp/bogo
+- Issues / feedback: https://github.com/bogomolcomp/bogo/issues
+
+## Публикация
+
+```bash
+npm publish --otp=YOUR_CODE
+```
+
+## Лицензия
+
+MIT