ui-thing 0.2.9 → 0.3.1

package/.claude/settings.local.json

@@ -0,0 +1,5 @@
+{
+  "permissions": {
+    "allow": ["Bash(bun run *)", "Bash(git *)"]
+  }
+}

package/.github/workflows/main.yml

@@ -8,12 +8,15 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ["20.x", "22.x", "lts/*"]
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: npm install
-      - uses: actions/setup-node@v4
-        with:
-          node-version: "18.x"
       - name: Build
         run: npm run format && npm run build

package/.github/workflows/test.yml

@@ -6,13 +6,16 @@ on:
       - "**"
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ["20.x", "22.x", "lts/*"]
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v6
         with:
-          node-version: "22.x"
+          node-version: ${{ matrix.node-version }}
       - name: Install dependencies
         run: npm install
       - name: Test

package/.prettierrc

@@ -1,7 +1,7 @@
 {
   "arrowParens": "always",
   "endOfLine": "lf",
-  "plugins": ["@ianvs/prettier-plugin-sort-imports"],
+  "plugins": ["@ianvs/prettier-plugin-sort-imports", "prettier-plugin-packagejson"],
   "printWidth": 100,
   "semi": true,
   "singleQuote": false,

package/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Changelog
 
+## v0.3.1
+
+[compare changes](https://github.com/BayBreezy/ui-thing-cli/compare/v0.3.0...v0.3.1)
+
+### 🚀 Enhancements
+
+- **add:** Add --skip-config flag to install components without a config file ([70dcea2](https://github.com/BayBreezy/ui-thing-cli/commit/70dcea2))
+
+### 📖 Documentation
+
+- **readme:** Rewrite with full command reference for v0.3.0 ([ce3c6ba](https://github.com/BayBreezy/ui-thing-cli/commit/ce3c6ba))
+
+### 🤖 CI
+
+- Run test and build workflows across node 20, 22, and lts ([73e1c8d](https://github.com/BayBreezy/ui-thing-cli/commit/73e1c8d))
+
+### ❤️ Contributors
+
+- Behon Baker ([@BayBreezy](https://github.com/BayBreezy))
+
+## v0.3.0
+
+[compare changes](https://github.com/BayBreezy/ui-thing-cli/compare/v0.2.9...v0.3.0)
+
+### 🚀 Enhancements
+
+- **Deno support:** Deno is now a valid package manager choice during `init`. The CLI uses `deno add npm:<pkg>` for dependencies, `--dev` instead of `-D` for dev dependencies, and `deno run -A npm:nuxt prepare` for the post-install step ([e94c67d](https://github.com/BayBreezy/ui-thing-cli/commit/e94c67d))
+- **`list` command:** New `ui-thing list` command displays all available components. Pass `--installed` to filter to only components whose files are already present in your project ([fdf5784](https://github.com/BayBreezy/ui-thing-cli/commit/fdf5784))
+- **`update` command:** New `ui-thing update [names...]` command re-fetches component files from the API and overwrites them in place. Omit names to pick from a list of installed components ([c1ee7ab](https://github.com/BayBreezy/ui-thing-cli/commit/c1ee7ab))
+- **`remove` command:** New `ui-thing remove [names...]` command deletes installed component files (including utils and composables). Omit names to pick from a list of installed components. Prompts for confirmation before deleting ([653d897](https://github.com/BayBreezy/ui-thing-cli/commit/653d897))
+- **Docs links after install:** After successfully installing a component via `add` or `prose`, the CLI now prints the documentation URL so you can jump straight to the component docs ([7f85822](https://github.com/BayBreezy/ui-thing-cli/commit/7f85822))
+
+### 🩹 Fixes
+
+- **`bun` and `pnpm` add command:** Both package managers were incorrectly using `install` instead of `add` when installing component dependencies. This is now fixed ([e94c67d](https://github.com/BayBreezy/ui-thing-cli/commit/e94c67d))
+- **Exit codes:** Error paths (missing config file, incomplete configuration) now correctly exit with code `1` instead of `0`, making the CLI usable in CI pipelines ([dfea222](https://github.com/BayBreezy/ui-thing-cli/commit/dfea222))
+- **`spawnSync` exit status:** The `prose` and `block` commands now check `result.status !== 0` in addition to `result.error`, so a failed component installer script no longer silently passes ([a9e92ff](https://github.com/BayBreezy/ui-thing-cli/commit/a9e92ff))
+- **API error handling:** All four fetch utilities (`fetchComponents`, `fetchProseComponents`, `fetchBlocks`, `fetchBlockCategories`) now catch network errors and print a clear message instead of crashing with an unhandled rejection ([78b1070](https://github.com/BayBreezy/ui-thing-cli/commit/78b1070))
+- **`.npmrc` safe merge (pnpm):** When using pnpm, the CLI previously overwrote `.npmrc` entirely. It now reads the existing file and only appends the lines that are not already present ([9a6af69](https://github.com/BayBreezy/ui-thing-cli/commit/9a6af69))
+
+### 💅 Refactors
+
+- **Centralized logger:** All ad-hoc `console.log(kleur...)` calls have been replaced with a new `logger` utility (`src/utils/logger.ts`) that wraps consola. This gives consistent formatting across every command and makes it easy to redirect output in the future ([748650b](https://github.com/BayBreezy/ui-thing-cli/commit/748650b))
+
+### 🏡 Chore
+
+- Update all dependencies to latest versions ([8799650](https://github.com/BayBreezy/ui-thing-cli/commit/8799650))
+
+### ❤️ Contributors
+
+- Behon Baker ([@BayBreezy](https://github.com/BayBreezy))
+
 ## v0.2.9
 
 [compare changes](https://github.com/BayBreezy/ui-thing-cli/compare/v0.2.8...v0.2.9)

package/README.md

@@ -2,45 +2,64 @@
 
 ![Cover Image](https://uithing.com/cover.png)
 
+A CLI for adding [UI Thing](https://uithing.com) components to your Nuxt project. Pick only the components you need — no bloat, no lock-in.
+
 ## Credits
 
-- shadcn/ui
-- Radiv-Vue
-- Reka UI
-- TailwindCSS
-- Nuxt
-- Nuxt UI
+- [shadcn/ui](https://ui.shadcn.com) — design inspiration
+- [Reka UI](https://reka-ui.com) — headless primitives
+- [TailwindCSS](https://tailwindcss.com)
+- [Nuxt](https://nuxt.com)
 
-Thanks to the maintainers of the other third party libraries used in this project.
+Thanks to the maintainers of all third-party libraries used in this project.
 
-## 💸 Support Me
+## 💸 Support
 
-If you can 😊
+If you find this useful 😊
 
 <a href="https://buymeacoffee.com/llehXIrI8g" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important" ></a>
 
+---
+
 ## Getting Started
 
-- Create a Nuxt project
-- Install the dependencies
-- Run the init command
+**1. Create a Nuxt project**
 
 ```bash
-npx ui-thing@latest init
+npx nuxi@latest init my-app
+cd my-app
 ```
 
-- Start the dev server
+**2. Run the init command**
 
 ```bash
-npm run dev
+npx ui-thing@latest init
 ```
 
-- Add components to your project with the `add` command
+This sets up TailwindCSS, installs core dependencies, writes the theme CSS, and saves a `ui-thing.config.ts` to your project.
+
+**3. Start adding components**
 
 ```bash
 npx ui-thing@latest add
 ```
 
+---
+
+## Package Manager Support
+
+The CLI works with all major package managers. You will be asked to choose one during `init`.
+
+| Manager | Supported |
+|---------|-----------|
+| npm     | ✅ |
+| yarn    | ✅ |
+| pnpm    | ✅ |
+| bun     | ✅ |
+| deno    | ✅ |
+
+---
+
 ## Commands
 
 ### `init`
@@ -49,15 +68,147 @@ npx ui-thing@latest add
 npx ui-thing@latest init
 ```
 
-This command will install the dependencies and add the required configuration to your project. It will also add a `.prettierrc` file to your project.
+Bootstraps your Nuxt project for UI Thing. This command:
+
+- Installs all core dependencies (`reka-ui`, `tailwind-variants`, `@nuxt/fonts`, `@vueuse/nuxt`, etc.)
+- Writes the Tailwind CSS theme file
+- Registers required Nuxt modules
+- Creates `ui-thing.config.ts` with your chosen paths and package manager
+
+**Options**
+
+| Flag | Description |
+|------|-------------|
+| `-y, --yes` | Skip all prompts and use defaults |
+
+---
 
 ### `add`
 
 ```bash
+npx ui-thing@latest add [componentNames...]
+```
+
+Adds one or more components to your project. If no names are passed, an interactive search lets you pick from the full library.
+
+```bash
+# interactive selection
 npx ui-thing@latest add
+
+# add specific components
+npx ui-thing@latest add button input popover
+
+# add every component at once
+npx ui-thing@latest add --all
+```
+
+After a component is added, the CLI prints a link to its documentation page.
+
+**Options**
+
+| Flag | Description |
+|------|-------------|
+| `-a, --all` | Add every available component in one shot |
+| `--skip-config` | Add components without a `ui-thing.config.ts` file. Auto-detects the Nuxt version and uses its default paths |
+| `--package-manager <pm>` | Set the package manager when using `--skip-config` (skips the PM prompt) |
+
+**`--skip-config` example**
+
+Useful when you just want the files without committing to the full config workflow:
+
+```bash
+# prompts for package manager, uses Nuxt 4 defaults
+npx ui-thing@latest add popover --skip-config
+
+# fully non-interactive
+npx ui-thing@latest add popover --skip-config --package-manager bun
 ```
 
-This command will add the components to your project.
+> **Note:** Shared utility files installed by one component are also used by others. Removing them manually may break components that depend on them.
+
+---
+
+### `list`
+
+```bash
+npx ui-thing@latest list
+```
+
+Lists all components available in the UI Thing library.
+
+```bash
+# show all available components
+npx ui-thing@latest list
+
+# show only components already installed in your project
+npx ui-thing@latest list --installed
+```
+
+**Options**
+
+| Flag | Description |
+|------|-------------|
+| `--installed` | Filter to components whose files are already present in your project |
+
+---
+
+### `update`
+
+```bash
+npx ui-thing@latest update [componentNames...]
+```
+
+Re-fetches component files from the API and overwrites them with the latest version. Useful after a UI Thing release.
+
+```bash
+# update specific components
+npx ui-thing@latest update button input
+
+# pick from installed components interactively
+npx ui-thing@latest update
+```
+
+---
+
+### `remove`
+
+```bash
+npx ui-thing@latest remove [componentNames...]
+```
+
+Deletes installed component files from your project (component files, utils, and composables). Prompts for confirmation before deleting anything.
+
+```bash
+# remove specific components
+npx ui-thing@latest remove button
+
+# pick from installed components interactively
+npx ui-thing@latest remove
+```
+
+> **Note:** Shared utility files used by multiple components will be deleted. Any other components that depend on them may stop working and will need to be re-added.
+
+---
+
+### `prose`
+
+```bash
+npx ui-thing@latest prose
+```
+
+Adds prose components (typography styles for rendered markdown content). Select from the available prose components interactively.
+
+---
+
+### `block`
+
+```bash
+npx ui-thing@latest block
+```
+
+Adds pre-built UI blocks (page sections, layouts, etc.) to your project. You can filter by category.
+
+---
 
 ### `theme`
 
@@ -65,7 +216,9 @@ This command will add the components to your project.
 npx ui-thing@latest theme
 ```
 
-This command will add the theme to your project.
+Swaps your project's color theme. Overwrites the Tailwind CSS theme file with the chosen theme.
+
+---
 
 ### `prettier`
 
@@ -73,7 +226,9 @@ This command will add the theme to your project.
 npx ui-thing@latest prettier
 ```
 
-This command will add the prettier configuration to your project.
+Adds a Prettier configuration pre-configured for Tailwind CSS class sorting. Safe to run on an existing project — it will offer to merge with your current `.prettierrc` if one exists.
+
+---
 
 ### `shortcuts`
 
@@ -81,4 +236,36 @@ This command will add the prettier configuration to your project.
 npx ui-thing@latest shortcuts
 ```
 
-This command will add the `shortcuts` composable to your project.
+Adds a `useShortcuts` composable to your project for registering keyboard shortcuts.
+
+---
+
+## Configuration
+
+Running `init` creates a `ui-thing.config.ts` file at the root of your project:
+
+```ts
+export default {
+  theme: "zinc",
+  tailwindCSSLocation: "app/assets/css/tailwind.css",
+  componentsLocation: "app/components/Ui",
+  composablesLocation: "app/composables",
+  pluginsLocation: "app/plugins",
+  utilsLocation: "app/utils",
+  force: true,
+  useDefaultFilename: true,
+  packageManager: "bun",
+};
+```
+
+| Key | Description |
+|-----|-------------|
+| `theme` | Color theme (zinc, slate, rose, blue, etc.) |
+| `tailwindCSSLocation` | Path to your Tailwind CSS file |
+| `componentsLocation` | Where component `.vue` files are written |
+| `composablesLocation` | Where composable files are written |
+| `pluginsLocation` | Where plugin files are written |
+| `utilsLocation` | Where utility files are written |
+| `force` | Overwrite existing files without prompting |
+| `useDefaultFilename` | Skip per-file path prompts when adding components |
+| `packageManager` | Package manager used for installing dependencies |