botim-cli 0.0.7

package/README.md

@@ -0,0 +1,375 @@
+# Botim CLI Generator
+
+A powerful, extensible Command Line Interface (CLI) tool that generates boilerplate code and project scaffolding for React and Vue applications. Built with TypeScript for type safety and maintainability.
+
+## Features
+
+- **React & Vue Support**: Generate boilerplate for both React and Vue applications
+- **TypeScript First**: Built with TypeScript and supports TypeScript in generated projects
+- **Interactive Prompts**: User-friendly interactive prompts for project configuration
+- **Customizable**: Choose which features to include (routing, state management, testing, linting)
+- **Multiple Package Managers**: Support for npm, yarn, and pnpm
+- **Extensible Architecture**: Plugin system for adding new frameworks and features
+- **Modern Tooling**: Uses Vite as the default build tool for fast development
+
+## Installation
+
+### Quick Install (Recommended)
+
+Use the automated installation script:
+
+```bash
+# Run the installation script
+./QUICK-INSTALL.sh
+```
+
+This will:
+1. Install dependencies
+2. Build the project
+3. Link it globally (may ask for sudo password)
+4. Verify the installation
+
+### Manual Installation
+
+#### Option 1: Development (npm link)
+
+```bash
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Link globally (may require sudo)
+sudo npm link
+
+# Verify
+botim-cli --version
+```
+
+#### Option 2: Local Testing (npm run)
+
+```bash
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Run the CLI locally
+npm run cli -- --help
+npm run cli create-react-app my-app
+```
+
+#### Option 3: Global Installation from Directory
+
+```bash
+# Build first
+npm run build
+
+# Install globally
+npm install -g .
+
+# Or from tarball
+npm pack
+npm install -g botim-cli-generator-1.0.0.tgz
+```
+
+### After Publishing to npm
+
+```bash
+npm install -g @botim/cli-generator
+```
+
+### Troubleshooting Installation
+
+If you encounter permission errors or other issues, see the detailed [INSTALLATION.md](./INSTALLATION.md) guide.
+
+## Usage
+
+### Quick Start - Interactive Mode
+
+The fastest way to get started is to run the CLI without any arguments:
+
+```bash
+npm run cli
+# or: botim-cli
+```
+
+This will show an interactive menu where you can:
+- ⚛️  Create a React application
+- 🖖 Create a Vue application
+- 📚 View examples
+- ❓ Show help
+- 🚪 Exit
+
+Simply select your choice and the CLI will guide you through the rest!
+
+### Getting Help
+
+```bash
+# Show interactive menu with framework selection
+npm run cli
+# or: botim-cli
+
+# Show detailed help
+npm run cli -- --help
+# or: botim-cli --help
+
+# Show usage examples
+npm run cli -- examples
+# or: botim-cli examples
+
+# Show quick start guide
+npm run cli -- quick-start
+# or: botim-cli quick-start (alias: qs)
+
+# Show version
+npm run cli -- -v
+# or: botim-cli -v
+```
+
+### Create a React Application
+
+```bash
+# Using npm run
+npm run cli create-react-app my-react-app
+
+# Or if globally installed
+botim-cli create-react-app my-react-app
+
+# Using alias
+botim-cli react my-react-app
+```
+
+### Create a Vue Application
+
+```bash
+# Using npm run
+npm run cli create-vue-app my-vue-app
+
+# Or if globally installed
+botim-cli create-vue-app my-vue-app
+
+# Using alias
+botim-cli vue my-vue-app
+```
+
+### Interactive Mode
+
+```bash
+# Using npm run
+npm run cli create
+
+# Or if globally installed
+botim-cli create
+
+# Using alias
+botim-cli init
+```
+
+The interactive mode will prompt you for:
+- Project name
+- Framework (React or Vue)
+- TypeScript support
+- Routing
+- State management
+- Testing setup
+- Linting (ESLint & Prettier)
+- Package manager preference
+
+### Available Commands
+
+| Command | Alias | Description |
+|---------|-------|-------------|
+| `create` | `init` | Interactive mode - choose framework and features |
+| `create-react-app` | `react` | Create a new React application |
+| `create-vue-app` | `vue` | Create a new Vue application |
+| `examples` | - | Show usage examples and patterns |
+| `quick-start` | `qs` | Show quick start guide |
+| `--help` | `-h` | Display help information |
+| `--version` | `-v` | Display version number |
+
+## Project Structure
+
+```
+cli/
+├── src/
+│   ├── commands/           # CLI commands
+│   │   ├── create-react-app.ts
+│   │   ├── create-vue-app.ts
+│   │   └── index.ts
+│   ├── templates/          # Project templates
+│   │   ├── react/
+│   │   │   └── template-files/
+│   │   └── vue/
+│   │       └── template-files/
+│   ├── plugins/            # Plugin system
+│   │   ├── plugin-registry.ts
+│   │   ├── plugin-loader.ts
+│   │   └── types.ts
+│   ├── core/               # Core functionality
+│   │   ├── template-engine.ts
+│   │   ├── file-generator.ts
+│   │   └── types.ts
+│   ├── utils/              # Utility functions
+│   │   ├── file-operations.ts
+│   │   ├── prompts.ts
+│   │   └── validators.ts
+│   ├── types/              # TypeScript type definitions
+│   │   └── index.ts
+│   ├── index.ts            # Main export
+│   └── cli.ts              # CLI entry point
+├── bin/
+│   └── cli                 # Executable
+├── dist/                   # Compiled JavaScript
+├── tsconfig.json
+├── package.json
+└── README.md
+```
+
+## Generated Project Features
+
+### React Projects
+
+- React 18 with latest features
+- Vite for fast development and building
+- Optional TypeScript support
+- Optional React Router for routing
+- Optional Zustand for state management
+- Optional Vitest & Testing Library for testing
+- Optional ESLint & Prettier for code quality
+- Pre-configured with best practices
+
+### Vue Projects
+
+- Vue 3 with Composition API
+- Vite for fast development and building
+- Optional TypeScript support
+- Optional Vue Router for routing
+- Optional Pinia for state management
+- Optional Vitest & Testing Library for testing
+- Optional ESLint & Prettier for code quality
+- Pre-configured with best practices
+
+## Extensibility
+
+### Plugin System
+
+The CLI includes a plugin system that allows you to extend its functionality:
+
+```typescript
+import { Plugin, PluginContext } from '@botim/cli-generator';
+
+const myPlugin: Plugin = {
+  name: 'my-custom-plugin',
+  version: '1.0.0',
+  type: 'template',
+  async execute(config, context) {
+    // Your plugin logic here
+  },
+};
+
+export default myPlugin;
+```
+
+### Adding New Templates
+
+1. Create a new directory under `src/templates/`
+2. Add your template files
+3. Create a command in `src/commands/`
+4. Register the command in `src/cli.ts`
+
+## Development
+
+### Available Scripts
+
+```bash
+# Build the project
+npm run build
+
+# Build and watch for changes
+npm run dev
+
+# Type check without emitting
+npm run type-check
+
+# Run the CLI locally
+npm run cli -- [command]
+
+# Run tests (when implemented)
+npm test
+```
+
+### Project Requirements
+
+- Node.js >= 16.0.0
+- npm, yarn, or pnpm
+
+### Dependencies
+
+**Runtime Dependencies:**
+- `commander` - CLI framework
+- `inquirer` - Interactive prompts
+- `fs-extra` - Enhanced file operations
+- `handlebars` - Template processing
+- `chalk` - Terminal colors
+- `ora` - Spinners and progress indicators
+- `zod` - Runtime validation
+- `which-pm-runs` - Package manager detection
+
+**Dev Dependencies:**
+- `typescript` - Type safety
+- `tsup` - Build tool
+- `@types/*` - Type definitions
+
+## Architecture
+
+### Core Components
+
+1. **Template Engine**: Processes and generates projects from templates
+2. **File Generator**: Handles file creation and copying
+3. **Command System**: Implements CLI commands using Commander
+4. **Plugin System**: Extensible architecture for adding new features
+5. **Validation**: Input validation using Zod schemas
+
+### Design Principles
+
+- **Type Safety**: Full TypeScript support with strict mode
+- **Modularity**: Separated concerns for better maintainability
+- **Extensibility**: Plugin-based architecture for future growth
+- **User Experience**: Interactive prompts and helpful error messages
+- **Best Practices**: Generated projects follow modern web development standards
+
+## Future Enhancements
+
+- [ ] Add more framework templates (Angular, Svelte, etc.)
+- [ ] Support for different build tools (Webpack, etc.)
+- [ ] Template update mechanism
+- [ ] Community plugin registry
+- [ ] Support for plugins in different languages
+- [ ] CI/CD configuration templates
+- [ ] Docker configuration generation
+- [ ] More testing utilities
+
+## Contributing
+
+Contributions are welcome! Please follow these steps:
+
+1. Fork the repository
+2. Create a feature branch
+3. Make your changes
+4. Write/update tests
+5. Submit a pull request
+
+## License
+
+ISC
+
+## Questions & Support
+
+For questions or issues, please visit the project repository.
+
+## Acknowledgments
+
+Built with modern web development tools and best practices to streamline project initialization and reduce repetitive setup tasks.

package/bin/cli

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import("../dist/cli.mjs");

package/dist/cli.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node