@dowel-ui/cli 0.1.1 → 0.2.0
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/LICENSE +1 -1
- package/README.md +66 -0
- package/package.json +29 -4
package/LICENSE
CHANGED
package/README.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
# @dowel-ui/cli
|
|
4
|
+
|
|
5
|
+
### The command that puts components in your repo
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/@dowel-ui/cli)
|
|
8
|
+
[](https://github.com/aqkprogrammer/dowel-ui/blob/main/LICENSE)
|
|
9
|
+
|
|
10
|
+
[**Documentation**](https://dowel-eight.vercel.app/docs/cli) · [**Components**](https://dowel-eight.vercel.app/docs/components)
|
|
11
|
+
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx @dowel-ui/cli init
|
|
18
|
+
npx @dowel-ui/cli add button dialog data-table
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Components are **written into your project as source**, with imports rewritten
|
|
22
|
+
to your own path aliases. No dependency stands between you and the markup.
|
|
23
|
+
|
|
24
|
+
## Commands
|
|
25
|
+
|
|
26
|
+
| Command | What it does |
|
|
27
|
+
| -------- | ---------------------------------------------------- |
|
|
28
|
+
| `init` | Sets up config, utilities and design tokens |
|
|
29
|
+
| `add` | Adds components, with everything they depend on |
|
|
30
|
+
| `list` | Shows the registry, marking what you already have |
|
|
31
|
+
| `update` | Compares your copies against the registry |
|
|
32
|
+
| `remove` | Deletes components, keeping anything you have edited |
|
|
33
|
+
|
|
34
|
+
## It respects your edits
|
|
35
|
+
|
|
36
|
+
The CLI records a hash of every file it writes. When you later run `update` or
|
|
37
|
+
`remove`, it can tell the difference between a file you never touched and one
|
|
38
|
+
you changed — and it will not quietly overwrite your work.
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npx @dowel-ui/cli remove button
|
|
42
|
+
# ✕ button.tsx has local changes. Pass --force to delete it anyway.
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
It also refuses to remove a component that another installed component still
|
|
46
|
+
imports.
|
|
47
|
+
|
|
48
|
+
## Point it anywhere
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
npx @dowel-ui/cli --registry https://your-registry.example/r add button
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
The registry is static JSON with a content hash per file. Host your own fork,
|
|
55
|
+
your own components, or a private company registry — the CLI does not care
|
|
56
|
+
whose it is.
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
<div align="center">
|
|
61
|
+
|
|
62
|
+
[**Read the docs →**](https://dowel-eight.vercel.app/docs/cli)
|
|
63
|
+
|
|
64
|
+
MIT licensed
|
|
65
|
+
|
|
66
|
+
</div>
|
package/package.json
CHANGED
|
@@ -1,8 +1,33 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dowel-ui/cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"type": "module",
|
|
5
|
-
"description": "
|
|
5
|
+
"description": "Installs Dowel components into your project as source you own, with dependencies resolved and imports rewritten to your path aliases.",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"cli",
|
|
8
|
+
"react",
|
|
9
|
+
"ui",
|
|
10
|
+
"components",
|
|
11
|
+
"component-library",
|
|
12
|
+
"design-system",
|
|
13
|
+
"tailwind",
|
|
14
|
+
"scaffolding",
|
|
15
|
+
"registry",
|
|
16
|
+
"code-generation",
|
|
17
|
+
"shadcn",
|
|
18
|
+
"source-first",
|
|
19
|
+
"dowel"
|
|
20
|
+
],
|
|
21
|
+
"license": "MIT",
|
|
22
|
+
"homepage": "https://dowel-eight.vercel.app",
|
|
23
|
+
"repository": {
|
|
24
|
+
"type": "git",
|
|
25
|
+
"url": "git+https://github.com/aqkprogrammer/dowel-ui.git",
|
|
26
|
+
"directory": "packages/cli"
|
|
27
|
+
},
|
|
28
|
+
"bugs": {
|
|
29
|
+
"url": "https://github.com/aqkprogrammer/dowel-ui/issues"
|
|
30
|
+
},
|
|
6
31
|
"files": [
|
|
7
32
|
"dist"
|
|
8
33
|
],
|
|
@@ -30,8 +55,8 @@
|
|
|
30
55
|
"tsx": "4.23.13",
|
|
31
56
|
"typescript": "6.0.3",
|
|
32
57
|
"vitest": "4.1.10",
|
|
33
|
-
"@dowel-ui/
|
|
34
|
-
"@dowel-ui/
|
|
58
|
+
"@dowel-ui/config": "0.2.0",
|
|
59
|
+
"@dowel-ui/registry": "0.2.0"
|
|
35
60
|
},
|
|
36
61
|
"scripts": {
|
|
37
62
|
"build": "tsdown",
|