Merge branch 'master' of github.com:profullstack/generate-pdf-api

Author: Preshy

README-adding-routes.md

@@ -254,9 +254,9 @@ The router will handle loading the HTML, running the initializer function, and c
 
 7. **Test Thoroughly**: Test your new route with different scenarios (logged in, logged out, with/without subscription) to ensure it behaves correctly.
 
-## Using the Route Generator Script
+## Using the Generator Script
 
-For faster development, you can use the provided route generator script to automatically create all the necessary files and code for a new route.
+The generator script provides tools for creating various components for both client-side and server-side development.
 
 ### Prerequisites
 
@@ -266,42 +266,145 @@ Make sure the script is executable:
 chmod +x bin/generator.js
 ```
 
-### Usage
+### Command Structure
+
+The generator now uses a category-based command structure:
 
 ```bash
-./bin/generator.js --route="/my-feature" --name="My Feature" [--auth] [--subscription]
+./bin/generator.js <category> <command> [options]
 ```
 
-### Options
+Categories:
+- `client`: Client-side generators
+- `server`: Server-side generators
+
+### Client-Side Commands
 
+#### Generate a Client Route
+
+```bash
+./bin/generator.js client route --route="/my-feature" --name="My Feature" [--auth] [--subscription]
+```
+
+Options:
 - `--route`: The route path (required, e.g., "/my-feature")
 - `--name`: The feature name (required, e.g., "My Feature")
 - `--auth`: Add this flag if the route requires authentication
 - `--subscription`: Add this flag if the route requires an active subscription
-- `--help`: Show help information
-
-### Example
 
+Example:
 ```bash
-./bin/generator.js --route="/contact-us" --name="Contact Us"
+./bin/generator.js client route --route="/contact-us" --name="Contact Us"
 ```
 
 This will:
-
 1. Create a new HTML view file at `public/views/contact-us.html`
 2. Add an initializer function `initContactUsPage` to `public/js/page-initializers.js`
 3. Add the route to `public/js/router.js`
 
-For a protected route that requires authentication:
+### Server-Side Commands
+
+#### Generate a Server Route
+
+```bash
+./bin/generator.js server route --path="/api/v1/users" --controller="UserController" --method="get"
+```
+
+Options:
+- `--path`: The API path (required, e.g., "/api/v1/users")
+- `--controller`: The controller name (required, e.g., "UserController")
+- `--method`: The HTTP method (required, e.g., "get", "post", "put", "delete", "patch")
+
+Example:
+```bash
+./bin/generator.js server route --path="/api/v1/users" --controller="User" --method="get"
+```
+
+This will add a new route to the appropriate route file in the `src/routes` directory.
+
+#### Generate a Database Migration
+
+```bash
+./bin/generator.js server migration --name="add_user_fields"
+```
+
+Options:
+- `--name`: The migration name (required, e.g., "add_user_fields")
+
+Example:
+```bash
+./bin/generator.js server migration --name="add_user_profile_fields"
+```
+
+This will create a timestamped SQL migration file in the `supabase/migrations` directory. The migration file includes clearly separated sections for "up" migrations (changes to apply) and "down" migrations (how to revert the changes).
+
+#### Generate a Controller
 
 ```bash
-./bin/generator.js --route="/dashboard" --name="Dashboard" --auth
+./bin/generator.js server controller --name="UserController"
 ```
 
-For a premium route that requires a subscription:
+Options:
+- `--name`: The controller name (required, e.g., "UserController" or "User")
 
+Example:
 ```bash
-./bin/generator.js --route="/premium-feature" --name="Premium Feature" --auth --subscription
+./bin/generator.js server controller --name="User"
 ```
 
-After running the generator, you can customize the generated files to fit your specific requirements.
+This will create a new controller file with standard CRUD methods in the `src/controllers` directory.
+
+### Backward Compatibility
+
+For backward compatibility, the old command format is still supported but will show a deprecation warning:
+
+```bash
+./bin/generator.js route --route="/my-feature" --name="My Feature"  # Deprecated
+```
+
+### Getting Help
+
+For general help:
+```bash
+./bin/generator.js --help
+```
+
+For command-specific help:
+```bash
+./bin/generator.js client route --help
+./bin/generator.js server route --help
+./bin/generator.js server migration --help
+./bin/generator.js server controller --help
+```
+
+After running the generator, you can customize the generated files to fit your specific requirements.
+
+## Template-Based Generation
+
+The generator script uses a template-based approach for creating files. Templates are stored in the `templates` directory and are organized by category and type:
+
+```
+templates/
+├── client/
+│   └── route/
+│       ├── view.html.template
+│       ├── view.js.template
+│       └── initializer.js.template
+└── server/
+    ├── controller.js.template
+    ├── route.js.template
+    └── migration.sql.template
+```
+
+### Benefits of Template-Based Generation
+
+1. **Separation of Concerns**: Templates are separate from the generator code, making maintenance easier
+2. **Consistency**: All generated files follow the same structure and style
+3. **Customization**: Templates can be modified without changing the generator code
+4. **Flexibility**: New templates can be added for additional file types
+
+### Customizing Templates
+
+If you need to modify the structure or content of generated files, you can edit the templates directly. Templates use placeholders like `{{kebabCase}}`, `{{featureName}}`, and `{{controllerName}}` that are replaced with actual values during generation.
+
+For example, to change the structure of generated HTML views, edit `templates/client/route/view.html.template`.