@purveyors/cli 0.9.6 → 0.14.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 +182 -20
- package/dist/commands/auth.d.ts.map +1 -1
- package/dist/commands/auth.js +4 -3
- package/dist/commands/auth.js.map +1 -1
- package/dist/commands/catalog.d.ts.map +1 -1
- package/dist/commands/catalog.js +55 -31
- package/dist/commands/catalog.js.map +1 -1
- package/dist/commands/config.d.ts.map +1 -1
- package/dist/commands/config.js +61 -12
- package/dist/commands/config.js.map +1 -1
- package/dist/commands/context.d.ts.map +1 -1
- package/dist/commands/context.js +32 -234
- package/dist/commands/context.js.map +1 -1
- package/dist/commands/manifest.d.ts +3 -0
- package/dist/commands/manifest.d.ts.map +1 -0
- package/dist/commands/manifest.js +28 -0
- package/dist/commands/manifest.js.map +1 -0
- package/dist/index.js +6 -105
- package/dist/index.js.map +1 -1
- package/dist/lib/config.d.ts.map +1 -1
- package/dist/lib/config.js +8 -2
- package/dist/lib/config.js.map +1 -1
- package/dist/lib/errors.d.ts +13 -1
- package/dist/lib/errors.d.ts.map +1 -1
- package/dist/lib/errors.js +153 -10
- package/dist/lib/errors.js.map +1 -1
- package/dist/lib/index.d.ts +1 -0
- package/dist/lib/index.d.ts.map +1 -1
- package/dist/lib/index.js +1 -0
- package/dist/lib/index.js.map +1 -1
- package/dist/lib/manifest.d.ts +100 -0
- package/dist/lib/manifest.d.ts.map +1 -0
- package/dist/lib/manifest.js +919 -0
- package/dist/lib/manifest.js.map +1 -0
- package/dist/lib/output.d.ts +10 -0
- package/dist/lib/output.d.ts.map +1 -1
- package/dist/lib/output.js +33 -18
- package/dist/lib/output.js.map +1 -1
- package/dist/program.d.ts +4 -0
- package/dist/program.d.ts.map +1 -0
- package/dist/program.js +131 -0
- package/dist/program.js.map +1 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +2 -1
package/dist/lib/errors.d.ts
CHANGED
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
export declare const EXIT_CODES: {
|
|
2
|
+
readonly OK: 0;
|
|
3
|
+
readonly GENERAL_ERROR: 1;
|
|
4
|
+
readonly INVALID_ARGUMENT: 2;
|
|
5
|
+
readonly AUTH_ERROR: 3;
|
|
6
|
+
readonly NOT_FOUND: 4;
|
|
7
|
+
readonly DEPENDENCY_CONFLICT: 5;
|
|
8
|
+
readonly CONFIG_ERROR: 6;
|
|
9
|
+
};
|
|
10
|
+
export type ExitCode = (typeof EXIT_CODES)[keyof typeof EXIT_CODES];
|
|
1
11
|
export declare class PrvrsError extends Error {
|
|
2
12
|
readonly code: string;
|
|
3
13
|
readonly details?: unknown;
|
|
@@ -9,8 +19,10 @@ export declare class AuthError extends PrvrsError {
|
|
|
9
19
|
export declare class ConfigError extends PrvrsError {
|
|
10
20
|
constructor(message: string, details?: unknown);
|
|
11
21
|
}
|
|
22
|
+
export declare function normalizeCliError(error: unknown): unknown;
|
|
23
|
+
export declare function exitCodeForError(error: unknown): ExitCode;
|
|
12
24
|
/**
|
|
13
|
-
* Print a formatted error to stderr and exit with code
|
|
25
|
+
* Print a formatted error to stderr and exit with a structured exit code.
|
|
14
26
|
*/
|
|
15
27
|
export declare function fatal(error: unknown): never;
|
|
16
28
|
/**
|
package/dist/lib/errors.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"AAUA,eAAO,MAAM,UAAU;;;;;;;;CAQb,CAAC;AAEX,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAC;AAoBpE,qBAAa,UAAW,SAAQ,KAAK;IACnC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,OAAO,CAAC,EAAE,OAAO,CAAC;gBAEtB,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO;CAM7D;AAED,qBAAa,SAAU,SAAQ,UAAU;gBAC3B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO;CAI/C;AAED,qBAAa,WAAY,SAAQ,UAAU;gBAC7B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO;CAI/C;AAWD,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAczD;AAED,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,QAAQ,CAYzD;AAqGD;;GAEG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,CA4B3C;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,OAAO,EAAE,EACnD,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAChC,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAQ/B"}
|
package/dist/lib/errors.js
CHANGED
|
@@ -1,4 +1,32 @@
|
|
|
1
1
|
import chalk from 'chalk';
|
|
2
|
+
import { CommanderError } from 'commander';
|
|
3
|
+
import { ZodError } from 'zod';
|
|
4
|
+
import { formatStructuredOutput, outputOptionsFromArgv, shouldUseInteractiveOutput, } from './output.js';
|
|
5
|
+
export const EXIT_CODES = {
|
|
6
|
+
OK: 0,
|
|
7
|
+
GENERAL_ERROR: 1,
|
|
8
|
+
INVALID_ARGUMENT: 2,
|
|
9
|
+
AUTH_ERROR: 3,
|
|
10
|
+
NOT_FOUND: 4,
|
|
11
|
+
DEPENDENCY_CONFLICT: 5,
|
|
12
|
+
CONFIG_ERROR: 6,
|
|
13
|
+
};
|
|
14
|
+
const PRVRS_ERROR_EXIT_CODES = {
|
|
15
|
+
INVALID_ARGUMENT: EXIT_CODES.INVALID_ARGUMENT,
|
|
16
|
+
AUTH_ERROR: EXIT_CODES.AUTH_ERROR,
|
|
17
|
+
NOT_FOUND: EXIT_CODES.NOT_FOUND,
|
|
18
|
+
DEPENDENCY_CONFLICT: EXIT_CODES.DEPENDENCY_CONFLICT,
|
|
19
|
+
CONFIG_ERROR: EXIT_CODES.CONFIG_ERROR,
|
|
20
|
+
};
|
|
21
|
+
const COMMANDER_INVALID_ARGUMENT_CODES = new Set([
|
|
22
|
+
'commander.invalidArgument',
|
|
23
|
+
'commander.missingArgument',
|
|
24
|
+
'commander.optionMissingArgument',
|
|
25
|
+
'commander.missingMandatoryOptionValue',
|
|
26
|
+
'commander.unknownOption',
|
|
27
|
+
'commander.unknownCommand',
|
|
28
|
+
'commander.excessArguments',
|
|
29
|
+
]);
|
|
2
30
|
export class PrvrsError extends Error {
|
|
3
31
|
code;
|
|
4
32
|
details;
|
|
@@ -21,26 +49,141 @@ export class ConfigError extends PrvrsError {
|
|
|
21
49
|
this.name = 'ConfigError';
|
|
22
50
|
}
|
|
23
51
|
}
|
|
52
|
+
function normalizeCommanderErrorMessage(message) {
|
|
53
|
+
const normalized = message.replace(/^error:\s*/i, '').trim();
|
|
54
|
+
if (!normalized) {
|
|
55
|
+
return 'Commander parse error';
|
|
56
|
+
}
|
|
57
|
+
return normalized.charAt(0).toUpperCase() + normalized.slice(1);
|
|
58
|
+
}
|
|
59
|
+
export function normalizeCliError(error) {
|
|
60
|
+
if (!(error instanceof CommanderError)) {
|
|
61
|
+
return error;
|
|
62
|
+
}
|
|
63
|
+
const code = COMMANDER_INVALID_ARGUMENT_CODES.has(error.code)
|
|
64
|
+
? 'INVALID_ARGUMENT'
|
|
65
|
+
: 'GENERAL_ERROR';
|
|
66
|
+
return new PrvrsError(code, normalizeCommanderErrorMessage(error.message), {
|
|
67
|
+
commanderCode: error.code,
|
|
68
|
+
commanderExitCode: error.exitCode,
|
|
69
|
+
...(error.nestedError ? { nestedError: error.nestedError } : {}),
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
export function exitCodeForError(error) {
|
|
73
|
+
const normalized = normalizeCliError(error);
|
|
74
|
+
if (normalized instanceof PrvrsError) {
|
|
75
|
+
return PRVRS_ERROR_EXIT_CODES[normalized.code] ?? EXIT_CODES.GENERAL_ERROR;
|
|
76
|
+
}
|
|
77
|
+
if (normalized instanceof ZodError) {
|
|
78
|
+
return EXIT_CODES.INVALID_ARGUMENT;
|
|
79
|
+
}
|
|
80
|
+
return EXIT_CODES.GENERAL_ERROR;
|
|
81
|
+
}
|
|
82
|
+
function errorCodeLabel(error) {
|
|
83
|
+
const normalized = normalizeCliError(error);
|
|
84
|
+
if (normalized instanceof PrvrsError) {
|
|
85
|
+
return normalized.code;
|
|
86
|
+
}
|
|
87
|
+
if (normalized instanceof ZodError) {
|
|
88
|
+
return 'INVALID_ARGUMENT';
|
|
89
|
+
}
|
|
90
|
+
return 'GENERAL_ERROR';
|
|
91
|
+
}
|
|
92
|
+
function formatZodErrorMessage(error) {
|
|
93
|
+
const issue = error.issues[0];
|
|
94
|
+
if (!issue) {
|
|
95
|
+
return 'Invalid arguments.';
|
|
96
|
+
}
|
|
97
|
+
const path = issue.path.length > 0 ? ` (${issue.path.join('.')})` : '';
|
|
98
|
+
return `Invalid argument${path}: ${issue.message}`;
|
|
99
|
+
}
|
|
100
|
+
function errorMessageForError(error) {
|
|
101
|
+
const normalized = normalizeCliError(error);
|
|
102
|
+
if (normalized instanceof PrvrsError) {
|
|
103
|
+
return normalized.message;
|
|
104
|
+
}
|
|
105
|
+
if (normalized instanceof ZodError) {
|
|
106
|
+
return formatZodErrorMessage(normalized);
|
|
107
|
+
}
|
|
108
|
+
if (normalized instanceof Error) {
|
|
109
|
+
return normalized.message;
|
|
110
|
+
}
|
|
111
|
+
return 'An unknown error occurred';
|
|
112
|
+
}
|
|
113
|
+
function errorDetailsForError(error) {
|
|
114
|
+
if (!process.env.PURVEY_DEBUG) {
|
|
115
|
+
return undefined;
|
|
116
|
+
}
|
|
117
|
+
const normalized = normalizeCliError(error);
|
|
118
|
+
if (normalized instanceof PrvrsError) {
|
|
119
|
+
return normalized.details;
|
|
120
|
+
}
|
|
121
|
+
if (normalized instanceof ZodError) {
|
|
122
|
+
return normalized.issues;
|
|
123
|
+
}
|
|
124
|
+
if (normalized instanceof Error && normalized.stack) {
|
|
125
|
+
return { stack: normalized.stack };
|
|
126
|
+
}
|
|
127
|
+
return undefined;
|
|
128
|
+
}
|
|
129
|
+
function buildCliErrorEnvelope(error) {
|
|
130
|
+
const envelope = {
|
|
131
|
+
error: true,
|
|
132
|
+
code: errorCodeLabel(error),
|
|
133
|
+
exitCode: exitCodeForError(error),
|
|
134
|
+
message: errorMessageForError(error),
|
|
135
|
+
};
|
|
136
|
+
const details = errorDetailsForError(error);
|
|
137
|
+
if (details !== undefined) {
|
|
138
|
+
envelope.details = details;
|
|
139
|
+
}
|
|
140
|
+
return envelope;
|
|
141
|
+
}
|
|
142
|
+
function shouldUseStructuredErrorOutput(argv = process.argv) {
|
|
143
|
+
const options = outputOptionsFromArgv(argv);
|
|
144
|
+
// Keep human-readable errors only when the whole invocation is interactive.
|
|
145
|
+
// If either stdout or stderr is redirected, prefer the machine contract.
|
|
146
|
+
const isFullyInteractive = Boolean(process.stdout.isTTY && process.stderr.isTTY);
|
|
147
|
+
return !shouldUseInteractiveOutput(options, isFullyInteractive);
|
|
148
|
+
}
|
|
149
|
+
function writeStructuredError(error, argv = process.argv) {
|
|
150
|
+
const options = outputOptionsFromArgv(argv);
|
|
151
|
+
const formatted = formatStructuredOutput(buildCliErrorEnvelope(error), {
|
|
152
|
+
pretty: options.pretty,
|
|
153
|
+
});
|
|
154
|
+
process.stderr.write(`${formatted}\n`);
|
|
155
|
+
}
|
|
24
156
|
/**
|
|
25
|
-
* Print a formatted error to stderr and exit with code
|
|
157
|
+
* Print a formatted error to stderr and exit with a structured exit code.
|
|
26
158
|
*/
|
|
27
159
|
export function fatal(error) {
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
160
|
+
const normalized = normalizeCliError(error);
|
|
161
|
+
if (shouldUseStructuredErrorOutput()) {
|
|
162
|
+
writeStructuredError(normalized);
|
|
163
|
+
process.exit(exitCodeForError(normalized));
|
|
164
|
+
}
|
|
165
|
+
if (normalized instanceof PrvrsError) {
|
|
166
|
+
console.error(chalk.red(`✖ ${normalized.message}`));
|
|
167
|
+
if (process.env.PURVEY_DEBUG && normalized.details) {
|
|
168
|
+
console.error(chalk.dim('Details:'), normalized.details);
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
else if (normalized instanceof ZodError) {
|
|
172
|
+
console.error(chalk.red(`✖ ${formatZodErrorMessage(normalized)}`));
|
|
173
|
+
if (process.env.PURVEY_DEBUG) {
|
|
174
|
+
console.error(chalk.dim(JSON.stringify(normalized.issues, null, 2)));
|
|
32
175
|
}
|
|
33
176
|
}
|
|
34
|
-
else if (
|
|
35
|
-
console.error(chalk.red(`✖ ${
|
|
36
|
-
if (process.env.PURVEY_DEBUG &&
|
|
37
|
-
console.error(chalk.dim(
|
|
177
|
+
else if (normalized instanceof Error) {
|
|
178
|
+
console.error(chalk.red(`✖ ${normalized.message}`));
|
|
179
|
+
if (process.env.PURVEY_DEBUG && normalized.stack) {
|
|
180
|
+
console.error(chalk.dim(normalized.stack));
|
|
38
181
|
}
|
|
39
182
|
}
|
|
40
183
|
else {
|
|
41
184
|
console.error(chalk.red('✖ An unknown error occurred'));
|
|
42
185
|
}
|
|
43
|
-
process.exit(
|
|
186
|
+
process.exit(exitCodeForError(normalized));
|
|
44
187
|
}
|
|
45
188
|
/**
|
|
46
189
|
* Wrap an async command handler to catch and format errors.
|
package/dist/lib/errors.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/lib/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,KAAK,CAAC;AAE/B,OAAO,EACL,sBAAsB,EACtB,qBAAqB,EACrB,0BAA0B,GAC3B,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,EAAE,EAAE,CAAC;IACL,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,CAAC;IACnB,UAAU,EAAE,CAAC;IACb,SAAS,EAAE,CAAC;IACZ,mBAAmB,EAAE,CAAC;IACtB,YAAY,EAAE,CAAC;CACP,CAAC;AAIX,MAAM,sBAAsB,GAAsC;IAChE,gBAAgB,EAAE,UAAU,CAAC,gBAAgB;IAC7C,UAAU,EAAE,UAAU,CAAC,UAAU;IACjC,SAAS,EAAE,UAAU,CAAC,SAAS;IAC/B,mBAAmB,EAAE,UAAU,CAAC,mBAAmB;IACnD,YAAY,EAAE,UAAU,CAAC,YAAY;CACtC,CAAC;AAEF,MAAM,gCAAgC,GAAG,IAAI,GAAG,CAAC;IAC/C,2BAA2B;IAC3B,2BAA2B;IAC3B,iCAAiC;IACjC,uCAAuC;IACvC,yBAAyB;IACzB,0BAA0B;IAC1B,2BAA2B;CAC5B,CAAC,CAAC;AAEH,MAAM,OAAO,UAAW,SAAQ,KAAK;IACnB,IAAI,CAAS;IACb,OAAO,CAAW;IAElC,YAAY,IAAY,EAAE,OAAe,EAAE,OAAiB;QAC1D,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,MAAM,OAAO,SAAU,SAAQ,UAAU;IACvC,YAAY,OAAe,EAAE,OAAiB;QAC5C,KAAK,CAAC,YAAY,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;IAC1B,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,UAAU;IACzC,YAAY,OAAe,EAAE,OAAiB;QAC5C,KAAK,CAAC,cAAc,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AAED,SAAS,8BAA8B,CAAC,OAAe;IACrD,MAAM,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7D,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAED,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAc;IAC9C,IAAI,CAAC,CAAC,KAAK,YAAY,cAAc,CAAC,EAAE,CAAC;QACvC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,gCAAgC,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,CAAC;QAC3D,CAAC,CAAC,kBAAkB;QACpB,CAAC,CAAC,eAAe,CAAC;IAEpB,OAAO,IAAI,UAAU,CAAC,IAAI,EAAE,8BAA8B,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;QACzE,aAAa,EAAE,KAAK,CAAC,IAAI;QACzB,iBAAiB,EAAE,KAAK,CAAC,QAAQ;QACjC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACjE,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,MAAM,UAAU,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,UAAU,YAAY,UAAU,EAAE,CAAC;QACrC,OAAO,sBAAsB,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,aAAa,CAAC;IAC7E,CAAC;IAED,IAAI,UAAU,YAAY,QAAQ,EAAE,CAAC;QACnC,OAAO,UAAU,CAAC,gBAAgB,CAAC;IACrC,CAAC;IAED,OAAO,UAAU,CAAC,aAAa,CAAC;AAClC,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,MAAM,UAAU,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,UAAU,YAAY,UAAU,EAAE,CAAC;QACrC,OAAO,UAAU,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,IAAI,UAAU,YAAY,QAAQ,EAAE,CAAC;QACnC,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAe;IAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IAC9B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACvE,OAAO,mBAAmB,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;AACrD,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAc;IAC1C,MAAM,UAAU,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,UAAU,YAAY,UAAU,EAAE,CAAC;QACrC,OAAO,UAAU,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED,IAAI,UAAU,YAAY,QAAQ,EAAE,CAAC;QACnC,OAAO,qBAAqB,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,UAAU,YAAY,KAAK,EAAE,CAAC;QAChC,OAAO,UAAU,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED,OAAO,2BAA2B,CAAC;AACrC,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAc;IAC1C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;QAC9B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,UAAU,YAAY,UAAU,EAAE,CAAC;QACrC,OAAO,UAAU,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED,IAAI,UAAU,YAAY,QAAQ,EAAE,CAAC;QACnC,OAAO,UAAU,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED,IAAI,UAAU,YAAY,KAAK,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;QACpD,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,CAAC;IACrC,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAc;IAC3C,MAAM,QAAQ,GAAqB;QACjC,KAAK,EAAE,IAAI;QACX,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC;QAC3B,QAAQ,EAAE,gBAAgB,CAAC,KAAK,CAAC;QACjC,OAAO,EAAE,oBAAoB,CAAC,KAAK,CAAC;KACrC,CAAC;IAEF,MAAM,OAAO,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAC5C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;IAC7B,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,8BAA8B,CAAC,OAAiB,OAAO,CAAC,IAAI;IACnE,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAE5C,4EAA4E;IAC5E,yEAAyE;IACzE,MAAM,kBAAkB,GAAG,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAEjF,OAAO,CAAC,0BAA0B,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAc,EAAE,OAAiB,OAAO,CAAC,IAAI;IACzE,MAAM,OAAO,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,sBAAsB,CAAC,qBAAqB,CAAC,KAAK,CAAC,EAAE;QACrE,MAAM,EAAE,OAAO,CAAC,MAAM;KACvB,CAAC,CAAC;IAEH,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,SAAS,IAAI,CAAC,CAAC;AACzC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,KAAK,CAAC,KAAc;IAClC,MAAM,UAAU,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAE5C,IAAI,8BAA8B,EAAE,EAAE,CAAC;QACrC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QACjC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,UAAU,YAAY,UAAU,EAAE,CAAC;QACrC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACpD,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;YACnD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;SAAM,IAAI,UAAU,YAAY,QAAQ,EAAE,CAAC;QAC1C,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,qBAAqB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC;YAC7B,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;SAAM,IAAI,UAAU,YAAY,KAAK,EAAE,CAAC;QACvC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACpD,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACjD,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAC/B,EAAiC;IAEjC,OAAO,KAAK,EAAE,GAAG,IAAO,EAAE,EAAE;QAC1B,IAAI,CAAC;YACH,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,KAAK,CAAC,KAAK,CAAC,CAAC;QACf,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}
|
package/dist/lib/index.d.ts
CHANGED
package/dist/lib/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":"AAMA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":"AAMA,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}
|
package/dist/lib/index.js
CHANGED
package/dist/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,2EAA2E;AAC3E,qCAAqC;AACrC,2DAA2D;AAC3D,6DAA6D;AAE7D,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lib/index.ts"],"names":[],"mappings":"AAAA,8DAA8D;AAC9D,2EAA2E;AAC3E,qCAAqC;AACrC,2DAA2D;AAC3D,6DAA6D;AAE7D,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,cAAc,CAAC"}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
export type CliAuthRequirement = 'none' | 'viewer' | 'member';
|
|
2
|
+
export type CliOutputMode = 'json' | 'pretty' | 'csv';
|
|
3
|
+
export interface CliDocLink {
|
|
4
|
+
label: string;
|
|
5
|
+
url: string;
|
|
6
|
+
}
|
|
7
|
+
export interface CliRoleContract {
|
|
8
|
+
role: 'viewer' | 'member';
|
|
9
|
+
description: string;
|
|
10
|
+
}
|
|
11
|
+
export interface CliOutputModeContract {
|
|
12
|
+
mode: CliOutputMode;
|
|
13
|
+
description: string;
|
|
14
|
+
}
|
|
15
|
+
export interface CliExitCodeContract {
|
|
16
|
+
exitCode: number;
|
|
17
|
+
code: string;
|
|
18
|
+
description: string;
|
|
19
|
+
}
|
|
20
|
+
export interface CliIdContract {
|
|
21
|
+
name: string;
|
|
22
|
+
source: string;
|
|
23
|
+
usedBy: string[];
|
|
24
|
+
note?: string;
|
|
25
|
+
}
|
|
26
|
+
export interface CliOptionContract {
|
|
27
|
+
flags: string;
|
|
28
|
+
description?: string;
|
|
29
|
+
defaultValue?: string | number | boolean;
|
|
30
|
+
requiredInFlagMode?: boolean;
|
|
31
|
+
notes?: string[];
|
|
32
|
+
}
|
|
33
|
+
export interface CliArgumentContract {
|
|
34
|
+
name: string;
|
|
35
|
+
cliToken?: string;
|
|
36
|
+
description: string;
|
|
37
|
+
required: boolean;
|
|
38
|
+
idType?: string;
|
|
39
|
+
}
|
|
40
|
+
export interface CliStructuredErrorContract {
|
|
41
|
+
channel: 'stderr';
|
|
42
|
+
guaranteedFields: string[];
|
|
43
|
+
optionalFields: string[];
|
|
44
|
+
when: string;
|
|
45
|
+
exception?: string;
|
|
46
|
+
}
|
|
47
|
+
export interface CliCommandContract {
|
|
48
|
+
name: string;
|
|
49
|
+
summary: string;
|
|
50
|
+
auth: CliAuthRequirement;
|
|
51
|
+
arguments?: CliArgumentContract[];
|
|
52
|
+
options?: CliOptionContract[];
|
|
53
|
+
notes?: string[];
|
|
54
|
+
examples?: string[];
|
|
55
|
+
}
|
|
56
|
+
export interface CliCommandGroupContract {
|
|
57
|
+
name: string;
|
|
58
|
+
summary: string;
|
|
59
|
+
auth: CliAuthRequirement | 'mixed';
|
|
60
|
+
command?: CliCommandContract;
|
|
61
|
+
subcommands?: CliCommandContract[];
|
|
62
|
+
}
|
|
63
|
+
export interface CliWorkflowContract {
|
|
64
|
+
title: string;
|
|
65
|
+
commands: string[];
|
|
66
|
+
}
|
|
67
|
+
export interface CliErrorPatternContract {
|
|
68
|
+
title: string;
|
|
69
|
+
exitCodes: number[];
|
|
70
|
+
guidance: string[];
|
|
71
|
+
}
|
|
72
|
+
export interface CliManifest {
|
|
73
|
+
schemaVersion: '1';
|
|
74
|
+
binary: string;
|
|
75
|
+
packageName: string;
|
|
76
|
+
description: string;
|
|
77
|
+
nodeVersion: string;
|
|
78
|
+
files: {
|
|
79
|
+
credentials: string;
|
|
80
|
+
config: string;
|
|
81
|
+
};
|
|
82
|
+
docs: CliDocLink[];
|
|
83
|
+
roles: CliRoleContract[];
|
|
84
|
+
globalOptions: CliOptionContract[];
|
|
85
|
+
outputModes: CliOutputModeContract[];
|
|
86
|
+
outputContract: {
|
|
87
|
+
stdout: string;
|
|
88
|
+
stderr: string;
|
|
89
|
+
notes: string[];
|
|
90
|
+
structuredErrors: CliStructuredErrorContract;
|
|
91
|
+
};
|
|
92
|
+
exitCodes: CliExitCodeContract[];
|
|
93
|
+
idTypes: CliIdContract[];
|
|
94
|
+
commandGroups: CliCommandGroupContract[];
|
|
95
|
+
workflows: CliWorkflowContract[];
|
|
96
|
+
errorPatterns: CliErrorPatternContract[];
|
|
97
|
+
}
|
|
98
|
+
export declare function getCliManifest(): CliManifest;
|
|
99
|
+
export declare function renderContextText(manifest?: CliManifest): string;
|
|
100
|
+
//# sourceMappingURL=manifest.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/lib/manifest.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAC9D,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;AAEtD,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACzC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,QAAQ,CAAC;IAClB,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAClC,OAAO,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC9B,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACrB;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC;IACnC,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAC7B,WAAW,CAAC,EAAE,kBAAkB,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,GAAG,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE;QACL,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,IAAI,EAAE,UAAU,EAAE,CAAC;IACnB,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB,aAAa,EAAE,iBAAiB,EAAE,CAAC;IACnC,WAAW,EAAE,qBAAqB,EAAE,CAAC;IACrC,cAAc,EAAE;QACd,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,KAAK,EAAE,MAAM,EAAE,CAAC;QAChB,gBAAgB,EAAE,0BAA0B,CAAC;KAC9C,CAAC;IACF,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,OAAO,EAAE,aAAa,EAAE,CAAC;IACzB,aAAa,EAAE,uBAAuB,EAAE,CAAC;IACzC,SAAS,EAAE,mBAAmB,EAAE,CAAC;IACjC,aAAa,EAAE,uBAAuB,EAAE,CAAC;CAC1C;AA0sBD,wBAAgB,cAAc,IAAI,WAAW,CA+C5C;AA6KD,wBAAgB,iBAAiB,CAAC,QAAQ,GAAE,WAA8B,GAAG,MAAM,CA6BlF"}
|