spring-feature-cli 0.2.1 → 0.2.2

package/README.md

@@ -1,68 +1,93 @@
 # spring-feature-cli
 
-`spring-feature-cli` is a personal project to learn how to build command-line tools with Node.js. It is designed to generate basic Spring Boot artifacts using a feature-based structure and clean architecture principles.
+`spring-feature-cli` is a Node.js CLI tool that generates Spring Boot feature-based boilerplate using templates.
+
+It helps automate the creation of common backend layers such as entities, services, repositories, and controllers following a clean and consistent structure.
+
+---
 
 ## Purpose
 
-- Learn Node.js and the CLI ecosystem
-- Practice using `commander`, `inquirer`, and `handlebars`
-- Automate repetitive code generation for Spring Boot projects
-- Generate entities, services, repositories, and controllers with a simple workflow
+This project was built to:
+
+- Practice building real-world CLI tools with Node.js
+- Learn `commander`, `inquirer`, and `handlebars`
+- Automate repetitive Spring Boot boilerplate generation
+- Apply feature-based architecture patterns
 
-## Features
+---
 
-- Executable CLI via the `spfc` command
-- Template generation using `handlebars`
-- Input validation and project detection
-- Supports generating:
-  - `Entity`
-  - `Repository`
-  - `Service`
-  - `Controller`
+## ⚙️ Installation
 
-## Installation
+### Global installation (recommended)
 
 ```bash
-npm install
+npm install -g spring-feature-cli
 ```
 
-To install globally (optional):
-
+### Local usage (development)
 ```bash
-npm install -g .
+npm install
+npm run dev
 ```
 
 ## Usage
 
-Run the tool from the project directory:
+### Generate a Spring Boot feature:
 
 ```bash
-spfc generate
+spfc generate User
 ```
 
-Or in development mode:
+or
 
 ```bash
-npm run dev
+spfc g User 
 ```
+This will generate a full structure for the feature (Entity, Repository, Service, Controller).
+
+### 🧱 Generated Structure
+
+The CLI generates:
+
+- Entity  
+- Repository  
+- Service  
+- Controller  
+
+All based on Handlebars templates and a consistent naming convention.
+
+## 📁 Project Structure
+
+- `bin/index.js` → CLI entry point  
+- `src/index.js` → Main CLI logic  
+- `src/commands/` → Command definitions  
+- `src/actions/` → Generation logic  
+- `src/validations/` → Input validation layer  
+- `src/utils/` → Helpers (logging, scanning, template compilation, etc.)  
+- `src/templates/` → Handlebars templates for generated code  
+
+---
+
+## 🧰 Key Dependencies
+
+- `commander` → CLI command handling  
+- `inquirer` → Interactive prompts  
+- `handlebars` → Template engine  
+- `chalk` → Terminal styling  
+
+---
+
+## ⚠️ Requirements
 
-## Project Structure
+- Node.js >= 16  
 
-- `bin/index.js`: executable CLI entry point
-- `src/index.js`: main CLI logic
-- `src/commands/generate.js`: generate command
-- `src/actions/generateActions.js`: file creation actions
-- `src/validations/generateValidations.js`: input validations
-- `src/utils/`: utilities for Java package resolution, project scanning, and template compilation
-- `src/templates/`: Handlebars templates for generated artifacts
+---
 
-## Key Dependencies
+## 💡 Notes
 
-- `commander` for defining CLI commands
-- `inquirer` for interactive prompts
-- `handlebars` for template generation
-- `chalk` for console styling
+This tool assumes a Spring Boot project structure and is intended to be used inside a backend project where Java packages are detected automatically.
 
-## License
+📄 License
 
-This project is licensed under `MIT`.
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spring-feature-cli",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "CLI para generar features de Spring Boot",
   "type": "module",
   "bin": {