blas/openapi-clean-arch-gen
1
0
Fork 0
Code Issues 3 Pull Requests 1 Actions Packages Projects 1 Releases 6 Wiki Activity

Merge pull request 'chore: update installation instructions and add mock files to README' (#65) from feat/update-docu into main

Browse Source 
Reviewed-on: #65
Reviewed-by: blas <me@blassanto.me>
This commit was merged in pull request #65.
This commit is contained in:
blas
2026-03-27 08:33:50 +00:00
parent 720748b73d 8881e9494c
commit 59ff941fda
1 changed files with 56 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

85
README.md
View File

@@ -15,29 +15,29 @@ Download the binary for your platform from the releases page and run it directly
```bash ```bash
# macOS (Apple Silicon) # macOS (Apple Silicon)
curl -L <release-url>/generate-clean-arch-macos-arm64 -o generate-clean-arch curl -L https://git.blassanto.me/blas/openapi-clean-arch-gen/releases/latest/download/generate-clean-arch-macos-arm64 -o generate-clean-arch
chmod +x generate-clean-arch && ./generate-clean-arch -i swagger.yaml chmod +x generate-clean-arch && ./generate-clean-arch -i swagger.yaml
# macOS (Intel) # macOS (Intel)
curl -L <release-url>/generate-clean-arch-macos-x64 -o generate-clean-arch curl -L https://git.blassanto.me/blas/openapi-clean-arch-gen/releases/latest/download/generate-clean-arch-macos-x64 -o generate-clean-arch
chmod +x generate-clean-arch && ./generate-clean-arch -i swagger.yaml chmod +x generate-clean-arch && ./generate-clean-arch -i swagger.yaml
# Linux x64 # Linux x64
curl -L <release-url>/generate-clean-arch-linux-x64 -o generate-clean-arch curl -L https://git.blassanto.me/blas/openapi-clean-arch-gen/releases/latest/download/generate-clean-arch-linux-x64 -o generate-clean-arch
chmod +x generate-clean-arch && ./generate-clean-arch -i swagger.yaml chmod +x generate-clean-arch && ./generate-clean-arch -i swagger.yaml
# Windows (PowerShell) # Windows (PowerShell)
curl -L <release-url>/generate-clean-arch-windows-x64.exe -o generate-clean-arch.exe curl -L https://git.blassanto.me/blas/openapi-clean-arch-gen/releases/latest/download/generate-clean-arch-windows-x64.exe -o generate-clean-arch.exe
.\generate-clean-arch.exe -i swagger.yaml .\generate-clean-arch.exe -i swagger.yaml
``` ```
### Option 1: Install as a global CLI from the registry ### Option 1: Install as a global CLI from npm
```bash ```bash
bun add -g @blas/openapi-clean-arch-generator --registry https://git.blassanto.me/api/packages/blas/npm/ bun add -g @0kmpo/openapi-clean-arch-generator
``` ```
Or configure the registry in your `.npmrc` / `bunfig.toml` and then run: Then run:
```bash ```bash
generate-clean-arch -i swagger.yaml generate-clean-arch -i swagger.yaml
@@ -109,48 +109,54 @@ src/app/
├── data/ # Data layer ├── data/ # Data layer
│ ├── dtos/ # Data Transfer Objects │ ├── dtos/ # Data Transfer Objects
│ │ ├── node/ │ │ ├── node/
│ │ │ └── node.dto.ts │ │ │ ├── node.dto.ts
│ │ │ └── node.dto.mock.ts
│ │ ├── order-type/ │ │ ├── order-type/
│ │ │ └── order-type.dto.ts │ │ │ ├── order-type.dto.ts
│ │ │ └── order-type.dto.mock.ts
│ │ └── supply-mode/ │ │ └── supply-mode/
│ │ └── supply-mode.dto.ts │ │ ├── supply-mode.dto.ts
│ │ └── supply-mode.dto.mock.ts
│ ├── repositories/ # Repository implementations │ ├── repositories/ # Repository implementations
│ │ ├── node.repository.impl.ts │ │ ├── node.repository.impl.ts
│ │ ├── node.repository.impl.mock.ts
│ │ ├── node.repository.impl.spec.ts
│ │ ├── order-type.repository.impl.ts │ │ ├── order-type.repository.impl.ts
│ │ └── supply-mode.repository.impl.ts │ │ ├── order-type.repository.impl.mock.ts
│ │ ├── order-type.repository.impl.spec.ts
│ │ └── ...
│ └── mappers/ # DTO → Entity transformers │ └── mappers/ # DTO → Entity transformers
│ ├── node.mapper.ts │ ├── node.mapper.ts
│ ├── node.mapper.spec.ts
│ ├── order-type.mapper.ts │ ├── order-type.mapper.ts
│ └── supply-mode.mapper.ts │ ├── order-type.mapper.spec.ts
│ └── ...
├── domain/ # Domain layer ├── domain/ # Domain layer
│ ├── repositories/ # Repository contracts │ ├── repositories/ # Repository contracts
│ │ ├── node.repository.contract.ts │ │ ├── node.repository.contract.ts
│ │ ├── order-type.repository.contract.ts │ │ └── ...
│ │ └── supply-mode.repository.contract.ts
│ └── use-cases/ # Use cases │ └── use-cases/ # Use cases
│ ├── node/ │ ├── node/
│ │ ├── node.use-cases.contract.ts │ │ ├── node.use-cases.contract.ts
│ │ └── node.use-cases.impl.ts │ │ ├── node.use-cases.impl.ts
│ ├── order-type/ │ │ ├── node.use-cases.mock.ts
│ │ ├── order-type.use-cases.contract.ts │ │ └── node.use-cases.impl.spec.ts
│ │ └── order-type.use-cases.impl.ts │ └── ...
│ └── supply-mode/
│ ├── supply-mode.use-cases.contract.ts
│ └── supply-mode.use-cases.impl.ts
├── di/ # Dependency injection ├── di/ # Dependency injection
│ ├── repositories/ # Repository providers │ ├── repositories/ # Repository providers
│ │ ├── node.repository.provider.ts │ │ ├── node.repository.provider.ts
│ │ ├── order-type.repository.provider.ts │ │ ├── node.repository.provider.mock.ts
│ │ └── supply-mode.repository.provider.ts │ │ └── ...
│ └── use-cases/ # Use case providers │ └── use-cases/ # Use case providers
│ ├── node.use-cases.provider.ts │ ├── node.use-cases.provider.ts
│ ├── order-type.use-cases.provider.ts │ ├── node.use-cases.provider.mock.ts
│ └── supply-mode.use-cases.provider.ts │ └── ...
└── entities/ # Domain entities └── entities/ # Domain entities
└── models/ └── models/
├── node.model.ts ├── node.model.ts
├── order-type.model.ts ├── node.model.mock.ts
└── supply-mode.model.ts ├── node.model.spec.ts
└── ...
``` ```
## 🔧 Template Customization ## 🔧 Template Customization
@@ -160,14 +166,24 @@ Templates live in `templates/` and use [Mustache](https://mustache.github.io/) s
| Template | Generates | | Template | Generates |
|---|---| |---|---|
| `model.mustache` | DTOs | | `model.mustache` | DTOs |
| `model.mock.mustache` | DTO mocks |
| `dto.mock.mustache` | DTO mocks (alternative) |
| `model-entity.mustache` | Domain entity models | | `model-entity.mustache` | Domain entity models |
| `model-entity.spec.mustache` | Entity model specs |
| `mapper.mustache` | DTO → Entity mappers | | `mapper.mustache` | DTO → Entity mappers |
| `mapper.spec.mustache` | Mapper specs |
| `api.repository.contract.mustache` | Repository contracts | | `api.repository.contract.mustache` | Repository contracts |
| `api.repository.impl.mustache` | Repository implementations | | `api.repository.impl.mustache` | Repository implementations |
| `api.repository.impl.mock.mustache` | Repository mocks |
| `api.repository.impl.spec.mustache` | Repository specs |
| `api.use-cases.contract.mustache` | Use case contracts | | `api.use-cases.contract.mustache` | Use case contracts |
| `api.use-cases.impl.mustache` | Use case implementations | | `api.use-cases.impl.mustache` | Use case implementations |
| `api.use-cases.mock.mustache` | Use case mocks |
| `api.use-cases.impl.spec.mustache` | Use case specs |
| `repository.provider.mustache` | Repository DI providers | | `repository.provider.mustache` | Repository DI providers |
| `repository.provider.mock.mustache` | Repository provider mocks |
| `use-cases.provider.mustache` | Use case DI providers | | `use-cases.provider.mustache` | Use case DI providers |
| `use-cases.provider.mock.mustache` | Use case provider mocks |
### Available Mustache variables ### Available Mustache variables
@@ -194,12 +210,23 @@ After each run a `generation-report.json` file is created:
"timestamp": "2025-01-15T10:30:00.000Z", "timestamp": "2025-01-15T10:30:00.000Z",
"tags": 3, "tags": 3,
"endpoints": 8, "endpoints": 8,
"tagDetails": [
{ "name": "User", "description": "User operations", "endpoints": 3 },
{ "name": "Product", "description": "Product operations", "endpoints": 2 }
],
"outputDirectory": "./src/app", "outputDirectory": "./src/app",
"linting": {
"prettier": { "ran": true, "filesFormatted": 42 },
"eslint": { "ran": true, "filesFixed": 42 }
},
"structure": { "structure": {
"dtos": 15, "dtos": 15,
"repositories": 9, "repositories": 9,
"mappers": 3, "mappers": 5,
"useCases": 6 "useCases": 6,
"providers": 12,
"mocks": 18,
"specs": 14
} }
} }
``` ```