Skip to content

Commit a5633b9

Browse files
committed
Use updated readme-cli-help functionality.
1 parent d21b1ca commit a5633b9

File tree

5 files changed

+32
-6
lines changed

5 files changed

+32
-6
lines changed

.config/readme-cli-help.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"files": {
3+
"./README.md": {
4+
"blocks": [
5+
{
6+
"fence": "text help",
7+
"command": ["bun", "run", "src/cli/main.ts", "--help"]
8+
}
9+
]
10+
}
11+
}
12+
}

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ publish:
2020

2121
.PHONY: update-readme-cli-help
2222
update-readme-cli-help: setup
23-
bun x readme-cli-help "bun run src/cli/main.ts --help"
23+
bun x readme-cli-help update
2424

2525
.PHONY: check-readme-cli-help
2626
check-readme-cli-help: setup
27-
bun x readme-cli-help --check-only "bun run src/cli/main.ts --help"
27+
bun x readme-cli-help check
2828

2929
.PHONY: setup
3030
setup:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ bun x @cubing/deploy
2828

2929
## Help
3030

31-
````cli-help
31+
````text help
3232
Usage: npx @cubing/deploy (or: bun x @cubing/deploy)
3333
3434
Deploy to a shared host like Dreamhost with minimal configuration.

bun.lock

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"@types/bun": "^1.3.2",
1515
"@types/node": "^24.10.1",
1616
"esbuild": "^0.27.0",
17-
"readme-cli-help": "^0.1.10",
17+
"readme-cli-help": ">=0.4.1",
1818
"typescript": "^5.9.3",
1919
},
2020
},
@@ -92,6 +92,10 @@
9292

9393
"@esbuild/win32-x64": ["@esbuild/[email protected]", "", { "os": "win32", "cpu": "x64" }, "sha512-aIitBcjQeyOhMTImhLZmtxfdOcuNRpwlPNmlFKPcHQYPhEssw75Cl1TSXJXpMkzaua9FUetx/4OQKq7eJul5Cg=="],
9494

95+
"@optique/core": ["@optique/[email protected]", "", {}, "sha512-iYRMBHfJXXcCZlEu9i2hGdCa87ts4Twt+UJKQC3weWIz10uxDkA4bSeSiS/CFZJR+9kHPLXZeMmYO9TmKdOgIg=="],
96+
97+
"@optique/run": ["@optique/[email protected]", "", { "dependencies": { "@optique/core": "0.7.2" } }, "sha512-Z9yow3TxKZtkXYH+OtYJe6sfZufTQAvsW2KEtP1C8GheH+i3lBabyFaO8OCjcGlC18eUo2MhQzqvAp1Jf7OrKQ=="],
98+
9599
"@types/bun": ["@types/[email protected]", "", { "dependencies": { "bun-types": "1.3.2" } }, "sha512-t15P7k5UIgHKkxwnMNkJbWlh/617rkDGEdSsDbu+qNHTaz9SKf7aC8fiIlUdD5RPpH6GEkP0cK7WlvmrEBRtWg=="],
96100

97101
"@types/node": ["@types/[email protected]", "", { "dependencies": { "undici-types": "~7.16.0" } }, "sha512-GNWcUTRBgIRJD5zj+Tq0fKOJ5XZajIiBroOF0yvj2bSU1WvNdYS/dn9UxwsujGW4JX06dnHyjV2y9rRaybH0iQ=="],
@@ -106,9 +110,11 @@
106110

107111
"path-class": ["[email protected]", "", { "dependencies": { "@types/node": "^24.7.1", "readme-cli-help": "^0.1.10", "xdg-basedir": "^5.1.0" } }, "sha512-ThXv7G7y5PXDbY3hE2x9M57HvNh4pGL9Odl/gXh1WlpOerbN7ByZ0hDEDxVPpg5d9YwLONfCqEowElZsQEaIzQ=="],
108112

113+
"plural-chain": ["[email protected]", "", {}, "sha512-MTAkLYFtZL+yoFjYzUbsl3fiXftB16MS2AS9MLxApJIgv91neiu65LK/Jg3LNpah/38JErt2NrJsmYdpO1hiLQ=="],
114+
109115
"printable-shell-command": ["[email protected]", "", { "dependencies": { "path-class": ">=0.6.1", "type-fest": ">=5.1.0" }, "optionalDependencies": { "@types/bun": "^1.2.20", "@types/node": "^24.2.0" } }, "sha512-u49zQsdil1clG2RKs+PQvoU64FfRXziMi8cTjrL7Cv92q1eYwyNnHM9PAux0qIme2ucWxn3gIYshkXhyS54y5A=="],
110116

