cli-kiss 0.2.0 → 0.2.1
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/.github/workflows/docs.yml +35 -0
- package/README.md +12 -1
- package/dist/index.d.ts +2 -1
- package/dist/index.js.map +1 -1
- package/docs/.vitepress/config.mts +41 -0
- package/docs/guide/01_getting_started.md +116 -0
- package/docs/guide/02_commands.md +157 -0
- package/docs/guide/03_options.md +111 -0
- package/docs/guide/04_positionals.md +118 -0
- package/docs/guide/05_types.md +134 -0
- package/docs/guide/06_run.md +161 -0
- package/docs/index.md +30 -0
- package/package.json +6 -3
- package/src/index.ts +0 -1
- package/src/lib/Run.ts +1 -1
- package/src/lib/Type.ts +1 -0
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
name: Deploy docs
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
push:
|
|
5
|
+
branches: [main]
|
|
6
|
+
|
|
7
|
+
permissions:
|
|
8
|
+
contents: read
|
|
9
|
+
pages: write
|
|
10
|
+
id-token: write
|
|
11
|
+
|
|
12
|
+
concurrency:
|
|
13
|
+
group: pages
|
|
14
|
+
cancel-in-progress: false
|
|
15
|
+
|
|
16
|
+
jobs:
|
|
17
|
+
deploy:
|
|
18
|
+
environment:
|
|
19
|
+
name: github-pages
|
|
20
|
+
url: ${{ steps.deployment.outputs.page_url }}
|
|
21
|
+
runs-on: ubuntu-latest
|
|
22
|
+
steps:
|
|
23
|
+
- uses: actions/checkout@v4
|
|
24
|
+
- uses: actions/setup-node@v4
|
|
25
|
+
with:
|
|
26
|
+
node-version: lts/*
|
|
27
|
+
cache: npm
|
|
28
|
+
- run: npm i
|
|
29
|
+
- run: npm run docs:build
|
|
30
|
+
- uses: actions/configure-pages@v5
|
|
31
|
+
- uses: actions/upload-pages-artifact@v3
|
|
32
|
+
with:
|
|
33
|
+
path: docs/.vitepress/dist
|
|
34
|
+
- uses: actions/deploy-pages@v4
|
|
35
|
+
id: deployment
|
package/README.md
CHANGED
|
@@ -1,3 +1,14 @@
|
|
|
1
1
|
# CLI - Keep It Simple, Stupid
|
|
2
2
|
|
|
3
|
-
No bloat, no dependency
|
|
3
|
+
Full-featured CLI builder for TypeScript. No bloat, no dependency.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install cli-kiss
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Cookbook
|
|
12
|
+
|
|
13
|
+
Full documentation and examples: **https://crypto-vincent.github.io/cli-kiss/**
|
|
14
|
+
💋
|
package/dist/index.d.ts
CHANGED
|
@@ -195,6 +195,7 @@ declare const typeBoolean: Type<boolean>;
|
|
|
195
195
|
* @example
|
|
196
196
|
* ```ts
|
|
197
197
|
* typeDate.decoder("2024-01-15") // → Date object for 2024-01-15
|
|
198
|
+
* typeDate.decoder("2024-01-15T13:45:30Z") // → Date object for 2024-01-15 13:45:30 UTC
|
|
198
199
|
* typeDate.decoder("not a date") // throws TypoError
|
|
199
200
|
* ```
|
|
200
201
|
*/
|
|
@@ -1177,7 +1178,7 @@ declare function commandChained<Context, Payload, Result>(information: CommandIn
|
|
|
1177
1178
|
* - `1` — Argument parsing failed (a usage summary is also printed to stderr), or the
|
|
1178
1179
|
* command threw an unhandled execution error.
|
|
1179
1180
|
*
|
|
1180
|
-
* **Built-in flags
|
|
1181
|
+
* **Built-in flags:**
|
|
1181
1182
|
* - `--help` — Enabled by default (`usageOnHelp: true`). Prints the usage summary to
|
|
1182
1183
|
* stdout and exits with code `0`. This flag takes precedence over `--version`.
|
|
1183
1184
|
* - `--version` — Enabled when `buildVersion` is provided. Prints `<cliName> <version>`
|