Phorge

A universal CLI scaffolding tool for quickly generating components, styles, tests, and boilerplate for Vue, React, Angular, and Svelte.

Current Status

Phorge is currently in early development (v0.1.0). The basic CLI structure is in place with a foundation for generating various types of components and templates.

What Phorge Currently Does

CLI Foundation

• ✅ Command-line interface: Built using Commander.js for robust CLI functionality
• ✅ Executable binary: Available as phorge command when installed
• ✅ Basic command structure: Supports the new command for generating components

Available Commands

phorge new <type> <names...>

Creates new components, pages, or templates with the specified type and names.

Usage:

phorge new component MyButton
phorge new page HomePage AboutPage
phorge new template HeaderTemplate FooterTemplate

Current behavior:

• Accepts a component type (component, page, template, etc.)
• Accepts multiple names in a single command
• Outputs the type and names being generated
• Provides feedback for each item being created

Project Structure

phorge/
├── bin/
│   └── phorge.js          # Main CLI executable
├── lib/
│   └── run-cli.js         # CLI logic and command definitions
├── helpers/               # (Reserved for future helper utilities)
├── test/                  # (Reserved for future tests)
├── index.js               # Entry point
├── package.json           # Project configuration
└── README.md              # This file

Requirements

• Node.js >= 20
• npm or yarn

Installation

Note: Installation instructions will be added once the package is published to npm.

Development Status

Implemented Features

• Basic CLI framework with Commander.js
• Command parsing and argument handling
• Multi-name support for batch generation
• Executable binary setup

Planned Features

• Actual file generation for components
• Framework-specific templates (Vue, React, Angular, Svelte)
• Customizable templates and configurations
• Style generation (CSS, SCSS, styled-components, etc.)
• Test file generation
• Project structure detection
• Configuration file support
• Interactive prompts for component options

Contributing

This project is in early development. The foundation is set for extending functionality to support actual file generation across multiple frontend frameworks.

License

License information to be added