homeontour-ui 0.1.1 → 0.1.4

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 (2) hide show
  1. package/README.md +83 -6
  2. package/package.json +14 -3
package/README.md CHANGED
@@ -50,27 +50,104 @@ The CLI:
50
50
 
51
51
  ## Development
52
52
 
53
+ ### From Root Directory (Recommended)
54
+
53
55
  Build the CLI:
54
56
 
55
57
  ```bash
56
- cd cli
57
- pnpm install
58
- pnpm build
58
+ pnpm build:cli
59
59
  ```
60
60
 
61
61
  Test locally:
62
62
 
63
63
  ```bash
64
- node dist/index.js init
64
+ pnpm test:cli add logo-svg
65
+ pnpm test:cli init
66
+ ```
67
+
68
+ ### From CLI Directory
69
+
70
+ ```bash
71
+ cd cli
72
+ pnpm install
73
+ pnpm build
65
74
  node dist/index.js add logo-svg
66
75
  ```
67
76
 
68
77
  ## Publishing
69
78
 
79
+ ### From Root Directory (Recommended)
80
+
81
+ ```bash
82
+ # For bug fixes (0.1.2 → 0.1.3)
83
+ pnpm publish:cli:patch
84
+
85
+ # For new features (0.1.2 → 0.2.0)
86
+ pnpm publish:cli:minor
87
+
88
+ # For breaking changes (0.1.2 → 1.0.0)
89
+ pnpm publish:cli:major
90
+ ```
91
+
92
+ ### Publishing Workflow
93
+
94
+ 1. **Ensure you're logged in to npm:**
95
+ ```bash
96
+ npm login
97
+ ```
98
+ 2. **Make your changes** to files in `cli/src/`
99
+ 3. **Build and test:**
100
+ ```bash
101
+ pnpm build:cli
102
+ pnpm test:cli add logo-svg
103
+ ```
104
+ 4. **Publish with version bump:**
105
+ ```bash
106
+ pnpm publish:cli:patch
107
+ ```
108
+ The script will automatically check if you're logged in before publishing.
109
+ 5. **Verify it's published:**
110
+ ```bash
111
+ npm view homeontour-ui version
112
+ ```
113
+
114
+ ### Version Types
115
+
116
+ - **Patch** - Bug fixes, documentation updates (0.0.X)
117
+ - **Minor** - New features, new components (0.X.0)
118
+ - **Major** - Breaking changes (X.0.0)
119
+
120
+ ### What Happens During Publish
121
+
122
+ 1. Version is bumped in `package.json`
123
+ 2. CLI is automatically built (`prepublishOnly` hook)
124
+ 3. Package is uploaded to npm
125
+ 4. Git tag is created
126
+
127
+ ### From CLI Directory (Alternative)
128
+
70
129
  ```bash
71
130
  cd cli
72
- pnpm build
73
- npm publish
131
+ pnpm publish:patch # or publish:minor, publish:major
132
+ ```
133
+
134
+ ### Troubleshooting
135
+
136
+ **Authentication Error**
137
+
138
+ If you see `npm notice Access token expired or revoked`:
139
+
140
+ ```bash
141
+ npm login
142
+ # Follow the browser authentication flow
143
+ # Then try publishing again
144
+ ```
145
+
146
+ **Check Authentication**
147
+
148
+ ```bash
149
+ npm whoami
150
+ # Should display your npm username
74
151
  ```
75
152
 
76
153
  ## License
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "homeontour-ui",
3
- "version": "0.1.1",
3
+ "version": "0.1.4",
4
4
  "description": "CLI for adding HomeOnTour UI components to your project",
5
5
  "type": "module",
6
6
  "bin": {
@@ -12,7 +12,13 @@
12
12
  "scripts": {
13
13
  "build": "tsup",
14
14
  "dev": "tsup --watch",
15
- "typecheck": "tsc --noEmit"
15
+ "typecheck": "tsc --noEmit",
16
+ "prepublishOnly": "pnpm build",
17
+ "test:local": "node dist/index.js",
18
+ "check:auth": "npm whoami || (echo '❌ Not logged in to npm. Run: npm login' && exit 1)",
19
+ "publish:patch": "pnpm check:auth && npm version patch && npm publish",
20
+ "publish:minor": "pnpm check:auth && npm version minor && npm publish",
21
+ "publish:major": "pnpm check:auth && npm version major && npm publish"
16
22
  },
17
23
  "dependencies": {
18
24
  "commander": "^11.1.0",
@@ -39,5 +45,10 @@
39
45
  "tailwindcss"
40
46
  ],
41
47
  "author": "HomeOnTour",
42
- "license": "MIT"
48
+ "license": "MIT",
49
+ "homepage": "https://ui.homeontour.com",
50
+ "repository": {
51
+ "type": "git",
52
+ "url": "https://github.com/HomeOnTour/homeontour-ui"
53
+ }
43
54
  }