@modcafe/milkbucket 1.0.0 → 1.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.
@@ -0,0 +1,57 @@
1
+ name: Publish Package
2
+
3
+ on:
4
+ release:
5
+ types: [published]
6
+
7
+ permissions:
8
+ contents: read
9
+ id-token: write
10
+ packages: write
11
+
12
+ jobs:
13
+ publish-npm:
14
+ name: Publish to npm
15
+ runs-on: ubuntu-latest
16
+
17
+ steps:
18
+ - name: Checkout
19
+ uses: actions/checkout@v4
20
+
21
+ - name: Setup Node.js
22
+ uses: actions/setup-node@v4
23
+ with:
24
+ node-version: 24
25
+ registry-url: https://registry.npmjs.org
26
+ package-manager-cache: false
27
+
28
+ - name: Generate package-lock.json
29
+ run: npm install --package-lock-only
30
+
31
+ - name: Publish to npm
32
+ run: npm publish --access public
33
+
34
+ publish-github:
35
+ name: Publish to GitHub Packages
36
+ runs-on: ubuntu-latest
37
+ needs: publish-npm
38
+ if: ${{ always() }}
39
+
40
+ steps:
41
+ - name: Checkout
42
+ uses: actions/checkout@v4
43
+
44
+ - name: Setup Node.js
45
+ uses: actions/setup-node@v4
46
+ with:
47
+ node-version: 24
48
+ registry-url: https://npm.pkg.github.com
49
+ package-manager-cache: false
50
+
51
+ - name: Generate package-lock.json
52
+ run: npm install --package-lock-only
53
+
54
+ - name: Publish to GitHub Packages
55
+ run: npm publish --registry=https://npm.pkg.github.com
56
+ env:
57
+ NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026-present Modcafe
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -60,37 +60,15 @@ npm --version
60
60
 
61
61
  ---
62
62
 
63
- ## 2. Clone Milkbucket
63
+ ## 2. Install Milkbucket
64
64
 
65
- Clone the repository and enter its directory:
65
+ Install Milkbucket globally from npm:
66
66
 
67
67
  ```bash
68
- git clone https://github.com/Modcafe/milkbucket.git
69
- cd milkbucket
68
+ npm install -g @modcafe/milkbucket
70
69
  ```
71
70
 
72
- Then link Milkbucket as a global CLI:
73
-
74
- ```bash
75
- npm link
76
- ```
77
-
78
- ### If `npm link` fails
79
-
80
- If npm does not have permission to create the global link, configure a user-local npm directory:
81
-
82
- ```bash
83
- mkdir -p ~/.npm-global
84
- npm config set prefix ~/.npm-global
85
- echo 'export PATH="$HOME/.npm-global/bin:$PATH"' >> ~/.zshrc
86
- source ~/.zshrc
87
- ```
88
-
89
- Then run:
90
-
91
- ```bash
92
- npm link
93
- ```
71
+ Once installed, the `milkbucket` command is available globally.
94
72
 
95
73
  ---
96
74
 
@@ -148,7 +126,7 @@ milkbucket --version
148
126
 
149
127
  ---
150
128
 
151
- ## `info` (comming soon)
129
+ ## `info` (coming soon)
152
130
 
153
131
  Displays information about the current project and environment.
154
132
 
@@ -158,7 +136,7 @@ milkbucket info
158
136
 
159
137
  ---
160
138
 
161
- ## `project` (comming soon)
139
+ ## `project` (coming soon)
162
140
 
163
141
  Tools for inspecting and working with the current Minecraft project.
164
142
 
@@ -166,7 +144,7 @@ Tools for inspecting and working with the current Minecraft project.
166
144
  milkbucket project
167
145
  ```
168
146
 
169
- ### `project detect` (comming soon)
147
+ ### `project detect` (coming soon)
170
148
 
171
149
  Detects the type and configuration of the current project.
172
150
 
@@ -174,7 +152,7 @@ Detects the type and configuration of the current project.
174
152
  milkbucket project detect
175
153
  ```
176
154
 
177
- ### `project validate` (comming soon)
155
+ ### `project validate` (coming soon)
178
156
 
179
157
  Checks the current project for common configuration problems.
180
158
 
@@ -184,7 +162,7 @@ milkbucket project validate
184
162
 
185
163
  ---
186
164
 
187
- ## `build` (comming soon)
165
+ ## `build` (coming soon)
188
166
 
189
167
  Builds the current Minecraft project.
190
168
 
@@ -194,7 +172,7 @@ milkbucket build
194
172
 
195
173
  ---
196
174
 
