@dofu-lab/simui-cli 0.1.0 → 0.1.1

package/README.md

@@ -1,148 +1,113 @@
-# @simui/cli
+# @dofu-lab/simui-cli
 
-A CLI to add [SimUI](https://simui.dev) Angular components to your project instantly.
+A small, focused CLI to fetch and inject SimUI Angular components into an existing Angular project.
 
-## Usage
+[![npm version](https://img.shields.io/npm/v/@dofu-lab/simui-cli.svg)](https://www.npmjs.com/package/@dofu-lab/simui-cli)
+[![license](https://img.shields.io/npm/l/@dofu-lab/simui-cli.svg)](#license)
 
-```bash
-# Using npx (no install required)
-npx @simui/cli add accordion-01
+This tool fetches component source from the SimUI registry (https://simui.dev/registry), writes the component file into your project, and offers to install any detected dependencies (Spartan UI generators and ng-icons).
 
-# Or install globally
-npm install -g @simui/cli
-simui add accordion-01
-```
+Features
+- Fetch a component by name and inject it into your project
+- Detects `@spartan-ng/helm/*` and `@ng-icons/*` imports and offers to install them
+- Default output path: `src/app/components` (configurable with `--path`)
 
-## Commands
+Prerequisites
+- Node.js >= 18
+- An Angular project (CLI available via `ng`)
 
-### `simui add <component>`
+Installation (local use)
 
-Fetches a component from the SimUI registry and writes it to your project.
+You can run the CLI directly from the built artifact in this repository without publishing to npm:
 
 ```bash
-simui add select-01
-simui add dialog-03
-simui add button-07
+cd packages/cli
+npm install
+npm run build
+node dist/index.js add accordion-01
 ```
 
-**Options:**
-
-| Flag | Default | Description |
-|------|---------|-------------|
-| `-p, --path <dir>` | `src/app/components` | Output directory (relative to cwd) |
-
-**Examples:**
+Usage
 
 ```bash
-# Default path: src/app/components/accordion-01.component.ts
-simui add accordion-01
+# Fetch and add a component to the default location
+node dist/index.js add accordion-01
 
-# Custom output directory
-simui add badge-05 --path src/shared/ui
+# Use the published package (once available)
+npx @dofu-lab/simui-cli add accordion-01
 
-# Short flag alias
-simui add input-12 -p src/features/auth
+# Override output directory
+node dist/index.js add badge-01 --path src/shared/ui
 ```
 
-## What it does
-
-1. **Fetches** the component TypeScript source from `https://simui.dev/registry/<name>.json`
-2. **Writes** the file to the resolved output path
-3. **Detects** required `@spartan-ng/helm/*` and `@ng-icons/*` imports
-4. **Prompts** you to install them:
-   - Spartan UI packages — installed via `npx @spartan-ng/cli@latest add <package>`
-   - `@ng-icons/*` packages  — installed via your detected package manager (pnpm / yarn / npm)
-
-## Requirements
-
-- Node.js ≥ 18
-- An Angular project with [Spartan UI](https://spartan.ng) configured
+Commands
 
-## Browse components
+- `add <component>` — fetches `<component>` from the registry and writes `<component>.component.ts` to the output directory.
 
-Visit [simui.dev](https://simui.dev) to browse all available components and their previews.
+Options
 
-## Publishing
+- `-p, --path <dir>` — Output directory relative to the current working directory (default: `src/app/components`).
 
-Follow these steps to publish a new version of `@simui/cli` to the npm registry.
+What the command does
 
-1. Run tests and linters
+1. Fetches `https://simui.dev/registry/<name>.json` and reads the `content` field.
+2. Writes the TypeScript component file to the chosen output path.
+3. Parses the source for `@spartan-ng/helm/*` and `@ng-icons/*` imports.
+4. Prompts to install dependencies. Spartan packages are invoked via the Angular generator:
 
 ```bash
-# from packages/cli
-npm test     # if you have tests
-npm run lint # if you have a lint script
+ng generate @spartan-ng/cli:ui <package>
 ```
 
-2. Bump the package version (creates a git commit and tag)
+And `@ng-icons/*` packages are installed via your detected package manager (`pnpm`, `yarn`, or `npm`).
+
+Development
 
 ```bash
 cd packages/cli
-npm version patch   # or `minor` / `major`
-# push the commit and tag afterwards
+npm install
+npm run build
+# Run the CLI locally
+node dist/index.js add select-01
 ```
 
-3. Update changelog (optional)
+Publishing
 
-Edit `packages/cli/CHANGELOG.md` or add release notes for the new version.
-
-4. Build the package
+Follow these steps to publish a new version of this package under the `@dofu-lab` scope.
 
 ```bash
 cd packages/cli
-npm run build
-```
-
-5. Dry-run publish / pack
+# bump version (creates a commit + tag)
+npm version patch
 
-```bash
-# create a tarball for inspection
-npm pack
+# build
+npm run build
 
-# simulate publish (shows what will be published)
+# dry-run
 npm publish --dry-run
-```
-
-6. Login to npm (if needed)
-
-```bash
-npm whoami || npm login
-```
-
-7. Publish to npm
 
-```bash
-cd packages/cli
+# publish (scoped public requires --access public)
 npm publish --access public
-```
-
-8. Push changes and tags to the remote repo
 
-```bash
-# from repo root
+# push commits and tags
 git push origin main
 git push --tags
 ```
 
-9. Create a GitHub release (optional)
+Contributing
 
-```bash
-gh release create vX.Y.Z --title "vX.Y.Z" --notes "Short changelog"
-```
+Contributions are welcome. Open issues or pull requests against this repository. For code changes:
 
-10. Verify installation
+1. Fork the repo
+2. Create a feature branch
+3. Run tests and build locally
+4. Submit a pull request
 
-```bash
-# try via npx
-npx @simui/cli@latest add accordion-01
+License
 
-# or install globally
-npm install -g @simui/cli
-simui add accordion-01
-```
+This project is licensed under the MIT License — see the `LICENSE` file for details.
+
+Support
 
-Notes:
-- If your package is scoped (e.g. `@simui/cli`) publishing publicly requires `--access public`.
-- If your npm account has 2FA enabled, you'll be prompted for an OTP when publishing.
-- For CI-based publishing, use an `NPM_TOKEN` and run `npm publish` from the pipeline.
+If you encounter issues, open an issue on the repository with logs and reproduction steps.
 

package/dist/index.js

@@ -131,15 +131,16 @@ async function addComponent(componentName, options) {
     const installSpinner = p.spinner();
     installSpinner.start(`Installing @spartan-ng/helm/${helmPkg}\u2026`);
     try {
-      execSync(`npx @spartan-ng/cli@latest add ${helmPkg}`, {
+      execSync(`npx ng generate @spartan-ng/cli:ui ${helmPkg}`, {
         cwd,
         stdio: "pipe"
       });
-      installSpinner.stop(chalk.green(`@spartan-ng/helm/${helmPkg} installed`));
+      installSpinner.stop(chalk.green(`@spartan-ng/helm/${helmPkg} installed via generator`));
     } catch (err) {
       installSpinner.stop(chalk.red(`Failed to install @spartan-ng/helm/${helmPkg}`));
       const stderr = err instanceof Error && "stderr" in err ? String(err.stderr) : "";
       p.log.warn(chalk.dim(stderr.trim() || String(err)));
+      p.log.warn(`If this fails, try running: ${chalk.bold(`ng generate @spartan-ng/cli:ui ${helmPkg}`)}`);
     }
   }
   if (ngIcons.length > 0) {

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@dofu-lab/simui-cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "CLI to add SimUI components to your Angular project",
   "type": "module",
   "main": "./dist/index.js",
   "bin": {
     "simui": "./dist/index.js"
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",