skelr 3.0.0

package/CHANGELOG.md

@@ -0,0 +1,133 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [3.0.0] - 2026-02-08
+
+### Added
+
+- **CRUD API Generation**: Generate complete Create, Read, Update, Delete operations
+  - Prisma ORM integration with configurable model names
+  - Pagination, search, and sorting support
+  - Soft delete with timestamp or boolean approach
+  - Duplicate checking and proper error handling
+- **Configuration File Support**: Pre-configure defaults with `.skelrrc.json`
+  - Set default folder structure, language, and CRUD options
+  - Auto-detected from project root
+- **ASCII Banner**: Beautiful ASCII art logo in CLI startup
+- **Programmatic API**: Use skelr as a library in your own scripts
+  - Export all templates, generators, and utility functions
+
+### Changed
+
+- **Major Architecture Refactor**: Restructured from single file to modular library
+  - Organized into `src/` with logical subdirectories
+  - Separated CLI, config, generators, prompts, templates, UI, and utils
+  - Added proper npm exports map for subpath imports
+- Updated CLI entry point to `bin/skelr.js`
+- Improved interactive prompts with more detailed explanations
+- Enhanced success summary with next steps guidance
+
+### Technical
+
+- 24 modular files across 8 directories
+- Proper barrel exports for each module
+- Package exports for programmatic usage
+
+### Migration
+
+> ⚠️ **Repository Renamed**: This project has been renamed from `scaffold-service` to `skelr`.
+> 
+> - **Old (Deprecated)**: https://github.com/abubakar-shaikh-dev/scaffold-service
+> - **New**: https://github.com/abubakar-shaikh-dev/skelr
+> 
+> The npm package name remains `skelr`. Please update your bookmarks and git remotes.
+
+---
+
+## [2.1.0] - 2026-02-06
+
+### Added
+
+- **TypeScript Support**: Generate `.ts` files with proper type annotations
+  - New language selection prompt (Step 2)
+  - TypeScript templates for service, validation, controller, and routes
+  - Express `Request`/`Response` types in controller templates
+  - Zod type inference examples in validation templates
+- **Non-Interactive CLI Mode**: Skip prompts with command-line flags
+  - `--name` / `-n`: Set service name directly
+  - `--structure` / `-s`: Set folder structure (`separate` or `modular`)
+  - `--typescript` / `-ts`: Generate TypeScript files
+  - `--help` / `-h`: Show usage information
+- Quick Mode indicator when running with CLI flags
+
+### Changed
+
+- Updated step numbering to accommodate language selection (5 steps total)
+- Improved configuration preview to show selected language
+
+---
+
+## [2.0.0] - 2026-02-05
+
+### Added
+
+- Complete rewrite with modern ES6+ modules
+- Interactive CLI with inquirer for better user experience
+- Colorful terminal output with chalk
+- Two folder structure options: Separate and Modular
+- Automatic generation of service, controller, validation, and route files
+- Snake_case to camelCase naming conversion
+- Configuration preview before file creation
+- CLI tool installable via npm global or npx
+- Support for both distributed and modular folder organizations
+
+### Changed
+
+- Upgraded to ES modules (type: "module")
+- Improved user interface with colors and formatting
+- Enhanced error handling and user feedback
+- Better file organization and structure
+
+### Technical
+
+- Node.js >= 18.0.0 required
+- Dependencies: chalk@^5.3.0, fs-extra@^11.2.0, inquirer@^12.3.0
+- Published as CLI tool with bin entry point
+
+## [1.0.0] - 2025
+
+### Added
+
+- Initial release
+- Basic service scaffolding functionality
+- Core CLI tool structure
+
+---
+
+## Release Notes
+
+### Version 2.0.0
+
+This is a major release with significant improvements and modernization. The tool now provides:
+
+- Better developer experience with interactive prompts
+- Two folder structure options (Separate vs Modular)
+- Automatic file generation for services, controllers, validations, and routes
+- Modern JavaScript features and best practices
+- Consistent naming conventions with snake_case input
+
+### Future Plans
+
+- Add more template options
+- Support for TypeScript
+- Docker configuration generation
+- CI/CD pipeline templates
+- Testing setup inclusion
+
+---
+
+For more information, visit [GitHub Repository](https://github.com/abubakar-shaikh-dev/scaffold-service)

package/LICENSE

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

@@ -0,0 +1,295 @@
+<div align="center">
+
+![skelr banner](assets/banner.jpg)
+
+**Service Scaffolding CLI — Generate production-ready service files in seconds.**
+
+[![npm version](https://img.shields.io/npm/v/skelr.svg?style=flat-square&color=00afff)](https://www.npmjs.com/package/skelr)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
+[![Node.js Version](https://img.shields.io/node/v/skelr.svg?style=flat-square)](https://nodejs.org)
+[![Downloads](https://img.shields.io/npm/dt/skelr.svg?style=flat-square)](https://www.npmjs.com/package/skelr)
+
+[Features](#-features) • [Installation](#-installation) • [Quick Start](#-quick-start) • [Configuration](#-configuration) • [API](#-api)
+
+</div>
+
+---
+
+> ⚠️ **Repository Renamed**: This project has moved from `scaffold-service` to `skelr`.
+> 
+> - **Old (Deprecated)**: https://github.com/abubakar-shaikh-dev/scaffold-service
+> - **New**: https://github.com/abubakar-shaikh-dev/skelr
+> 
+> Please update your bookmarks and git remotes.
+
+---
+
+## ✨ Features
+
+| Feature | Description |
+|---------|-------------|
+| 🏗️ **Two Architecture Modes** | Choose between **Separate** (layer-based) or **Modular** (domain-driven) structures |
+| 📘 **TypeScript Support** | Generate `.ts` files with proper type annotations |
+| ⚡ **CRUD Generation** | Auto-generate complete Create, Read, Update, Delete operations |
+| 🔧 **Config File Support** | Pre-configure defaults with `.skelrrc.json` |
+| 🚀 **Non-Interactive Mode** | Skip prompts with CLI flags for automation |
+| 🎨 **Beautiful CLI** | Interactive prompts with color-coded output |
+| 📦 **Zod Validations** | Pre-configured validation schemas with type inference |
+| 🗑️ **Soft Delete** | Built-in soft delete support (timestamp or boolean) |
+
+---
+
+## 📦 Installation
+
+### Run with npx (Recommended)
+```bash
+npx skelr
+```
+
+### Global Installation
+```bash
+npm install -g skelr
+```
+
+---
+
+## 🚀 Quick Start
+
+### Interactive Mode
+
+Simply run the command and follow the prompts:
+
+```bash
+npx skelr
+```
+
+The CLI will guide you through:
+1. **Folder Structure** — Separate or Modular
+2. **Language** — JavaScript or TypeScript
+3. **CRUD APIs** — Generate pre-made CRUD operations (optional)
+4. **Service Name** — Enter a snake_case name
+5. **Preview & Confirm** — Review and create files
+
+### Non-Interactive Mode
+
+Skip all prompts with CLI flags:
+
+```bash
+# TypeScript + Modular structure
+skelr --name=payment --structure=modular --typescript
+
+# JavaScript + Separate structure
+skelr -n user_profile -s separate
+
+# Show help
+skelr --help
+```
+
+---
+
+## 🎛️ CLI Options
+
+| Flag | Short | Description |
+|------|-------|-------------|
+| `--name <name>` | `-n` | Service name in snake_case |
+| `--structure <type>` | `-s` | `separate` or `modular` |
+| `--typescript` | `-ts` | Generate TypeScript files |
+| `--help` | `-h` | Show help message |
+
+---
+
+## ⚙️ Configuration
+
+Create a `.skelrrc.json` file in your project root to pre-configure defaults:
+
+```json
+{
+  "structure": "modular",
+  "language": "ts",
+  "crud": {
+    "enabled": true,
+    "soft_delete": "timestamp"
+  }
+}
+```
+
+### Configuration Options
+
+| Option | Values | Description |
+|--------|--------|-------------|
+| `structure` | `"separate"` \| `"modular"` | Default folder structure |
+| `language` | `"js"` \| `"ts"` | Default programming language |
+| `crud.enabled` | `true` \| `false` | Enable CRUD generation by default |
+| `crud.soft_delete` | `"timestamp"` \| `"boolean"` | Soft delete approach |
+
+When a config file is detected, skelr will use these values as defaults (you can still override via CLI flags).
+
+---
+
+## 📂 Folder Structures
+
+### Option 1: Separate (Layer-Based)
+
+*Best for: Traditional MVC, large teams with strict separation of concerns*
+
+```
+src/
+├── controllers/
+│   └── payment.controller.ts
+├── services/
+│   └── payment.service.ts
+├── validations/
+│   └── payment.validation.ts
+└── routes/
+    └── v1/
+        └── payment.routes.ts
+```
+
+### Option 2: Modular (Domain-Driven)
+
+*Best for: Microservices, feature-based organization, high cohesion*
+
+```
+src/
+└── modules/
+    └── payment/
+        ├── payment.controller.ts
+        ├── payment.service.ts
+        ├── payment.validation.ts
+        └── payment.routes.ts
+```
+
+---
+
+## 🔥 CRUD Generation
+
+When you enable CRUD APIs, skelr generates complete implementations:
+
+### Generated Endpoints
+| Method | Route | Description |
+|--------|-------|-------------|
+| `POST` | `/` | Create new record |
+| `GET` | `/` | Get all records (paginated) |
+| `GET` | `/:id` | Get record by ID |
+| `PUT` | `/:id` | Update record by ID |
+| `DELETE` | `/:id` | Soft delete record by ID |
+
+### Features Included
+- ✅ Prisma ORM integration
+- ✅ Zod request validation
+- ✅ Pagination with search & sorting
+- ✅ Duplicate checking
+- ✅ Soft delete (timestamp or boolean)
+- ✅ Proper error handling with `http-errors`
+
+---
+
+## 🛠️ Post-Scaffolding
+
+After generating files, register your new route:
+
+```javascript
+// src/routes/index.js
+import paymentRoutes from './routes/v1/payment.routes.js';
+// or for modular:
+import paymentRoutes from './modules/payment/payment.routes.js';
+
+router.use('/payments', paymentRoutes);
+```
+
+---
+
+## 📚 API (Programmatic Usage)
+
+skelr can also be used programmatically in your own scripts:
+
+```javascript
+import { generateFiles, snakeToCamel, snakeToPascal } from 'skelr';
+
+// Generate files programmatically
+await generateFiles('payment', 'payment', 'modular', 'ts', {
+  enabled: true,
+  modelName: 'payments',
+  softDeleteApproach: 'timestamp'
+});
+
+// Use utility functions
+const camelCase = snakeToCamel('user_profile'); // 'userProfile'
+const pascalCase = snakeToPascal('user_profile'); // 'UserProfile'
+```
+
+### Exports
+
+```javascript
+// CLI
+import { main, parseCliArgs, validateCliArgs, printHelp } from 'skelr';
+
+// Config
+import { loadConfig, CONFIG_FILE } from 'skelr';
+
+// Generators
+import { generateFiles } from 'skelr';
+
+// Utils
+import { snakeToCamel, snakeToPascal, c, printSuccess, printInfo, errorExit } from 'skelr';
+
+// Templates (for customization)
+import { getServiceTemplate, getCrudServiceTemplate, /* ... */ } from 'skelr';
+```
+
+---
+
+## 💻 Development
+
+```bash
+# Clone the repository
+git clone https://github.com/abubakar-shaikh-dev/skelr.git
+
+# Install dependencies
+npm install
+
+# Run locally
+npm start
+
+# Or run directly
+node bin/skelr.js
+```
+
+### Project Structure
+
+```
+skelr/
+├── bin/skelr.js           # CLI entry point
+├── src/
+│   ├── index.js           # Library exports
+│   ├── cli/               # Argument parsing, help, main
+│   ├── config/            # .skelrrc.json loader
+│   ├── generators/        # File generation logic
+│   ├── prompts/           # Interactive prompts
+│   ├── templates/         # JS & TS templates
+│   ├── ui/                # Banner, preview, summary
+│   └── utils/             # Helpers & utilities
+└── package.json
+```
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+---
+
+## 👤 Author
+
+**ABUBAKAR SHAIKH**
+
+- GitHub: [@abubakar-shaikh-dev](https://github.com/abubakar-shaikh-dev)
+- Repository: [skelr](https://github.com/abubakar-shaikh-dev/skelr)
+

package/bin/skelr.js

@@ -0,0 +1,8 @@
+#!/usr/bin/env node
+// skelr - Service scaffolding CLI
+// Author: Abubakar Shaikh (github.com/abubakar-shaikh-dev)
+
+import { main } from "../src/cli/index.js";
+
+// Run the main function
+main();

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "skelr",
+  "version": "3.0.0",
+  "description": "Modern CLI tool to scaffold Express service files with CRUD generation",
+  "main": "src/index.js",
+  "type": "module",
+  "bin": {
+    "skelr": "./bin/skelr.js"
+  },
+  "exports": {
+    ".": "./src/index.js",
+    "./cli": "./src/cli/index.js",
+    "./templates": "./src/templates/index.js",
+    "./generators": "./src/generators/index.js",
+    "./utils": "./src/utils/index.js"
+  },
+  "files": [
+    "bin",
+    "src",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "start": "node bin/skelr.js",
+    "scaffold": "node bin/skelr.js",
+    "prepublishOnly": "node -e \"console.log('Publishing skelr v' + require('./package.json').version); if (require('fs').existsSync('.git/index')) { console.log('Git repo detected - ready to publish'); } else { console.warn('Warning: Not in a git repository'); }\""
+  },
+  "keywords": [
+    "scaffold",
+    "service",
+    "boilerplate",
+    "generator",
+    "cli",
+    "express",
+    "nodejs"
+  ],
+  "author": "ABUBAKAR SHAIKH <https://github.com/abubakar-shaikh-dev>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/abubakar-shaikh-dev/skelr.git"
+  },
+  "bugs": {
+    "url": "https://github.com/abubakar-shaikh-dev/skelr/issues"
+  },
+  "homepage": "https://github.com/abubakar-shaikh-dev/skelr#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {
+    "@clack/prompts": "^0.7.0",
+    "chalk": "^5.3.0"
+  }
+}

package/src/cli/args.js

@@ -0,0 +1,67 @@
+/**
+ * Parse CLI arguments from process.argv
+ * @param {string[]} argv - Command line arguments (process.argv.slice(2))
+ * @returns {Object} Parsed arguments object
+ */
+export function parseCliArgs(argv) {
+  const args = {
+    name: null,
+    structure: null,
+    typescript: false,
+    help: false,
+  };
+
+  for (let i = 0; i < argv.length; i++) {
+    const arg = argv[i];
+
+    // Help flag
+    if (arg === "-h" || arg === "--help") {
+      args.help = true;
+    }
+    // TypeScript flag
+    else if (arg === "-ts" || arg === "--typescript") {
+      args.typescript = true;
+    }
+    // Name argument
+    else if (arg === "-n" || arg === "--name") {
+      args.name = argv[++i];
+    } else if (arg.startsWith("--name=")) {
+      args.name = arg.split("=")[1];
+    }
+    // Structure argument
+    else if (arg === "-s" || arg === "--structure") {
+      args.structure = argv[++i];
+    } else if (arg.startsWith("--structure=")) {
+      args.structure = arg.split("=")[1];
+    }
+  }
+
+  return args;
+}
+
+/**
+ * Validate CLI arguments
+ * @param {Object} args - Parsed CLI arguments
+ * @returns {string[]} Array of validation error messages
+ */
+export function validateCliArgs(args) {
+  const errors = [];
+
+  if (args.name) {
+    const snakeCaseRegex = /^[a-z]+(_[a-z]+)*$/;
+    if (!snakeCaseRegex.test(args.name)) {
+      errors.push(
+        "Service name must be in snake_case or a single lowercase word",
+      );
+    }
+  }
+
+  if (args.structure) {
+    const validStructures = ["separate", "modular", "current"];
+    if (!validStructures.includes(args.structure.toLowerCase())) {
+      errors.push("Structure must be 'separate' or 'modular'");
+    }
+  }
+
+  return errors;
+}

package/src/cli/help.js

@@ -0,0 +1,64 @@
+import chalk from "chalk";
+
+/**
+ * Print CLI help message
+ */
+export function printHelp() {
+  console.log("");
+  console.log(
+    chalk.bold.white("  skelr") + chalk.dim(" - Service scaffolding CLI"),
+  );
+  console.log("");
+  console.log(chalk.bold.white("  USAGE"));
+  console.log(
+    chalk.dim("  ─────────────────────────────────────────────────────────"),
+  );
+  console.log("    $ skelr [options]");
+  console.log("");
+  console.log(chalk.bold.white("  OPTIONS"));
+  console.log(
+    chalk.dim("  ─────────────────────────────────────────────────────────"),
+  );
+  console.log(
+    "    " +
+      chalk.cyan("-n, --name <name>") +
+      "        " +
+      chalk.dim("Service name (snake_case)"),
+  );
+  console.log(
+    "    " +
+      chalk.cyan("-s, --structure <type>") +
+      "   " +
+      chalk.dim("Folder structure: separate | modular"),
+  );
+  console.log(
+    "    " +
+      chalk.cyan("-ts, --typescript") +
+      "        " +
+      chalk.dim("Generate TypeScript files (.ts)"),
+  );
+  console.log(
+    "    " +
+      chalk.cyan("-h, --help") +
+      "               " +
+      chalk.dim("Show this help message"),
+  );
+  console.log("");
+  console.log(chalk.bold.white("  EXAMPLES"));
+  console.log(
+    chalk.dim("  ─────────────────────────────────────────────────────────"),
+  );
+  console.log(
+    "    " +
+      chalk.dim("$") +
+      " skelr " +
+      chalk.cyan("--name=payment --structure=modular"),
+  );
+  console.log(
+    "    " +
+      chalk.dim("$") +
+      " skelr " +
+      chalk.cyan("-n user_profile -s separate -ts"),
+  );
+  console.log("");
+}