197
- ## `deps` (comming soon)
175
+ ## `deps` (coming soon)
198
176
 
199
177
  Tools for inspecting project dependencies.
200
178
 
@@ -202,7 +180,7 @@ Tools for inspecting project dependencies.
202
180
  milkbucket deps
203
181
  ```
204
182
 
205
- ### `deps list` (comming soon)
183
+ ### `deps list` (coming soon)
206
184
 
207
185
  Lists the dependencies of the current project.
208
186
 
@@ -210,7 +188,7 @@ Lists the dependencies of the current project.
210
188
  milkbucket deps list
211
189
  ```
212
190
 
213
- ### `deps check` (comming soon)
191
+ ### `deps check` (coming soon)
214
192
 
215
193
  Checks whether the project's dependencies are valid.
216
194
 
@@ -220,7 +198,7 @@ milkbucket deps check
220
198
 
221
199
  ---
222
200
 
223
- ## `logs` (comming soon)
201
+ ## `logs` (coming soon)
224
202
 
225
203
  Tools for working with Minecraft logs.
226
204
 
@@ -228,7 +206,7 @@ Tools for working with Minecraft logs.
228
206
  milkbucket logs
229
207
  ```
230
208
 
231
- ### `logs latest` (comming soon)
209
+ ### `logs latest` (coming soon)
232
210
 
233
211
  Displays or analyzes the latest log.
234
212
 
@@ -238,7 +216,7 @@ milkbucket logs latest
238
216
 
239
217
  ---
240
218
 
241
- ## `crash` (comming soon)
219
+ ## `crash` (coming soon)
242
220
 
243
221
  Analyzes the latest Minecraft crash report.
244
222
 
@@ -248,7 +226,7 @@ milkbucket crash
248
226
 
249
227
  ---
250
228
 
251
- ## `team` (comming soon)
229
+ ## `team` (coming soon)
252
230
 
253
231
  Tools for Modcafe development teams.
254
232
 
@@ -256,7 +234,7 @@ Tools for Modcafe development teams.
256
234
  milkbucket team
257
235
  ```
258
236
 
259
- ### `team doctor` (comming soon)
237
+ ### `team doctor` (coming soon)
260
238
 
261
239
  Checks the local development environment.
262
240
 
@@ -268,16 +246,23 @@ milkbucket team doctor
268
246
 
269
247
  # Updating
270
248
 
271
- To update your local Milkbucket installation, pull the latest changes from GitHub:
249
+ Update Milkbucket directly through npm:
250
+
251
+ ```bash
252
+ npm update -g @modcafe/milkbucket
253
+ ```
254
+
255
+ To install the latest version regardless of the currently installed version:
272
256
 
273
257
  ```bash
274
- cd milkbucket
275
- git pull
276
- npm link
258
+ npm install -g @modcafe/milkbucket@latest
277
259
  ```
278
260
 
279
- > [!TIP]
280
- > You only need to configure the npm prefix once. After that, updating Milkbucket only requires `git pull` and `npm link`.
261
+ You can verify the installed version afterwards:
262
+
263
+ ```bash
264
+ milkbucket --version
265
+ ```
281
266
 
282
267
  ---
283
268
 
@@ -296,7 +281,7 @@ milkbucket/
296
281
  │ ├── version.js
297
282
  │ └── ...
298
283
  └── lib/
299
- ├── commandInfo.json
284
+ ├── commandInfo.js
300
285
  └── ...
301
286
  ```
302
287
 
@@ -306,4 +291,4 @@ New commands should be added to the `commands/` directory and registered in the
306
291
 
307
292
  # License
308
293
 
309
- Internal Modcafe tooling.
294
+ Internal Modcafe tooling. MIT.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@modcafe/milkbucket",
3
- "version": "1.0.0",
3
+ "version": "1.0.3",
4
4
  "description": "Internal CLI tool by Modcafe for developing, testing and debugging Minecraft mods and datapacks.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -1,26 +0,0 @@
1
- name: Publish to npm
2
-
3
- on:
4
- workflow_dispatch:
5
-
6
- permissions:
7
- contents: read
8
-
9
- jobs:
10
- publish:
11
- runs-on: ubuntu-latest
12
-
13
- steps:
14
- - name: Checkout
15
- uses: actions/checkout@v4
16
-
17
- - name: Setup Node.js
18
- uses: actions/setup-node@v4
19
- with:
20
- node-version: 22
21
- registry-url: https://registry.npmjs.org
22
-
23
- - name: Publish package
24
- run: npm publish --access public
25
- env:
26
- NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}