@reeverdev/ui-cli 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +100 -0
- package/package.json +3 -2
package/README.md
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# @reeverdev/ui-cli
|
|
2
|
+
|
|
3
|
+
> CLI tool for Reever UI component library - Add components to your project shadcn-style
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@reeverdev/ui-cli)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install -g @reeverdev/ui-cli
|
|
14
|
+
# or use with npx
|
|
15
|
+
npx @reeverdev/ui-cli <command>
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Commands
|
|
21
|
+
|
|
22
|
+
### Initialize Project
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npx @reeverdev/ui-cli init
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Sets up Reever UI in your project:
|
|
29
|
+
- Creates `reever.config.json` configuration file
|
|
30
|
+
- Configures component output directory
|
|
31
|
+
- Sets up Tailwind CSS integration
|
|
32
|
+
|
|
33
|
+
### Add Components
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
# Add specific components
|
|
37
|
+
npx @reeverdev/ui-cli add button dialog card
|
|
38
|
+
|
|
39
|
+
# Add all components
|
|
40
|
+
npx @reeverdev/ui-cli add --all
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### List Components
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
npx @reeverdev/ui-cli list
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Shows all available components in the registry.
|
|
50
|
+
|
|
51
|
+
### Show Differences
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npx @reeverdev/ui-cli diff
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
Compares local components with the registry and shows differences.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Configuration
|
|
62
|
+
|
|
63
|
+
After running `init`, a `reever.config.json` file is created:
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{
|
|
67
|
+
"componentDir": "./src/components/ui",
|
|
68
|
+
"tailwind": {
|
|
69
|
+
"config": "./tailwind.config.ts",
|
|
70
|
+
"css": "./src/app/globals.css"
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
---
|
|
76
|
+
|
|
77
|
+
## Available Components
|
|
78
|
+
|
|
79
|
+
| Category | Components |
|
|
80
|
+
|----------|------------|
|
|
81
|
+
| **Core** | Button, Input, Textarea, Label, Badge, Alert, Separator, Skeleton, Spinner |
|
|
82
|
+
| **Layout** | Card, Avatar, Accordion, Collapsible, Drawer, Table, Sidebar |
|
|
83
|
+
| **Form** | Checkbox, Switch, Select, Radio Group, Toggle, Slider, Rating |
|
|
84
|
+
| **Navigation** | Tabs, Breadcrumb, Navigation Menu, Pagination, Command |
|
|
85
|
+
| **Overlay** | Dialog, Alert Dialog, Dropdown Menu, Context Menu, Tooltip, Popover, Sheet |
|
|
86
|
+
| **Feedback** | Progress, Toast |
|
|
87
|
+
| **Date & Time** | Calendar, Date Picker |
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## Related
|
|
92
|
+
|
|
93
|
+
- [@reeverdev/ui](https://www.npmjs.com/package/@reeverdev/ui) - Main component library
|
|
94
|
+
- [GitHub Repository](https://github.com/reeverdev/ui)
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@reeverdev/ui-cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "CLI tool for Reever UI component library",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
7
7
|
"reever-ui": "./dist/index.js"
|
|
8
8
|
},
|
|
9
9
|
"files": [
|
|
10
|
-
"dist"
|
|
10
|
+
"dist",
|
|
11
|
+
"README.md"
|
|
11
12
|
],
|
|
12
13
|
"scripts": {
|
|
13
14
|
"build": "tsup index.ts --format esm",
|