bdy 1.25.2-stage → 1.25.4-dev

package/distTs/src/command/tests/visual.js

@@ -9,15 +9,17 @@ const setup_1 = __importDefault(require("./visual/setup"));
 const upload_1 = __importDefault(require("./visual/upload"));
 const session_1 = __importDefault(require("./visual/session"));
 const link_1 = __importDefault(require("./visual/link"));
-const commandVisual = (0, utils_1.newCommand)('visual', texts_1.DESC_COMMAND_VISUAL);
+const commandVisual = (0, utils_1.newCommand)('visual', texts_1.DESC_COMMAND_VISUAL, {
+    examples: [
+        ...texts_1.EXAMPLE_TESTS_VISUAL_SETUP,
+        ...texts_1.EXAMPLE_TESTS_VISUAL_UPLOAD,
+        ...texts_1.EXAMPLE_TESTS_VISUAL_LINK,
+        ...texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CREATE,
+        ...texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE,
+    ],
+});
 commandVisual.addCommand(setup_1.default);
 commandVisual.addCommand(upload_1.default);
 commandVisual.addCommand(session_1.default);
 commandVisual.addCommand(link_1.default);
-commandVisual.addHelpText('after', `
-EXAMPLES:${texts_1.EXAMPLE_TESTS_VISUAL_SETUP}
-${texts_1.EXAMPLE_TESTS_VISUAL_UPLOAD}
-${texts_1.EXAMPLE_TESTS_VISUAL_LINK}
-${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CREATE}
-${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE}`);
 exports.default = commandVisual;

package/distTs/src/command/tests.js

@@ -8,17 +8,19 @@ const texts_1 = require("../texts");
 const unit_1 = __importDefault(require("./tests/unit"));
 const visual_1 = __importDefault(require("./tests/visual"));
 const capture_1 = __importDefault(require("./tests/capture"));
-const commandTests = (0, utils_1.newCommand)('tests', texts_1.DESC_COMMAND_TESTS);
+const commandTests = (0, utils_1.newCommand)('tests', texts_1.DESC_COMMAND_TESTS, {
+    examples: [
+        ...texts_1.EXAMPLE_TESTS_UNIT_UPLOAD,
+        ...texts_1.EXAMPLE_TESTS_UNIT_LINK,
+        ...texts_1.EXAMPLE_TESTS_VISUAL_SETUP,
+        ...texts_1.EXAMPLE_TESTS_VISUAL_UPLOAD,
+        ...texts_1.EXAMPLE_TESTS_VISUAL_LINK,
+        ...texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CREATE,
+        ...texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE,
+        ...texts_1.EXAMPLE_TESTS_CAPTURE,
+    ],
+});
 commandTests.addCommand(unit_1.default);
 commandTests.addCommand(visual_1.default);
 commandTests.addCommand(capture_1.default);
-commandTests.addHelpText('after', `
-EXAMPLES:${texts_1.EXAMPLE_TESTS_UNIT_UPLOAD}
-${texts_1.EXAMPLE_TESTS_UNIT_LINK}
-${texts_1.EXAMPLE_TESTS_VISUAL_SETUP}
-${texts_1.EXAMPLE_TESTS_VISUAL_UPLOAD}
-${texts_1.EXAMPLE_TESTS_VISUAL_LINK}
-${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CREATE}
-${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE}
-${texts_1.EXAMPLE_TESTS_CAPTURE}`);
 exports.default = commandTests;

package/distTs/src/command/tunnel/http.js

@@ -7,12 +7,13 @@ const utils_1 = require("../../utils");
 const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const tunnel_1 = require("../../types/tunnel");
-const commandHttp = (0, utils_1.getBasicCommandHttp)();
+const commandHttp = (0, utils_1.getBasicCommandHttp)({
+    examples: (0, texts_1.EXAMPLE_TUNNEL_HTTP)(false),
+});
 commandHttp.description(texts_1.DESC_COMMAND_HTTP);
 commandHttp.option('-s, --serve <directory>', texts_1.OPTION_SERVE);
 commandHttp.option('--token <token>', texts_1.OPTION_TOKEN);
 commandHttp.argument('[protocol://host:port]', texts_1.OPTION_TARGET);
