palesi v0.0.2

Pales - Prisma API Layer Scaffolding

🚀 Introduction

Pales is a CLI tool designed to automate the generation of modular API layers for Node.js applications using Prisma and Zod. It streamlines the creation of models, validation schemas, and API endpoints based on a Prisma schema, reducing development overhead and ensuring consistency.

📌 Features

• 🛠 Automatic Module Generation: Generates route handlers, validation schemas, and controllers from your Prisma schema.
• 🔍 Zod Integration: Automatically converts Prisma types to Zod validation schemas.
• 📂 Modular Structure: Organizes your API into modular components within src/app/modules/.
• ⚡ Efficient Development: Save time by scaffolding essential files in seconds.

📋 Prerequisites

Ensure you have the following installed:

• Node.js (v16+ recommended)
• Prisma (installed in your project)
• Zod (for validation handling)

📦 Installation

You can install pales globally using npm:

npm install -g pales

Alternatively, you can install it locally within your project:

npm install --save-dev pales

🎯 Usage

Once installed, navigate to your project root (where schema.prisma exists) and run:

pales

This will:

1. Parse your schema.prisma file.
2. Extract all models.
3. Generate corresponding API modules with routes and validation.

📁 Project Structure

After running pales, your project structure will look like this:

📂 src/
 ├── 📂 app/
 │   ├── 📂 modules/
 │   │   ├── user/
 │   │   │   ├── user.controller.ts
 │   │   │   ├── user.routes.ts
 │   │   │   ├── user.validation.ts
 │   │   │   └── user.service.ts
 │   │   ├── post/
 │   │   │   ├── post.controller.ts
 │   │   │   ├── post.routes.ts
 │   │   │   ├── post.validation.ts
 │   │   │   └── post.service.ts
 │   ├── 📂 routes/
 │   │   ├── index.ts
 │   ├── 📂 lib/
 │   │   ├── utils.ts
 │   │   ├── generate-constants.sh
 │   │   ├── process-model.sh
 │   │   ├── zod-generator.sh
 │   │   ├── update-routes.sh

🔥 Example

If your schema.prisma contains:

model User {
  id        String  @id @default(uuid())
  name      String
  email     String  @unique
  createdAt DateTime @default(now())
}

Running pales will generate:

• Routes (**user.routes.ts**): Defines API endpoints for the User model.
• Controller (**user.controller.ts**): Handles incoming requests.
• Validation (**user.validation.ts**): Ensures request data matches the model schema.
• Service (**user.service.ts**): Business logic layer for the User model.

🛠 Commands

🐞 Troubleshooting

• If you see schema.prisma not found, ensure you are running pales in the correct directory.
• If schema.pi is missing, try manually copying schema.prisma to schema.pi.
• If TYPE_MAP errors occur, ensure you're using bash with associative array support.

📜 License

MIT License

🤝 Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

🚀 Happy coding!