@kjanat/dreamcli 4.0.0-rc.3 → 4.0.0
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/README.md +5 -7
- package/dist/{runtime/adapter.d.mts → adapter-D0hbBNVB.d.mts} +2 -4
- package/dist/completion-D4mz6axB.mjs +6 -0
- package/dist/completion.d.mts +90 -0
- package/dist/completion.mjs +1 -0
- package/dist/config-B9ddC-Kb.mjs +1 -0
- package/dist/config.d.mts +2 -0
- package/dist/config.mjs +1 -0
- package/dist/core-Cp2w8vRq.mjs +17 -0
- package/dist/index-BziI2aKc.d.mts +5440 -0
- package/dist/index-DOfClfYR.d.mts +370 -0
- package/dist/index-DWsnGZlx.d.mts +831 -0
- package/dist/{core/cli/index.d.mts → index-DXROeDPC.d.mts} +116 -57
- package/dist/index-DndPmT8J.d.mts +275 -0
- package/dist/{core/json-schema/index.d.mts → index-DyoaS234.d.mts} +43 -34
- package/dist/index.d.mts +190 -41
- package/dist/index.mjs +1 -26
- package/dist/json-schema-C9SzZ7jY.mjs +52 -0
- package/dist/json-schema.d.mts +2 -0
- package/dist/json-schema.mjs +1 -0
- package/dist/package-json-BgE9YjjQ.mjs +3 -0
- package/dist/prompt.d.mts +48 -0
- package/dist/prompt.mjs +1 -0
- package/dist/rolldown-runtime-G4Kt5YOX.mjs +1 -0
- package/dist/runtime.d.mts +2 -6
- package/dist/runtime.mjs +1 -6
- package/dist/terminal-C8KTXjv5.mjs +6 -0
- package/dist/test-prompter-v__jT2yG.mjs +1 -0
- package/dist/testkit.d.mts +54 -6
- package/dist/testkit.mjs +1 -5
- package/dist/version.mjs +1 -7
- package/dreamcli.schema.json +697 -538
- package/package.json +29 -7
- package/skills/cli-creation/SKILL.md +16 -11
- package/CHANGELOG.md +0 -1116
- package/dist/core/cli/builtins.d.mts +0 -117
- package/dist/core/cli/builtins.mjs +0 -135
- package/dist/core/cli/compiled.d.mts +0 -66
- package/dist/core/cli/compiled.mjs +0 -76
- package/dist/core/cli/dispatch.d.mts +0 -115
- package/dist/core/cli/dispatch.mjs +0 -205
- package/dist/core/cli/help-links.d.mts +0 -27
- package/dist/core/cli/help-links.mjs +0 -41
- package/dist/core/cli/index.mjs +0 -1271
- package/dist/core/cli/planner.d.mts +0 -174
- package/dist/core/cli/planner.mjs +0 -323
- package/dist/core/cli/plugin.d.mts +0 -94
- package/dist/core/cli/plugin.mjs +0 -41
- package/dist/core/cli/propagate.d.mts +0 -39
- package/dist/core/cli/propagate.mjs +0 -57
- package/dist/core/cli/reserved-flags.d.mts +0 -19
- package/dist/core/cli/reserved-flags.mjs +0 -158
- package/dist/core/cli/root-help.d.mts +0 -53
- package/dist/core/cli/root-help.mjs +0 -221
- package/dist/core/cli/root-output-flags.d.mts +0 -74
- package/dist/core/cli/root-output-flags.mjs +0 -169
- package/dist/core/cli/root-surface.d.mts +0 -64
- package/dist/core/cli/root-surface.mjs +0 -28
- package/dist/core/cli/runtime-preflight.d.mts +0 -213
- package/dist/core/cli/runtime-preflight.mjs +0 -221
- package/dist/core/completion/index.d.mts +0 -76
- package/dist/core/completion/index.mjs +0 -90
- package/dist/core/completion/shells/bash.d.mts +0 -23
- package/dist/core/completion/shells/bash.mjs +0 -312
- package/dist/core/completion/shells/fish.d.mts +0 -19
- package/dist/core/completion/shells/fish.mjs +0 -164
- package/dist/core/completion/shells/powershell.d.mts +0 -13
- package/dist/core/completion/shells/powershell.mjs +0 -360
- package/dist/core/completion/shells/shared.d.mts +0 -164
- package/dist/core/completion/shells/shared.mjs +0 -147
- package/dist/core/completion/shells/zsh.d.mts +0 -23
- package/dist/core/completion/shells/zsh.mjs +0 -256
- package/dist/core/config/index.d.mts +0 -191
- package/dist/core/config/index.mjs +0 -285
- package/dist/core/config/package-json.d.mts +0 -179
- package/dist/core/config/package-json.mjs +0 -353
- package/dist/core/errors/index.d.mts +0 -125
- package/dist/core/errors/index.mjs +0 -87
- package/dist/core/execution/index.d.mts +0 -61
- package/dist/core/execution/index.mjs +0 -220
- package/dist/core/help/ansi.d.mts +0 -84
- package/dist/core/help/ansi.mjs +0 -121
- package/dist/core/help/index.d.mts +0 -149
- package/dist/core/help/index.mjs +0 -418
- package/dist/core/help/theme.d.mts +0 -86
- package/dist/core/help/theme.mjs +0 -69
- package/dist/core/json-schema/index.mjs +0 -1008
- package/dist/core/json-schema/meta-descriptions.generated.d.mts +0 -274
- package/dist/core/json-schema/meta-descriptions.generated.mjs +0 -136
- package/dist/core/output/activity.d.mts +0 -193
- package/dist/core/output/activity.mjs +0 -452
- package/dist/core/output/bind.d.mts +0 -37
- package/dist/core/output/bind.mjs +0 -56
- package/dist/core/output/contracts.d.mts +0 -82
- package/dist/core/output/contracts.mjs +0 -57
- package/dist/core/output/display-value.d.mts +0 -19
- package/dist/core/output/display-value.mjs +0 -32
- package/dist/core/output/index.d.mts +0 -344
- package/dist/core/output/index.mjs +0 -514
- package/dist/core/output/renderers.d.mts +0 -45
- package/dist/core/output/renderers.mjs +0 -46
- package/dist/core/output/writer.d.mts +0 -39
- package/dist/core/output/writer.mjs +0 -12
- package/dist/core/parse/index.d.mts +0 -178
- package/dist/core/parse/index.mjs +0 -850
- package/dist/core/parse/occurrences.d.mts +0 -90
- package/dist/core/parse/occurrences.mjs +0 -114
- package/dist/core/prompt/index.d.mts +0 -213
- package/dist/core/prompt/index.mjs +0 -348
- package/dist/core/read-flags/index.d.mts +0 -150
- package/dist/core/read-flags/index.mjs +0 -217
- package/dist/core/resolve/args.d.mts +0 -39
- package/dist/core/resolve/args.mjs +0 -182
- package/dist/core/resolve/coerce.d.mts +0 -79
- package/dist/core/resolve/coerce.mjs +0 -900
- package/dist/core/resolve/config.d.mts +0 -10
- package/dist/core/resolve/config.mjs +0 -19
- package/dist/core/resolve/contracts.d.mts +0 -146
- package/dist/core/resolve/errors.d.mts +0 -10
- package/dist/core/resolve/errors.mjs +0 -148
- package/dist/core/resolve/flags.d.mts +0 -74
- package/dist/core/resolve/flags.mjs +0 -246
- package/dist/core/resolve/index.d.mts +0 -44
- package/dist/core/resolve/index.mjs +0 -123
- package/dist/core/resolve/path-checks.d.mts +0 -48
- package/dist/core/resolve/path-checks.mjs +0 -102
- package/dist/core/resolve/redaction.d.mts +0 -13
- package/dist/core/resolve/redaction.mjs +0 -14
- package/dist/core/resolve/stages.d.mts +0 -86
- package/dist/core/resolve/stages.mjs +0 -170
- package/dist/core/resolve/standard.d.mts +0 -26
- package/dist/core/resolve/standard.mjs +0 -212
- package/dist/core/schema/activity.d.mts +0 -189
- package/dist/core/schema/arg.d.mts +0 -1461
- package/dist/core/schema/arg.mjs +0 -1139
- package/dist/core/schema/brand.d.mts +0 -17
- package/dist/core/schema/cardinality.d.mts +0 -302
- package/dist/core/schema/cardinality.mjs +0 -514
- package/dist/core/schema/command.d.mts +0 -1132
- package/dist/core/schema/command.mjs +0 -999
- package/dist/core/schema/flag.d.mts +0 -1495
- package/dist/core/schema/flag.mjs +0 -1207
- package/dist/core/schema/index.d.mts +0 -15
- package/dist/core/schema/index.mjs +0 -10
- package/dist/core/schema/middleware.d.mts +0 -129
- package/dist/core/schema/middleware.mjs +0 -41
- package/dist/core/schema/number-constraints.d.mts +0 -96
- package/dist/core/schema/number-constraints.mjs +0 -60
- package/dist/core/schema/prompt.d.mts +0 -135
- package/dist/core/schema/provenance.d.mts +0 -99
- package/dist/core/schema/provenance.mjs +0 -28
- package/dist/core/schema/run.d.mts +0 -211
- package/dist/core/schema/source.d.mts +0 -180
- package/dist/core/schema/source.mjs +0 -206
- package/dist/core/schema/standard.d.mts +0 -100
- package/dist/core/schema/standard.mjs +0 -15
- package/dist/core/schema/stdin.d.mts +0 -97
- package/dist/core/schema/stdin.mjs +0 -91
- package/dist/core/schema/string-constraints.d.mts +0 -108
- package/dist/core/schema/string-constraints.mjs +0 -86
- package/dist/core/schema/value-parsers.d.mts +0 -150
- package/dist/core/schema/value-parsers.mjs +0 -160
- package/dist/core/schema/value.d.mts +0 -243
- package/dist/core/schema/value.mjs +0 -573
- package/dist/core/testkit/index.d.mts +0 -63
- package/dist/core/testkit/index.mjs +0 -102
- package/dist/runtime/adapter.mjs +0 -92
- package/dist/runtime/auto.d.mts +0 -25
- package/dist/runtime/auto.mjs +0 -45
- package/dist/runtime/deno.d.mts +0 -99
- package/dist/runtime/deno.mjs +0 -265
- package/dist/runtime/detect.d.mts +0 -86
- package/dist/runtime/detect.mjs +0 -45
- package/dist/runtime/index.d.mts +0 -6
- package/dist/runtime/node.d.mts +0 -71
- package/dist/runtime/node.mjs +0 -228
- package/dist/runtime/paths.d.mts +0 -31
- package/dist/runtime/paths.mjs +0 -48
- package/dist/strings.d.mts +0 -27
- package/dist/strings.mjs +0 -22
- package/examples/basic.ts +0 -37
- package/examples/flag-types.ts +0 -79
- package/examples/gh/package.json +0 -45
- package/examples/gh/src/commands/auth.ts +0 -66
- package/examples/gh/src/commands/issue.ts +0 -120
- package/examples/gh/src/commands/pr.ts +0 -125
- package/examples/gh/src/data/issues.yaml +0 -5
- package/examples/gh/src/data/issues.yaml.d.ts +0 -17
- package/examples/gh/src/data/pull-requests.yaml +0 -7
- package/examples/gh/src/data/pull-requests.yaml.d.ts +0 -18
- package/examples/gh/src/docs.ts +0 -11
- package/examples/gh/src/lib/auth.ts +0 -37
- package/examples/gh/src/lib/utils.ts +0 -17
- package/examples/gh/src/main.test.ts +0 -307
- package/examples/gh/src/main.ts +0 -46
- package/examples/help-config.ts +0 -43
- package/examples/interactive.ts +0 -67
- package/examples/json-mode.ts +0 -95
- package/examples/middleware.ts +0 -71
- package/examples/multi-command.ts +0 -66
- package/examples/output-extras.ts +0 -46
- package/examples/parser-control.ts +0 -40
- package/examples/pwsh-demo/README.md +0 -40
- package/examples/pwsh-demo/package.json +0 -41
- package/examples/pwsh-demo/pwsh-demo.cmd +0 -3
- package/examples/pwsh-demo/smoke-powershell.ps1 +0 -218
- package/examples/pwsh-demo/src/main.test.ts +0 -45
- package/examples/pwsh-demo/src/main.ts +0 -140
- package/examples/spinner-progress.ts +0 -49
- package/examples/standard-schema.ts +0 -45
- package/examples/testing.ts +0 -147
- package/examples/transport-launcher.ts +0 -85
package/examples/gh/package.json
DELETED
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "gh",
|
|
3
|
-
"version": "0.0.0-example",
|
|
4
|
-
"private": true,
|
|
5
|
-
"description": "A minimal GitHub CLI clone — dreamcli walkthrough example",
|
|
6
|
-
"repository": {
|
|
7
|
-
"type": "git",
|
|
8
|
-
"url": "git+https://github.com/kjanat/dreamcli.git",
|
|
9
|
-
"directory": "examples/gh"
|
|
10
|
-
},
|
|
11
|
-
"type": "module",
|
|
12
|
-
"module": "src/main.ts",
|
|
13
|
-
"bin": "src/main.ts",
|
|
14
|
-
"files": ["src", "!src/**/*.test.ts"],
|
|
15
|
-
"scripts": {
|
|
16
|
-
"bd": "bun run build",
|
|
17
|
-
"build": "bun build src/main.ts --install --outdir=dist --format=esm --target=node --external @kjanat/dreamcli",
|
|
18
|
-
"test": "bun test",
|
|
19
|
-
"typecheck": "tsc --noEmit"
|
|
20
|
-
},
|
|
21
|
-
"dependencies": {
|
|
22
|
-
"@kjanat/dreamcli": "file:../.."
|
|
23
|
-
},
|
|
24
|
-
"devDependencies": {
|
|
25
|
-
"@types/bun": "latest",
|
|
26
|
-
"typescript": "latest"
|
|
27
|
-
},
|
|
28
|
-
"engines": {
|
|
29
|
-
"bun": "^1.3"
|
|
30
|
-
},
|
|
31
|
-
"devEngines": {
|
|
32
|
-
"runtime": {
|
|
33
|
-
"name": "bun",
|
|
34
|
-
"version": "^1.3",
|
|
35
|
-
"onFail": "error"
|
|
36
|
-
},
|
|
37
|
-
"packageManager": [
|
|
38
|
-
{
|
|
39
|
-
"name": "bun",
|
|
40
|
-
"onFail": "error",
|
|
41
|
-
"version": "^1.3"
|
|
42
|
-
}
|
|
43
|
-
]
|
|
44
|
-
}
|
|
45
|
-
}
|
|
@@ -1,66 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Authentication commands for the walkthrough `gh` example.
|
|
3
|
-
*
|
|
4
|
-
* @module
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
import { command, group } from '@kjanat/dreamcli';
|
|
8
|
-
|
|
9
|
-
import { redactToken, requireAuth, tokenFlag } from '../lib/auth.ts';
|
|
10
|
-
|
|
11
|
-
const authLogin = command('login')
|
|
12
|
-
.description('Authenticate with GitHub')
|
|
13
|
-
.flag(
|
|
14
|
-
'token',
|
|
15
|
-
tokenFlag('Authentication token')
|
|
16
|
-
.required()
|
|
17
|
-
.prompt({ kind: 'input', message: 'Paste your GitHub token:' }),
|
|
18
|
-
)
|
|
19
|
-
.action(({ flags, out }) => {
|
|
20
|
-
const { token } = requireAuth(flags.token);
|
|
21
|
-
const login = {
|
|
22
|
-
host: 'github.com',
|
|
23
|
-
token: redactToken(token),
|
|
24
|
-
storedAt: '~/.config/gh/config.json',
|
|
25
|
-
};
|
|
26
|
-
|
|
27
|
-
if (out.jsonMode) {
|
|
28
|
-
out.json(login);
|
|
29
|
-
return;
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
// In a real CLI, validate the token via API and write to config.
|
|
33
|
-
out.log(`Logged in with token ${login.token}`);
|
|
34
|
-
out.info(`Token would be saved to ${login.storedAt}`);
|
|
35
|
-
});
|
|
36
|
-
|
|
37
|
-
const authStatus = command('status')
|
|
38
|
-
.description('Show authentication status')
|
|
39
|
-
.flag('token', tokenFlag())
|
|
40
|
-
.action(({ flags, out }) => {
|
|
41
|
-
const token = flags.token?.trim();
|
|
42
|
-
const status =
|
|
43
|
-
token === undefined || token.length === 0
|
|
44
|
-
? { authenticated: false, host: 'github.com' }
|
|
45
|
-
: { authenticated: true, host: 'github.com', token: redactToken(token) };
|
|
46
|
-
|
|
47
|
-
if (out.jsonMode) {
|
|
48
|
-
out.json(status);
|
|
49
|
-
return;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
if (status.authenticated) {
|
|
53
|
-
out.log(status.host);
|
|
54
|
-
out.log(`Logged in with token ${status.token}`);
|
|
55
|
-
return;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
out.warn('Not logged in. Run `gh auth login`.');
|
|
59
|
-
});
|
|
60
|
-
|
|
61
|
-
export { authLogin, authStatus };
|
|
62
|
-
|
|
63
|
-
export const auth = group('auth')
|
|
64
|
-
.description('Manage authentication')
|
|
65
|
-
.command(authLogin)
|
|
66
|
-
.command(authStatus);
|
|
@@ -1,120 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Issue commands for the walkthrough `gh` example.
|
|
3
|
-
*
|
|
4
|
-
* @module
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
import { arg, CLIError, flag, group } from '@kjanat/dreamcli';
|
|
8
|
-
|
|
9
|
-
import issues from '../data/issues.yaml' with { type: 'yaml' };
|
|
10
|
-
import { authedCommand } from '../lib/auth.ts';
|
|
11
|
-
import { normalizeLimit } from '../lib/utils.ts';
|
|
12
|
-
|
|
13
|
-
const issueLabelChoices = Array.from(new Set(issues.flatMap((issue) => issue.labels)))
|
|
14
|
-
.sort()
|
|
15
|
-
.map((label) => ({ value: label }));
|
|
16
|
-
|
|
17
|
-
const issueList = authedCommand('list')
|
|
18
|
-
.description('List issues')
|
|
19
|
-
.flag(
|
|
20
|
-
'state',
|
|
21
|
-
flag.enum(['open', 'closed', 'all']).default('open').alias('s').describe('Filter by state'),
|
|
22
|
-
)
|
|
23
|
-
.flag('limit', flag.number().default(10).alias('L').describe('Maximum number of results'))
|
|
24
|
-
.flag('label', flag.string().alias('l').describe('Filter by label'))
|
|
25
|
-
.action(({ flags, out }) => {
|
|
26
|
-
let results = [...issues];
|
|
27
|
-
|
|
28
|
-
if (flags.state !== 'all') {
|
|
29
|
-
results = results.filter((issue) => issue.state === flags.state);
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
if (flags.label !== undefined) {
|
|
33
|
-
const label = flags.label;
|
|
34
|
-
results = results.filter((issue) => issue.labels.includes(label));
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
results = results.slice(0, normalizeLimit(flags.limit));
|
|
38
|
-
|
|
39
|
-
out.table(
|
|
40
|
-
results.map((issue) => ({
|
|
41
|
-
'#': issue.number,
|
|
42
|
-
title: issue.title,
|
|
43
|
-
state: issue.state,
|
|
44
|
-
author: issue.author,
|
|
45
|
-
})),
|
|
46
|
-
);
|
|
47
|
-
});
|
|
48
|
-
|
|
49
|
-
const issueTriage = authedCommand('triage')
|
|
50
|
-
.description('Triage an issue with guided prompts')
|
|
51
|
-
.arg('number', arg.number().describe('Issue number'))
|
|
52
|
-
.flag('decision', flag.enum(['backlog', 'close']).required().describe('How to handle the issue'))
|
|
53
|
-
.flag('label', flag.array(flag.string()).describe('Labels to keep when leaving the issue open'))
|
|
54
|
-
.flag('comment', flag.boolean().describe('Post a follow-up comment'))
|
|
55
|
-
.interactive(({ flags }) => {
|
|
56
|
-
const labels = flags.label ?? [];
|
|
57
|
-
|
|
58
|
-
return {
|
|
59
|
-
label:
|
|
60
|
-
flags.decision === 'backlog' && labels.length === 0
|
|
61
|
-
? {
|
|
62
|
-
kind: 'multiselect',
|
|
63
|
-
message: 'Which labels still fit?',
|
|
64
|
-
choices: issueLabelChoices,
|
|
65
|
-
}
|
|
66
|
-
: false,
|
|
67
|
-
comment:
|
|
68
|
-
flags.decision === 'close' && !flags.comment
|
|
69
|
-
? { kind: 'confirm', message: 'Post a follow-up comment?' }
|
|
70
|
-
: false,
|
|
71
|
-
};
|
|
72
|
-
})
|
|
73
|
-
.action(({ args, flags, out }) => {
|
|
74
|
-
const issue = issues.find((candidate) => candidate.number === args.number);
|
|
75
|
-
|
|
76
|
-
if (!issue) {
|
|
77
|
-
throw new CLIError(`Issue #${args.number} not found`, {
|
|
78
|
-
code: 'NOT_FOUND',
|
|
79
|
-
exitCode: 1,
|
|
80
|
-
suggest: 'Try: gh issue list',
|
|
81
|
-
details: { requested: args.number },
|
|
82
|
-
});
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
const selectedLabels = flags.label ?? [];
|
|
86
|
-
const labels =
|
|
87
|
-
flags.decision === 'backlog' && selectedLabels.length > 0 ? selectedLabels : issue.labels;
|
|
88
|
-
const triage = {
|
|
89
|
-
number: issue.number,
|
|
90
|
-
title: issue.title,
|
|
91
|
-
decision: flags.decision,
|
|
92
|
-
state: flags.decision === 'close' ? 'closed' : 'open',
|
|
93
|
-
labels,
|
|
94
|
-
commented: flags.decision === 'close' ? (flags.comment ?? false) : false,
|
|
95
|
-
};
|
|
96
|
-
|
|
97
|
-
if (out.jsonMode) {
|
|
98
|
-
out.json(triage);
|
|
99
|
-
return;
|
|
100
|
-
}
|
|
101
|
-
|
|
102
|
-
out.log(`#${triage.number} ${triage.title}`);
|
|
103
|
-
if (triage.decision === 'close') {
|
|
104
|
-
out.log('Status: closed');
|
|
105
|
-
if (triage.commented) {
|
|
106
|
-
out.info('Would post a follow-up comment');
|
|
107
|
-
}
|
|
108
|
-
return;
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
out.log('Status: open (backlog)');
|
|
112
|
-
out.log(`Labels: ${triage.labels.length > 0 ? triage.labels.join(', ') : 'none'}`);
|
|
113
|
-
});
|
|
114
|
-
|
|
115
|
-
export { issueList, issueTriage };
|
|
116
|
-
|
|
117
|
-
export const issue = group('issue')
|
|
118
|
-
.description('Manage issues')
|
|
119
|
-
.command(issueList)
|
|
120
|
-
.command(issueTriage);
|
|
@@ -1,125 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Pull request commands for the walkthrough `gh` example.
|
|
3
|
-
*
|
|
4
|
-
* @module
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
import { arg, CLIError, flag, group } from '@kjanat/dreamcli';
|
|
8
|
-
|
|
9
|
-
import pullRequests from '../data/pull-requests.yaml' with { type: 'yaml' };
|
|
10
|
-
import { authedCommand } from '../lib/auth.ts';
|
|
11
|
-
import { normalizeLimit, sleep } from '../lib/utils.ts';
|
|
12
|
-
|
|
13
|
-
const prList = authedCommand('list')
|
|
14
|
-
.description('List pull requests')
|
|
15
|
-
.flag(
|
|
16
|
-
'state',
|
|
17
|
-
flag
|
|
18
|
-
.enum(['open', 'closed', 'merged', 'all'])
|
|
19
|
-
.default('open')
|
|
20
|
-
.alias('s')
|
|
21
|
-
.describe('Filter by state'),
|
|
22
|
-
)
|
|
23
|
-
.flag('limit', flag.number().default(10).alias('L').describe('Maximum number of results'))
|
|
24
|
-
.flag('label', flag.string().alias('l').describe('Filter by label'))
|
|
25
|
-
.action(({ flags, out }) => {
|
|
26
|
-
let results = [...pullRequests];
|
|
27
|
-
|
|
28
|
-
if (flags.state !== 'all') {
|
|
29
|
-
results = results.filter((pr) => pr.state === flags.state);
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
if (flags.label !== undefined) {
|
|
33
|
-
const label = flags.label;
|
|
34
|
-
results = results.filter((pr) => pr.labels.includes(label));
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
results = results.slice(0, normalizeLimit(flags.limit));
|
|
38
|
-
|
|
39
|
-
out.table(
|
|
40
|
-
results.map((pr) => ({
|
|
41
|
-
'#': pr.number,
|
|
42
|
-
title: pr.title,
|
|
43
|
-
state: pr.state,
|
|
44
|
-
author: pr.author,
|
|
45
|
-
})),
|
|
46
|
-
);
|
|
47
|
-
});
|
|
48
|
-
|
|
49
|
-
const prView = authedCommand('view')
|
|
50
|
-
.description('View a pull request')
|
|
51
|
-
.arg('number', arg.number().describe('PR number'))
|
|
52
|
-
.action(({ args, out }) => {
|
|
53
|
-
const pr = pullRequests.find((candidate) => candidate.number === args.number);
|
|
54
|
-
|
|
55
|
-
if (!pr) {
|
|
56
|
-
throw new CLIError(`Pull request #${args.number} not found`, {
|
|
57
|
-
code: 'NOT_FOUND',
|
|
58
|
-
exitCode: 1,
|
|
59
|
-
suggest: 'Try: gh pr list',
|
|
60
|
-
details: { requested: args.number },
|
|
61
|
-
});
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
if (out.jsonMode) {
|
|
65
|
-
out.json(pr);
|
|
66
|
-
return;
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
out.log(`\
|
|
70
|
-
#${pr.number} ${pr.title}
|
|
71
|
-
State: ${pr.state} Author: ${pr.author} Draft: ${String(pr.draft)}
|
|
72
|
-
Labels: ${pr.labels.join(', ')}`);
|
|
73
|
-
});
|
|
74
|
-
|
|
75
|
-
const prCreate = authedCommand('create')
|
|
76
|
-
.description('Create a pull request')
|
|
77
|
-
.flag(
|
|
78
|
-
'title',
|
|
79
|
-
flag
|
|
80
|
-
.string()
|
|
81
|
-
.required()
|
|
82
|
-
.alias('t')
|
|
83
|
-
.describe('PR title')
|
|
84
|
-
.prompt({ kind: 'input', message: 'Title:' }),
|
|
85
|
-
)
|
|
86
|
-
.flag(
|
|
87
|
-
'body',
|
|
88
|
-
flag
|
|
89
|
-
.string()
|
|
90
|
-
.required()
|
|
91
|
-
.alias('b')
|
|
92
|
-
.describe('PR body')
|
|
93
|
-
.prompt({ kind: 'input', message: 'Body:' }),
|
|
94
|
-
)
|
|
95
|
-
.flag('draft', flag.boolean().alias('d').default(false).describe('Create as draft'))
|
|
96
|
-
.action(async ({ flags, out }) => {
|
|
97
|
-
const spinner = out.spinner('Creating pull request...');
|
|
98
|
-
await sleep(1500);
|
|
99
|
-
spinner.succeed('Pull request created');
|
|
100
|
-
|
|
101
|
-
const createdPr = {
|
|
102
|
-
number: 143,
|
|
103
|
-
title: flags.title,
|
|
104
|
-
url: 'https://github.com/you/repo/pull/143',
|
|
105
|
-
};
|
|
106
|
-
|
|
107
|
-
if (out.jsonMode) {
|
|
108
|
-
out.json(createdPr);
|
|
109
|
-
return;
|
|
110
|
-
}
|
|
111
|
-
|
|
112
|
-
out.log(`#${createdPr.number} ${createdPr.title}`);
|
|
113
|
-
if (flags.draft) {
|
|
114
|
-
out.info('Marked as draft');
|
|
115
|
-
}
|
|
116
|
-
out.log(createdPr.url);
|
|
117
|
-
});
|
|
118
|
-
|
|
119
|
-
export { prCreate, prList, prView };
|
|
120
|
-
|
|
121
|
-
export const pr = group('pr')
|
|
122
|
-
.description('Manage pull requests')
|
|
123
|
-
.command(prList)
|
|
124
|
-
.command(prView)
|
|
125
|
-
.command(prCreate);
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
- { number: 86, title: Dark mode colors wrong, state: open, author: alice, labels: [bug, ui] }
|
|
3
|
-
- { number: 87, title: Typo in README, state: closed, author: grace, labels: [docs] }
|
|
4
|
-
- { number: 88, title: Add keyboard shortcuts, state: open, author: frank, labels: [enhancement] }
|
|
5
|
-
- { number: 89, title: Login fails on Firefox, state: open, author: eve, labels: [bug] }
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* TypeScript declaration for the walkthrough issue YAML data.
|
|
3
|
-
*
|
|
4
|
-
* @module
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
type Issue = {
|
|
8
|
-
readonly number: number;
|
|
9
|
-
readonly title: string;
|
|
10
|
-
readonly state: 'open' | 'closed';
|
|
11
|
-
readonly author: string;
|
|
12
|
-
readonly labels: readonly string[];
|
|
13
|
-
};
|
|
14
|
-
|
|
15
|
-
declare const contents: readonly Issue[];
|
|
16
|
-
|
|
17
|
-
export = contents;
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
- { number: 137, title: Fix date parsing in Safari, state: open, author: dave, labels: [bug], draft: false }
|
|
3
|
-
- { number: 138, title: Refactor auth module, state: merged, author: alice, labels: [refactor], draft: false }
|
|
4
|
-
- { number: 139, title: Add rate limiting, state: closed, author: carol, labels: [enhancement], draft: true }
|
|
5
|
-
- { number: 140, title: Bump dependencies, state: merged, author: dependabot, labels: [chore], draft: false }
|
|
6
|
-
- { number: 141, title: Fix OAuth redirect loop, state: open, author: bob, labels: [bug], draft: false }
|
|
7
|
-
- { number: 142, title: Add dark mode toggle, state: open, author: alice, labels: [enhancement, ui], draft: false }
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* TypeScript declaration for the walkthrough pull request YAML data.
|
|
3
|
-
*
|
|
4
|
-
* @module
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
type PR = {
|
|
8
|
-
readonly number: number;
|
|
9
|
-
readonly title: string;
|
|
10
|
-
readonly state: 'open' | 'closed' | 'merged';
|
|
11
|
-
readonly author: string;
|
|
12
|
-
readonly labels: readonly string[];
|
|
13
|
-
readonly draft: boolean;
|
|
14
|
-
};
|
|
15
|
-
|
|
16
|
-
declare const contents: readonly PR[];
|
|
17
|
-
|
|
18
|
-
export = contents;
|
package/examples/gh/src/docs.ts
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Docs-facing exports for walkthrough Twoslash snippets.
|
|
3
|
-
*
|
|
4
|
-
* Keeps guide imports stable while reusing real command definitions.
|
|
5
|
-
*
|
|
6
|
-
* @module
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
export { authLogin, authStatus } from './commands/auth.ts';
|
|
10
|
-
export { issueList, issueTriage } from './commands/issue.ts';
|
|
11
|
-
export { prCreate, prList, prView } from './commands/pr.ts';
|
|
@@ -1,37 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Authentication guard and authenticated-command factory for the walkthrough `gh` example.
|
|
3
|
-
*
|
|
4
|
-
* @module
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
import { CLIError, command, flag } from '@kjanat/dreamcli';
|
|
8
|
-
|
|
9
|
-
export function tokenFlag(description = 'GitHub token') {
|
|
10
|
-
return flag.string().env('GH_TOKEN').describe(description);
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
export function requireAuth(token: string | undefined): { readonly token: string } {
|
|
14
|
-
const normalizedToken = token?.trim();
|
|
15
|
-
if (!normalizedToken) {
|
|
16
|
-
throw new CLIError('Authentication required', {
|
|
17
|
-
code: 'AUTH_REQUIRED',
|
|
18
|
-
suggest: 'Run `gh auth login` or set GH_TOKEN',
|
|
19
|
-
exitCode: 1,
|
|
20
|
-
});
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
return { token: normalizedToken };
|
|
24
|
-
}
|
|
25
|
-
|
|
26
|
-
/** Redacts a token for display, keeping the first 8 and last 4 characters visible. */
|
|
27
|
-
export function redactToken(token: string): string {
|
|
28
|
-
if (token.length <= 12) return '***';
|
|
29
|
-
return `${token.slice(0, 8)}...${token.slice(-4)}`;
|
|
30
|
-
}
|
|
31
|
-
|
|
32
|
-
/** A {@linkcode command} pre-wired with a `--token` / `GH_TOKEN` flag and auth guard. */
|
|
33
|
-
export function authedCommand(name: string) {
|
|
34
|
-
return command(name)
|
|
35
|
-
.flag('token', tokenFlag())
|
|
36
|
-
.derive(({ flags }) => requireAuth(flags.token));
|
|
37
|
-
}
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Shared helpers for the walkthrough `gh` example.
|
|
3
|
-
*
|
|
4
|
-
* @module
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
export function sleep(ms: number): Promise<void> {
|
|
8
|
-
return new Promise((resolve) => setTimeout(resolve, ms));
|
|
9
|
-
}
|
|
10
|
-
|
|
11
|
-
export function normalizeLimit(value: number): number {
|
|
12
|
-
if (!Number.isFinite(value)) {
|
|
13
|
-
return 10;
|
|
14
|
-
}
|
|
15
|
-
|
|
16
|
-
return Math.max(1, Math.floor(value));
|
|
17
|
-
}
|