-commandHttp.addHelpText('after', `\nEXAMPLES:${(0, texts_1.EXAMPLE_TUNNEL_HTTP)(false)}`);
 commandHttp.action(async (target, options) => {
     const ApiBuddy = require('../../tunnel/api/buddy').default;
     const Input = require('../../input').default;

package/distTs/src/command/tunnel/start.js

@@ -6,10 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const utils_1 = require("../../utils");
-const commandStart = (0, utils_1.newCommand)('start', texts_1.DESC_COMMAND_START);
+const commandStart = (0, utils_1.newCommand)('start', texts_1.DESC_COMMAND_START, {
+    examples: texts_1.EXAMPLE_TUNNEL_START,
+});
 commandStart.option('--token <token>', texts_1.OPTION_TOKEN);
 commandStart.argument('<name>', texts_1.OPTION_NAME);
-commandStart.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_TUNNEL_START}`);
 commandStart.action(async (name, options) => {
     const ApiBuddy = require('../../tunnel/api/buddy').default;
     const Input = require('../../input').default;

package/distTs/src/command/tunnel/tcp.js

@@ -7,11 +7,10 @@ const utils_1 = require("../../utils");
 const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const tunnel_1 = require("../../types/tunnel");
-const commandTcp = (0, utils_1.getBasicCommandTcp)();
+const commandTcp = (0, utils_1.getBasicCommandTcp)({ examples: (0, texts_1.EXAMPLE_TUNNEL_TCP)(false) });
 commandTcp.description(texts_1.DESC_COMMAND_TCP);
 commandTcp.option('--token <token>', texts_1.OPTION_TOKEN);
 commandTcp.argument('[host:port]', texts_1.OPTION_TARGET);
-commandTcp.addHelpText('after', `\nEXAMPLES:${(0, texts_1.EXAMPLE_TUNNEL_TCP)(false)}`);
 commandTcp.action(async (target, options) => {
     const ApiBuddy = require('../../tunnel/api/buddy').default;
     const Input = require('../../input').default;

package/distTs/src/command/tunnel/tls.js

@@ -7,11 +7,10 @@ const utils_1 = require("../../utils");
 const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const tunnel_1 = require("../../types/tunnel");
-const commandTls = (0, utils_1.getBasicCommandTls)();
+const commandTls = (0, utils_1.getBasicCommandTls)({ examples: (0, texts_1.EXAMPLE_TUNNEL_TLS)(false) });
 commandTls.description(texts_1.DESC_COMMAND_TLS);
 commandTls.option('--token <token>', texts_1.OPTION_TOKEN);
 commandTls.argument('[host:port]', texts_1.OPTION_TARGET);
-commandTls.addHelpText('after', `\nEXAMPLES:${(0, texts_1.EXAMPLE_TUNNEL_TLS)(false)}`);
 commandTls.action(async (target, options) => {
     const ApiBuddy = require('../../tunnel/api/buddy').default;
     const Input = require('../../input').default;

package/distTs/src/command/tunnel.js

@@ -10,14 +10,17 @@ const tcp_1 = __importDefault(require("./tunnel/tcp"));
 const tls_1 = __importDefault(require("./tunnel/tls"));
 const http_1 = __importDefault(require("./tunnel/http"));
 const start_1 = __importDefault(require("./tunnel/start"));
-const commandTunnel = (0, utils_1.newCommand)('tunnel', texts_1.DESC_COMMAND_TUNNEL);
+const commandTunnel = (0, utils_1.newCommand)('tunnel', texts_1.DESC_COMMAND_TUNNEL, {
+    examples: [
+        ...(0, texts_1.EXAMPLE_TUNNEL_HTTP)(false),
+        ...(0, texts_1.EXAMPLE_TUNNEL_TLS)(false),
+        ...(0, texts_1.EXAMPLE_TUNNEL_TCP)(false),
+        ...texts_1.EXAMPLE_TUNNEL_START,
+    ],
+});
 commandTunnel.addCommand(config_1.default);
 commandTunnel.addCommand(tcp_1.default);
 commandTunnel.addCommand(tls_1.default);
 commandTunnel.addCommand(http_1.default);
 commandTunnel.addCommand(start_1.default);
-commandTunnel.addHelpText('after', `\nEXAMPLES:${(0, texts_1.EXAMPLE_TUNNEL_HTTP)(false)}
-${(0, texts_1.EXAMPLE_TUNNEL_TLS)(false)}
-${(0, texts_1.EXAMPLE_TUNNEL_TCP)(false)}
-${texts_1.EXAMPLE_TUNNEL_START}`);
 exports.default = commandTunnel;

package/distTs/src/command/version.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../utils");
 const output_1 = __importDefault(require("../output"));
 const utils_2 = require("../utils");
+const texts_1 = require("../texts");
 const updateMessage = (currentVersion, latestVersion, instructions) => {
     output_1.default.normal('Current version: ', false);
     output_1.default.gray(currentVersion);
@@ -71,7 +72,7 @@ const updateByDownload = (platform, currentVersion, latestVersion, env) => {
     }
     updateMessage(currentVersion, latestVersion, instructions);
 };
-const commandVersion = (0, utils_2.newCommand)('update');
+const commandVersion = (0, utils_2.newCommand)('update', texts_1.DESC_COMMAND_UPDATE);
 commandVersion.alias('version');
 commandVersion.hideVersionUpdate = true;
 commandVersion.action(async () => {

package/distTs/src/command/yaml/actions/info.js

@@ -13,10 +13,9 @@ const render_1 = require("../render");
 async function suggestionLine(query) {
     return (await (0, schema_1.searchActions)(query, 5)).map((hit) => `${hit.type} (${hit.name})`);
 }
-const commandYamlActionsInfo = (0, utils_1.newCommand)('info', texts_1.DESC_COMMAND_YAML_ACTIONS_INFO);
+const commandYamlActionsInfo = (0, utils_1.newCommand)('info', texts_1.DESC_COMMAND_YAML_ACTIONS_INFO, { examples: texts_1.EXAMPLE_YAML_ACTIONS_INFO });
 commandYamlActionsInfo.argument('<type>', texts_1.OPTION_ACTION_TYPE);
 commandYamlActionsInfo.option('--format <text|json>', texts_1.OPTION_FORMAT);
-commandYamlActionsInfo.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_YAML_ACTIONS_INFO}`);
 commandYamlActionsInfo.action(async (type, options) => {
     await (0, schemaUtils_1.ensureYamlSchema)();
     const action = await (0, schema_1.findAction)(type);

package/distTs/src/command/yaml/actions/list.js

@@ -26,11 +26,10 @@ function actionJson(actions, detectedTypes) {
         suggested: detectedTypes.has(action.type),
     }));
 }
