uirules 0.0.1 → 0.0.3

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.
Files changed (3) hide show
  1. package/README.md +72 -0
  2. package/dist/app.js +33223 -15171
  3. package/package.json +6 -4
package/README.md ADDED
@@ -0,0 +1,72 @@
1
+ # UIRules CLI
2
+
3
+ CLI tool to generate UI guidelines from your design system.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install -g uirules
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```bash
14
+ npx uirules generate
15
+ ```
16
+
17
+ ## Local Development
18
+
19
+ ### Testing locally with npm link
20
+
21
+ 1. Build the CLI:
22
+
23
+ ```bash
24
+ cd apps/cli
25
+ bun run build
26
+ ```
27
+
28
+ 2. Create a global symlink:
29
+
30
+ ```bash
31
+ npm link
32
+ ```
33
+
34
+ 3. In another project, link the package:
35
+
36
+ ```bash
37
+ cd /path/to/your-project
38
+ npm link uirules
39
+ ```
40
+
41
+ 4. Now you can run the CLI:
42
+
43
+ ```bash
44
+ npx uirules generate
45
+ ```
46
+
47
+ ### Unlinking
48
+
49
+ When done testing, remove the symlinks:
50
+
51
+ ```bash
52
+ # In the test project
53
+ npm unlink uirules
54
+
55
+ # In the CLI directory
56
+ npm unlink
57
+ ```
58
+
59
+ ### Development mode
60
+
61
+ For active development with auto-reload:
62
+
63
+ ```bash
64
+ cd apps/cli
65
+ bun run dev
66
+ ```
67
+
68
+ Or run directly without building:
69
+
70
+ ```bash
71
+ bun run src/app.ts generate
72
+ ```