111-
"readme-cli-help": ["readme-cli-help@0.1.10", "", { "peerDependencies": { "typescript": "^5.0.0" }, "bin": { "readme-cli-help": "main.ts" } }, "sha512-HBu72nVFqoLIBtEQJo1bC+z9zPqz1D84pPSS9mjGPS35AFAoW0Qif7TJVotIpToWVwmjljF0EXeo9Qgy3KbxxQ=="],
117+
"readme-cli-help": ["readme-cli-help@0.4.1", "", { "dependencies": { "@optique/core": ">=0.7.2", "@optique/run": ">=0.7.2", "path-class": ">=0.10.2", "plural-chain": "^0.2.1", "printable-shell-command": "^2.7.3" }, "bin": { "readme-cli-help": "src/main.ts" } }, "sha512-520r0rKgNzDCtaiVV6zfaO0EWeb6n9bNi+vO53MgHnBe2HJWAOHO1ev0Pye9Cl2BShx8IPhKQf3iaKkw/xcWaQ=="],
112118

113119
"tagged-tag": ["[email protected]", "", {}, "sha512-yEFYrVhod+hdNyx7g5Bnkkb0G6si8HJurOoOEgC8B/O0uXLHlaey/65KRv6cuWBNhBgHKAROVpc7QyYqE5gFng=="],
114120

@@ -120,6 +126,14 @@
120126

121127
"xdg-basedir": ["[email protected]", "", {}, "sha512-GCPAHLvrIH13+c0SuacwvRYj2SxJXQ4kaVTT5xgL3kPrz56XxkF21IGhjSE1+W0aw7gpBWRGXLCPnPby6lSpmQ=="],
122128

129+
"path-class/readme-cli-help": ["[email protected]", "", { "peerDependencies": { "typescript": "^5.0.0" }, "bin": { "readme-cli-help": "main.ts" } }, "sha512-HBu72nVFqoLIBtEQJo1bC+z9zPqz1D84pPSS9mjGPS35AFAoW0Qif7TJVotIpToWVwmjljF0EXeo9Qgy3KbxxQ=="],
130+
123131
"printable-shell-command/path-class": ["[email protected]", "", { "dependencies": { "@types/node": "^24.7.1", "xdg-basedir": "^5.1.0" } }, "sha512-vXj1HNmjXZTSPNLaFStTCAIFlMVls9TW44lpI+CFeFbP7vZu7hvQ76ObHABm88NcWrizYQcqqOWeHRnc1TRZtA=="],
132+
133+
"readme-cli-help/path-class": ["[email protected]", "", { "dependencies": { "@types/node": "^24.7.1", "readme-cli-help": ">=0.3.1", "xdg-basedir": "^5.1.0" } }, "sha512-5NxurdtQiVkRdB1m738O7s1eQQdLr9VGPbRWsUDs2hqEEqhfENcgbQHC+s5zczhwtAzppmrB8VHijJi5NwE2Sg=="],
134+
135+
"readme-cli-help/printable-shell-command": ["[email protected]", "", { "dependencies": { "path-class": ">=0.6.1", "type-fest": ">=5.1.0" }, "optionalDependencies": { "@types/bun": "^1.2.20", "@types/node": "^24.2.0" } }, "sha512-dze0g2XUiBTp6EGd5kPSR2i422sabXWFjnk8qOqxbeUCxcNMNDjA2Z3XYq/8ZL6GmS7nhc/HjtRFXBvRP3c03A=="],
136+
137+
"readme-cli-help/path-class/readme-cli-help": ["[email protected]", "", { "dependencies": { "@optique/core": ">=0.7.2", "@optique/run": ">=0.7.2", "path-class": ">=0.10.2", "plural-chain": "^0.2.1", "printable-shell-command": "^2.7.3" }, "bin": { "readme-cli-help": "src/main.ts" } }, "sha512-606vRZWMDm1K1zeYC9GxOUqTOUNmUFBRDKwISuy57MNwVO4Uffr5eSP2ozjliTf3YJQ5V2NSNJs5GuEV0TN2+w=="],
124138
}
125139
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
"@types/bun": "^1.3.2",
2020
"@types/node": "^24.10.1",
2121
"esbuild": "^0.27.0",
22-
"readme-cli-help": "^0.1.10",
22+
"readme-cli-help": ">=0.4.1",
2323
"typescript": "^5.9.3"
2424
},
2525
"@cubing/deploy": {

0 commit comments

Comments
 (0)