-const commandYamlActionsList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_YAML_ACTIONS_LIST);
+const commandYamlActionsList = (0, utils_1.newCommand)('list', texts_1.DESC_COMMAND_YAML_ACTIONS_LIST, { examples: texts_1.EXAMPLE_YAML_ACTIONS_LIST });
 commandYamlActionsList.alias('ls');
 commandYamlActionsList.option('-s, --search <query>', texts_1.OPTION_ACTION_SEARCH);
 commandYamlActionsList.option('--format <text|json>', texts_1.OPTION_FORMAT);
-commandYamlActionsList.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_YAML_ACTIONS_LIST}`);
 commandYamlActionsList.action(async (options) => {
     await (0, schemaUtils_1.ensureYamlSchema)();
     const actions = await (0, schema_1.loadSchema)();

package/distTs/src/command/yaml/actions.js

@@ -7,10 +7,9 @@ const utils_1 = require("../../utils");
 const texts_1 = require("../../texts");
 const list_1 = __importDefault(require("./actions/list"));
 const info_1 = __importDefault(require("./actions/info"));
-const commandYamlActions = (0, utils_1.newCommand)('actions', texts_1.DESC_COMMAND_YAML_ACTIONS);
+const commandYamlActions = (0, utils_1.newCommand)('actions', texts_1.DESC_COMMAND_YAML_ACTIONS, {
+    examples: [...texts_1.EXAMPLE_YAML_ACTIONS_LIST, ...texts_1.EXAMPLE_YAML_ACTIONS_INFO],
+});
 commandYamlActions.addCommand(list_1.default);
 commandYamlActions.addCommand(info_1.default);
-commandYamlActions.addHelpText('after', `
-EXAMPLES:${texts_1.EXAMPLE_YAML_ACTIONS_LIST}
-${texts_1.EXAMPLE_YAML_ACTIONS_INFO}`);
 exports.default = commandYamlActions;

package/distTs/src/command/yaml/pipeline.js

@@ -8,9 +8,10 @@ const output_1 = __importDefault(require("../../output"));
 const texts_1 = require("../../texts");
 const schemaUtils_1 = require("./schemaUtils");
 const render_1 = require("./render");
-const commandYamlPipeline = (0, utils_1.newCommand)('pipeline', texts_1.DESC_COMMAND_YAML_PIPELINE);
+const commandYamlPipeline = (0, utils_1.newCommand)('pipeline', texts_1.DESC_COMMAND_YAML_PIPELINE, {
+    examples: texts_1.EXAMPLE_YAML_PIPELINE,
+});
 commandYamlPipeline.option('--format <text|json>', texts_1.OPTION_FORMAT);
-commandYamlPipeline.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_YAML_PIPELINE}`);
 commandYamlPipeline.action(async (options) => {
     await (0, schemaUtils_1.ensureYamlSchema)();
     const scope = (0, schemaUtils_1.pipelinesScope)();

package/distTs/src/command/yaml/validate.js

@@ -22,9 +22,17 @@ function prettifyKey(key) {
         .map((w) => w.charAt(0).toUpperCase() + w.slice(1))
         .join(' ');
 }
-function outputErrors(result, indent) {
+function recordError(context, path, message) {
+    context.errors.push({
+        pipeline: context.pipeline,
+        path: path.replace(/\.(\d+)(?=\.|$)/g, '[$1]'),
+        message,
+    });
+}
+function outputErrors(result, indent, context, prefix = '') {
     for (const err of result.errors) {
-        output_1.default.muted(`${indent}${err.path}: ${err.message}`);
+        recordError(context, [prefix, err.path].filter(Boolean).join('.'), err.message);
+        context.output.muted(`${indent}${err.path}: ${err.message}`);
     }
 }
 function valueType(value) {
@@ -34,9 +42,10 @@ function valueType(value) {
         return 'array';
     return typeof value;
 }
-function reportWrongContainer(header, expected, value) {
-    output_1.default.error(header);
-    output_1.default.muted(`  ${(0, texts_1.ERR_YAML_MUST_BE)(expected, valueType(value))}`);
+function reportWrongContainer(header, expected, value, context, path) {
+    recordError(context, path, (0, texts_1.ERR_YAML_MUST_BE)(expected, valueType(value)));
+    context.output.error(header);
+    context.output.muted(`  ${(0, texts_1.ERR_YAML_MUST_BE)(expected, valueType(value))}`);
     return 1;
 }
 // Array whose items reference a def — directly, or via a single $ref branch in
@@ -117,85 +126,101 @@ function itemLabel(value, index, discProp) {
         name = `#${index + 1}`;
     return discProp && value && value[discProp] ? `${name} (${value[discProp]})` : name;
 }
-function validateScalarItem(item, section) {
+function validateScalarItem(item, section, context, path) {
     // Null errors even where the section takes a string: coerceTypes cannot fix a root scalar.
     if (item === null || !section.scalar) {
-        output_1.default.error(`  ${String(item)}: ${(0, texts_1.ERR_YAML_MUST_BE)('object', valueType(item))}`);
+        recordError(context, path, (0, texts_1.ERR_YAML_MUST_BE)('object', valueType(item)));
+        context.output.error(`  ${String(item)}: ${(0, texts_1.ERR_YAML_MUST_BE)('object', valueType(item))}`);
         return 1;
     }
     const result = (0, schemaUtils_1.validateAgainstSchema)({ ...section.scalar, $defs: (0, schemaUtils_1.loadRawSchema)().$defs }, item);
     if (result.valid) {
-        output_1.default.green(`  ${String(item)}`);
+        context.output.green(`  ${String(item)}`);
         return 0;
     }
-    output_1.default.error(`  ${String(item)}`);
-    outputErrors(result, '    ');
+    context.output.error(`  ${String(item)}`);
+    outputErrors(result, '    ', context, path);
     return result.errors.length;
 }
-function validateItemSection(unions, items, section) {
+function validateItemSection(unions, items, section, context) {
     const refName = section.defName;
     const discProp = unions.get(refName)?.property ?? null;
     let errors = 0;
     for (let i = 0; i < items.length; i++) {
         const item = items[i];
+        const path = `${section.key}[${i}]`;
         if (item === null || typeof item !== 'object' || Array.isArray(item)) {
-            errors += validateScalarItem(item, section);
+            errors += validateScalarItem(item, section, context, path);
             continue;
         }
         const label = itemLabel(item, i, discProp);
         const resolved = resolveDef(unions, refName, item);
         if ('missingType' in resolved) {
-            output_1.default.error(`  ${label}: ${(0, texts_1.ERR_YAML_ITEM_MISSING)(resolved.missingType)}`);
+            recordError(context, `${path}.${resolved.missingType}`, (0, texts_1.ERR_YAML_ITEM_MISSING)(resolved.missingType));
+            context.output.error(`  ${label}: ${(0, texts_1.ERR_YAML_ITEM_MISSING)(resolved.missingType)}`);
             errors++;
             continue;
         }
         if ('unknownType' in resolved) {
-            output_1.default.error(`  ${label}: ${(0, texts_1.ERR_YAML_ITEM_UNKNOWN)(resolved.prop, resolved.unknownType)}`);
+            recordError(context, `${path}.${resolved.prop}`, (0, texts_1.ERR_YAML_ITEM_UNKNOWN)(resolved.prop, resolved.unknownType));
+            context.output.error(`  ${label}: ${(0, texts_1.ERR_YAML_ITEM_UNKNOWN)(resolved.prop, resolved.unknownType)}`);
             errors++;
             continue;
         }
         const result = (0, schemaUtils_1.validateAgainstDef)(resolved.defName, item);
         if (result.valid) {
-            output_1.default.green(`  ${label}`);
+            context.output.green(`  ${label}`);
         }
         else {
             errors += result.errors.length;
-            output_1.default.error(`  ${label}`);
-            outputErrors(result, '    ');
+            context.output.error(`  ${label}`);
+            outputErrors(result, '    ', context, path);
         }
     }
     return errors;
 }
-function validateObjectSection(unions, label, value, refName) {
+function validateObjectSection(unions, label, value, refName, context, path) {
     const resolved = resolveDef(unions, refName, value);
     if ('missingType' in resolved) {
-        output_1.default.error(label);
-        output_1.default.muted(`  ${(0, texts_1.ERR_YAML_ITEM_MISSING)(resolved.missingType)}`);
+        context.output.error(label);
+        recordError(context, `${path}.${resolved.missingType}`, (0, texts_1.ERR_YAML_ITEM_MISSING)(resolved.missingType));
+        context.output.muted(`  ${(0, texts_1.ERR_YAML_ITEM_MISSING)(resolved.missingType)}`);
         return 1;
     }
     if ('unknownType' in resolved) {
-        output_1.default.error(label);
-        output_1.default.muted(`  ${(0, texts_1.ERR_YAML_ITEM_UNKNOWN)(resolved.prop, resolved.unknownType)}`);
+        context.output.error(label);
+        recordError(context, `${path}.${resolved.prop}`, (0, texts_1.ERR_YAML_ITEM_UNKNOWN)(resolved.prop, resolved.unknownType));
+        context.output.muted(`  ${(0, texts_1.ERR_YAML_ITEM_UNKNOWN)(resolved.prop, resolved.unknownType)}`);
         return 1;
     }
     const result = (0, schemaUtils_1.validateAgainstDef)(resolved.defName, value);
     if (result.valid) {
-        output_1.default.green(label);
+        context.output.green(label);
         return 0;
     }
-    output_1.default.error(label);
-    outputErrors(result, '  ');
+    context.output.error(label);
+    outputErrors(result, '  ', context, path);
     return result.errors.length;
 }
-function validateSinglePipeline(parsed, label, unions) {
+function validateSinglePipeline(parsed, label, unions, context) {
     let errors = 0;
     const defs = (0, schemaUtils_1.getAllDefs)();
     const pipelineDef = defs['PipelineYaml'];
     const props = pipelineDef?.properties || {};
-    const allKnownKeys = new Set([...Object.keys(props), ...SCHEMA_OMITTED_TOP_LEVEL_KEYS]);
+    const allKnownKeys = new Set([
+        ...Object.keys(props),
+        ...SCHEMA_OMITTED_TOP_LEVEL_KEYS,
+    ]);
     const unknownKeys = Object.keys(parsed).filter((k) => !allKnownKeys.has(k));
     if (unknownKeys.length > 0) {
-        output_1.default.yellow(`${label}${(0, texts_1.TXT_YAML_UNKNOWN_TOP_LEVEL_KEYS)(unknownKeys.join(', '))}`);
+        for (const key of unknownKeys) {
+            context.warnings.push({
+                pipeline: context.pipeline,
+                path: key,
+                message: (0, texts_1.TXT_YAML_UNKNOWN_TOP_LEVEL_KEYS)(key),
+            });
+        }
+        context.output.yellow(`${label}${(0, texts_1.TXT_YAML_UNKNOWN_TOP_LEVEL_KEYS)(unknownKeys.join(', '))}`);
     }
     const { itemSections, objectSections, settingsProps } = classifySections(props);
     if (Object.keys(settingsProps).length > 0) {
@@ -212,12 +237,12 @@ function validateSinglePipeline(parsed, label, unions) {
             $defs: rawSchema.$defs,
         }, settingsData);
         if (result.valid) {
-            output_1.default.green(`${label}Pipeline settings`);
+            context.output.green(`${label}Pipeline settings`);
         }
         else {
             errors += result.errors.length;
-            output_1.default.error(`${label}Pipeline settings`);
-            outputErrors(result, '  ');
+            context.output.error(`${label}Pipeline settings`);
+            outputErrors(result, '  ', context);
         }
     }
     const itemByKey = new Map(itemSections.map((s) => [s.key, s]));
@@ -232,27 +257,52 @@ function validateSinglePipeline(parsed, label, unions) {
         const header = `${label}${prettifyKey(key)}`;
         if (itemByKey.has(key)) {
             if (!Array.isArray(value)) {
-                errors += reportWrongContainer(header, 'array', value);
+                errors += reportWrongContainer(header, 'array', value, context, key);
                 continue;
             }
-            output_1.default.blue(header);
-            errors += validateItemSection(unions, value, itemByKey.get(key));
+            context.output.blue(header);
+            errors += validateItemSection(unions, value, itemByKey.get(key), context);
         }
         else if (objByKey.has(key)) {
             if (typeof value !== 'object' || Array.isArray(value)) {
-                errors += reportWrongContainer(header, 'object', value);
+                errors += reportWrongContainer(header, 'object', value, context, key);
                 continue;
             }
-            errors += validateObjectSection(unions, header, value, objByKey.get(key));
+            errors += validateObjectSection(unions, header, value, objByKey.get(key), context, key);
         }
     }
     return errors;
 }
-function validatePipelineFile(file, unions) {
+function validatePipelineFile(file, unions, json) {
+    const context = {
+        output: {
+            normal: output_1.default.progress(json),
+            error: output_1.default.progress(json, output_1.default.error.bind(output_1.default)),
+            muted: output_1.default.progress(json, output_1.default.muted.bind(output_1.default)),
+            green: output_1.default.progress(json, output_1.default.green.bind(output_1.default)),
+            yellow: output_1.default.progress(json, output_1.default.yellow.bind(output_1.default)),
+            blue: output_1.default.progress(json, output_1.default.blue.bind(output_1.default)),
+        },
+        pipeline: 0,
+        errors: [],
+        warnings: [],
+    };
+    const invalidDocument = (message) => {
+        if (json) {
+            recordError(context, '', message);
+            output_1.default.json({
+                valid: false,
+                pipelines: 0,
+                errors: context.errors,
+                warnings: context.warnings,
+            });
+            output_1.default.exitCode(1);
+        }
+        output_1.default.exitError(message);
+    };
     const filePath = (0, path_1.resolve)(file);
     if (!(0, fs_1.existsSync)(filePath)) {
-        output_1.default.exitError((0, texts_1.ERR_YAML_VALIDATE_FILE_NOT_FOUND)(file));
-        return;
+        invalidDocument((0, texts_1.ERR_YAML_VALIDATE_FILE_NOT_FOUND)(file));
     }
     const YAML = require('yaml');
     const content = (0, fs_1.readFileSync)(filePath, 'utf8');
@@ -261,33 +311,40 @@ function validatePipelineFile(file, unions) {
         parsed = YAML.parse(content);
     }
     catch (e) {
-        output_1.default.exitError((0, texts_1.ERR_YAML_PARSE)(e.message));
-        return;
+        invalidDocument((0, texts_1.ERR_YAML_PARSE)(e.message));
     }
     if (!parsed || typeof parsed !== 'object') {
-        output_1.default.exitError(texts_1.ERR_YAML_NOT_ARRAY);
-        return;
+        invalidDocument(texts_1.ERR_YAML_NOT_ARRAY);
     }
     if (!Array.isArray(parsed)) {
-        output_1.default.exitError(texts_1.ERR_YAML_PLAIN_OBJECT);
-        return;
+        invalidDocument(texts_1.ERR_YAML_PLAIN_OBJECT);
     }
     if (parsed.length === 0) {
-        output_1.default.exitError(texts_1.ERR_YAML_EMPTY_ARRAY);
-        return;
+        invalidDocument(texts_1.ERR_YAML_EMPTY_ARRAY);
     }
     let errors = 0;
     for (let i = 0; i < parsed.length; i++) {
         const pipeline = parsed[i];
+        context.pipeline = i + 1;
         if (!pipeline || typeof pipeline !== 'object' || Array.isArray(pipeline)) {
-            output_1.default.error(`  ${(0, texts_1.ERR_YAML_PIPELINE_NOT_OBJECT)(i + 1)}`);
+            recordError(context, '', (0, texts_1.ERR_YAML_PIPELINE_NOT_OBJECT)(i + 1));
+            context.output.error(`  ${(0, texts_1.ERR_YAML_PIPELINE_NOT_OBJECT)(i + 1)}`);
             errors++;
             continue;
         }
         const pipelineLabel = parsed.length > 1 ? `[${pipeline.pipeline || i + 1}] ` : '';
-        errors += validateSinglePipeline(pipeline, pipelineLabel, unions);
+        errors += validateSinglePipeline(pipeline, pipelineLabel, unions, context);
     }
-    output_1.default.normal('');
+    if (json) {
+        output_1.default.json({
+            valid: errors === 0,
+            pipelines: parsed.length,
+            errors: context.errors,
+            warnings: context.warnings,
+        });
+        output_1.default.exitCode(errors > 0 ? 1 : 0);
+    }
+    context.output.normal('');
     if (errors > 0) {
         output_1.default.exitError((0, texts_1.ERR_YAML_VALIDATE_FAILED_COUNT)(errors));
     }
@@ -295,11 +352,14 @@ function validatePipelineFile(file, unions) {
         output_1.default.exitSuccess(texts_1.TXT_YAML_VALIDATE_ALL_PASS);
     }
 }
-const commandYamlValidate = (0, utils_1.newCommand)('validate', texts_1.DESC_COMMAND_YAML_VALIDATE);
+const commandYamlValidate = (0, utils_1.newCommand)('validate', texts_1.DESC_COMMAND_YAML_VALIDATE, {
+    helpText: texts_1.HELP_YAML_VALIDATE_JSON,
+    examples: texts_1.EXAMPLE_YAML_VALIDATE,
+});
 commandYamlValidate.argument('<file>', texts_1.OPTION_YAML_VALIDATE_FILE);
-commandYamlValidate.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_YAML_VALIDATE}`);
-commandYamlValidate.action(async (file) => {
+commandYamlValidate.option('--format <text|json>', texts_1.OPTION_FORMAT);
+commandYamlValidate.action(async (file, options) => {
     await (0, schemaUtils_1.ensureYamlSchema)();
-    validatePipelineFile(file, await unionMappings((0, schemaUtils_1.getAllDefs)()));
+    validatePipelineFile(file, await unionMappings((0, schemaUtils_1.getAllDefs)()), options.format === 'json');
 });
 exports.default = commandYamlValidate;

package/distTs/src/command/yaml.js

@@ -8,13 +8,15 @@ const texts_1 = require("../texts");
 const pipeline_1 = __importDefault(require("./yaml/pipeline"));
 const actions_1 = __importDefault(require("./yaml/actions"));
 const validate_1 = __importDefault(require("./yaml/validate"));
-const commandYaml = (0, utils_1.newCommand)('yaml', texts_1.DESC_COMMAND_YAML);
+const commandYaml = (0, utils_1.newCommand)('yaml', texts_1.DESC_COMMAND_YAML, {
+    examples: [
+        ...texts_1.EXAMPLE_YAML_PIPELINE,
+        ...texts_1.EXAMPLE_YAML_ACTIONS_LIST,
+        ...texts_1.EXAMPLE_YAML_ACTIONS_INFO,
+        ...texts_1.EXAMPLE_YAML_VALIDATE,
+    ],
+});
 commandYaml.addCommand(pipeline_1.default);
 commandYaml.addCommand(actions_1.default);
 commandYaml.addCommand(validate_1.default);
-commandYaml.addHelpText('after', `
-EXAMPLES:${texts_1.EXAMPLE_YAML_PIPELINE}
-${texts_1.EXAMPLE_YAML_ACTIONS_LIST}
-${texts_1.EXAMPLE_YAML_ACTIONS_INFO}
-${texts_1.EXAMPLE_YAML_VALIDATE}`);
 exports.default = commandYaml;