compadcn

compadcn is an advanced Command Line Interface (CLI) tool designed specifically for the efficient installation and management of ShadCN UI components. This tool enhances the development experience through a variety of powerful features:

Key Features

• Effortless Component Installation: Quickly add ShadCN components to your project with a simple command.

• Smart Linting: Identify and eliminate unused components from your codebase, ensuring a clean and optimized project.

• Automatic Import Cleanup: When components are removed, any associated imports are also automatically deleted, simplifying maintenance.

• Dependency Management: Choose to automatically remove unused dependencies when components are deleted, streamlining your project's dependency tree.

• Custom Presets: Create and manage collections of frequently used components, allowing for quicker setup rates and uniformity across projects.

Usage

Adding Components

To add ShadCN components to your project, use:

# Interactive mode: Select components from the list
compadcn add

# Specify components directly
compadcn add button card dialog

Removing Components

To remove components, the command is as follows:

# Interactive mode: Choose which installed components to delete
compadcn remove

# Specify components directly to remove
compadcn remove button card

Linting Your Project

Run a lint check against your project using the command:

compadcn lint

This command scans the codebase for unused components and can even suggest commands for their removal.

Managing Presets

Manage presets, which encompasses collections of commonly utilized components, with:

# Open the preset manager
compadcn preset

Preset Commands

• List Presets: compadcn preset list
• Install from Presets: compadcn preset install dashboard
• Create New Presets: compadcn preset create "my-preset" button card
• Delete Custom Presets: compadcn preset delete "my-preset"

How It Operates

Workflow Overview

1. Component Detection: Reads the components.json file to ascertain project structure.
2. Package Manager Recognition: Automatically identifies the package manager in use from your lock files.
3. Smart Installation: Utilizes the appropriate package manager to handle component installations.
4. Usage Analysis: Scans the codebase for patterns, identifying which components are in use.
5. Dependency Handling: Efficiently manages external and internal dependencies to ensure project integrity.

Project Structure

compadcn operates seamlessly within the standard ShadCN directory layout:

your-project/
├── components.json          # Configuration file for ShadCN
├── src/
│   └── components/
│       └── ui/             # Directory containing components
│           ├── button.tsx
│           ├── card.tsx
│           └── ...
└── package.json

Custom Presets

Custom presets are stored in ~/.compadcn/custom-presets.json and can be:

• Created from scratch.
• Based on existing presets.
• Shared across different projects, enhancing usability and collaboration.

compadcn streamlines the workflow for developers working with ShadCN UI components, making it an essential tool for any modern coding environment.