@cloudwick/astral-ui-cli 0.6.0 → 1.0.0

package/README.md

@@ -30,14 +30,11 @@ yarn global add @cloudwick/astral-ui-cli
 # Initialize your project
 npx @cloudwick/astral-ui-cli init
 
-# Follow instructions to set up path aliases
-npx @cloudwick/astral-ui-cli setup-aliases
-
 # Add components
 npx @cloudwick/astral-ui-cli add button card
 
 # Start using in your code
-import { Button } from '@components/ui/button';
+import { Button } from '@components/button';
 import { cn } from '@utils';
 import { keyboardKeys, mobileBreakPoint } from '@constants';
 ```
@@ -46,8 +43,8 @@ import { keyboardKeys, mobileBreakPoint } from '@constants';
 
 For the best experience, follow these steps in order:
 
-1. **Initialize** your project with `npx @cloudwick/astral-ui-cli init`
-2. **Set up path aliases** using `npx @cloudwick/astral-ui-cli setup-aliases` and follow the instructions
+1. **Initialize** your project with `npx @cloudwick/astral-ui-cli init` - this will display path alias setup instructions for your project type
+2. **Configure path aliases** in your project following the instructions shown during initialization
 3. **Add components** with `npx @cloudwick/astral-ui-cli add [component...]`
 4. **Repair Tailwind** if needed with `npx @cloudwick/astral-ui-cli repair-tailwind`
 5. **Import and use** components in your application
@@ -70,6 +67,7 @@ This command will:
 - Add utility functions
 - Add Inter font files for consistent typography
 - Set up font CSS for proper font rendering
+- Display detailed path alias setup instructions based on your project type (Next.js, Vite, Webpack, CRA, etc.)
 
 #### Options
 
@@ -77,40 +75,19 @@ This command will:
 |--------|-------|-------------|
 | `--yes` | `-y` | Skip confirmation prompts |
 | `--defaults` | `-d` | Use default configuration |
-| `--force` | `-f` | Force overwrite of existing configuration |
-| `--cwd <dir>` | `-c` | Specify the working directory |
-| `--silent` | `-s` | Mute output |
-
-### `setup-aliases`
-
-Display instructions for setting up path aliases in your project.
-
-```bash
-npx @cloudwick/astral-ui-cli setup-aliases
-```
-
-This command will:
-- Analyze your project structure
-- Detect the type of project (Next.js, Vite, Webpack, etc.)
-- Provide specific instructions for configuring path aliases based on your project type
-- Check for special configurations like tsconfig.app.json (used in Angular projects)
-
-#### Options
-
-| Option | Alias | Description |
-|--------|-------|-------------|
 | `--cwd <dir>` | `-c` | Specify the working directory |
 | `--silent` | `-s` | Mute output |
 
-#### Examples
+**Note:** When files already exist, backups are automatically created before replacing them.
 
-```bash
-# Generate instructions for current directory
-npx @cloudwick/astral-ui-cli setup-aliases
+The init command automatically detects your project type and provides specific path alias configuration instructions for:
+- **Next.js**: Uses tsconfig.json/jsconfig.json for aliases
+- **Vite**: Provides vite.config.js/ts configuration
+- **Webpack**: Provides webpack.config.js configuration
+- **Create React App**: Provides CRACO setup instructions
+- **Generic**: Provides base configuration for other project types
 
-# Generate instructions for a specific project
-npx @cloudwick/astral-ui-cli setup-aliases --cwd ./my-project
-```
+Additionally, the CLI detects tsconfig.app.json (used by some frameworks for application-specific TypeScript settings) and provides guidance for configuring it.
 
 ### `add`
 
@@ -124,8 +101,6 @@ npx @cloudwick/astral-ui-cli add [component...]
 
 | Option | Alias | Description |
 |--------|-------|-------------|
-| `--yes` | `-y` | Skip confirmation prompts |
-| `--overwrite` | `-o` | Overwrite existing files |
 | `--cwd <dir>` | `-c` | Specify the working directory |
 | `--all` | `-a` | Add all available components |
 | `--path <path>` | `-p` | Specify the path to add the component to |
@@ -133,6 +108,8 @@ npx @cloudwick/astral-ui-cli add [component...]
 | `--skip-dependencies` |  | Skip installing internal component dependencies |
 | `--list` | `-l` | List all available components |
 
+**Note:** When a component already exists, you will be prompted before replacing it. A backup is automatically created when replacing.
+
 #### Examples
 
 ```bash
@@ -181,19 +158,17 @@ The CSS structure created will match exactly what the `init` command creates, in
 
 | Option | Alias | Description |
 |--------|-------|-------------|
-| `--force` | `-f` | Force overwrite of existing configuration without prompting |
 | `--cwd <dir>` | `-c` | Specify the working directory |
 | `--silent` | `-s` | Mute output |
 
+**Note:** The command will prompt before replacing existing files and automatically create backups.
+
 #### Example Usage
 
 ```bash
 # Basic repair
 npx @cloudwick/astral-ui-cli repair-tailwind
 
-# Force overwrite existing files
-npx @cloudwick/astral-ui-cli repair-tailwind --force
-
 # Repair in a specific directory
 npx @cloudwick/astral-ui-cli repair-tailwind --cwd ./my-project
 ```
@@ -233,7 +208,6 @@ You can use this schema in your editor or CI to validate your configuration. It
 - `$schema` (string): URI of this schema file.
 - `tailwind` (object): Paths to your Tailwind config (`config`) and CSS file (`css`).
 - `aliases` (object): Directories for `components`, `utils`, and `constants`.
-- `extensions` (string[]): File extensions to search for components.
 
 For full details, see `schema/components-config.schema.json` in your project.
 
@@ -266,8 +240,8 @@ After adding components, you can import and use them in your application:
 ### React/Next.js Example
 
 ```tsx
-import { Button } from '@components/ui/button';
-import { Card, CardHeader, CardContent } from '@components/ui/card';
+import { Button } from '@components/button';
+import { Card, CardHeader, CardContent } from '@components/card';
 import { cn } from '@utils';
 import { keyboardKeys, mobileBreakPoint } from '@constants';
 
@@ -342,9 +316,9 @@ If you're having problems with imports:
 1. **Check your configuration**: Make sure the paths in tsconfig.json/jsconfig.json match your project structure
 2. **Framework-specific issues**:
    - **Next.js**: Make sure you're using the correct import format for your Next.js version
-   - **Angular**: Configure paths in tsconfig.app.json instead of tsconfig.json
+   - **tsconfig.app.json**: If your project uses tsconfig.app.json, configure paths there as well
    - **Create React App**: You'll need CRACO or similar to enable path aliases
-3. **Verify setup**: Run `npx @cloudwick/astral-ui-cli setup-aliases` again to get fresh instructions
+3. **Verify setup**: The path alias setup instructions are shown during `init` - you can run `npx @cloudwick/astral-ui-cli init` again to see them
 4. **Check components.json**: Make sure the paths in the "aliases" section match your project structure
 
 ### Styling Issues