medieval-ui
v0.0.4
Published
A CLI tool for medieval UI components
Readme
medieval-ui
A CLI tool for adding medieval-themed medical UI components to your React/Next.js projects.
Installation
npm install medieval-uiOr use directly with npx:
npx medieval-ui add <component-name>Prerequisites
Your project must have:
components.json(shadcn/ui configuration)tailwind.config.ts(Tailwind CSS configuration)
If you haven't set up shadcn/ui yet, run:
npx shadcn@latest initUsage
Add a component
npx medievalui add <component-name>This will:
- Copy the component files to your project's component directory
- Install required shadcn/ui dependencies (card, button, input, select, badge, label, textarea)
- Install any additional component-specific dependencies
List available components
npx medievalui listDebug information
npx medievalui debugShows directory paths and configuration status for troubleshooting.
How It Works
medieval-ui copies component source code directly into your project, similar to shadcn/ui. This approach gives you:
- ✅ Full control over the component code
- ✅ Easy customization without ejecting
- ✅ No additional runtime dependencies
- ✅ Type-safe components with TypeScript
Components are copied to the directory specified in your components.json file.
Available Components
Run npx medievalui list to see all available components.
Components can be:
- Single files: Standalone
.tsxcomponents - Folders: Multi-file components with additional utilities or sub-components
Development
Setup
npm installRun locally
npm startCopy components from source
npm run componentsThis copies components from /home/enrique/projects/medieval/components/ui/ to this project's /components/ folder.
Scan component dependencies
npm run scan-depsAutomatically scans all component files and suggests which dependencies should be added to the dependencies object in index.js. This detects external package imports and filters out React core, Node built-ins, and shadcn packages.
Test the CLI
node index.js list
node index.js debugLicense
ISC
Author
a1gokn8t
