bdy 1.22.47-dev → 1.22.48-dev

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.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "bdy",
3
3
  "preferGlobal": false,
4
- "version": "1.22.47-dev",
4
+ "version": "1.22.48-dev",
5
5
  "type": "commonjs",
6
6
  "license": "MIT",
7
7
  "scripts": {
@@ -58,4 +58,5 @@ commandCrawlLink.action(async (options) => {
58
58
  output_1.default.okSign();
59
59
  output_1.default.exitSuccess(texts_1.TXT_COMMAND_CRAWL_LINK_SUCCESS);
60
60
  });
61
+ commandCrawlLink.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_CRAWL_LINK}`);
61
62
  exports.default = commandCrawlLink;
@@ -144,4 +144,5 @@ async function watchSessionStatus(ctx, buildId) {
144
144
  });
145
145
  });
146
146
  }
147
+ commandCrawlRun.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_CRAWL_RUN}`);
147
148
  exports.default = commandCrawlRun;
@@ -10,4 +10,7 @@ const link_1 = __importDefault(require("./crawl/link"));
10
10
  const commandCrawl = (0, utils_1.newCommand)('crawl', texts_1.DESC_COMMAND_CRAWL);
11
11
  commandCrawl.addCommand(run_1.default);
12
12
  commandCrawl.addCommand(link_1.default);
13
+ commandCrawl.addHelpText('after', `
14
+ EXAMPLES:${texts_1.EXAMPLE_CRAWL_RUN}
15
+ ${texts_1.EXAMPLE_CRAWL_LINK}`);
13
16
  exports.default = commandCrawl;
@@ -100,4 +100,5 @@ function filterDuplicates(urls) {
100
100
  duplicates: Array.from(duplicates),
101
101
  };
102
102
  }
103
+ commandCapture.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_TESTS_CAPTURE}`);
103
104
  exports.default = commandCapture;
@@ -58,4 +58,5 @@ commandUtLink.action(async (options) => {
58
58
  output_1.default.okSign();
59
59
  output_1.default.exitSuccess(texts_1.TXT_COMMAND_UT_LINK_SUCCESS);
60
60
  });
61
+ commandUtLink.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_TESTS_UNIT_LINK}`);
61
62
  exports.default = commandUtLink;
@@ -42,6 +42,7 @@ commandUtUpload.action(async (input, options) => {
42
42
  await sendUploadRequest(ctx, files);
43
43
  output_1.default.exitSuccess('Upload completed');
44
44
  });
45
+ commandUtUpload.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_TESTS_UNIT_UPLOAD}`);
45
46
  exports.default = commandUtUpload;
46
47
  function validateInputAndOptions(input, options) {
47
48
  const z = require('zod');
@@ -10,4 +10,7 @@ const link_1 = __importDefault(require("./unit/link"));
10
10
  const commandUnit = (0, utils_1.newCommand)('unit', texts_1.DESC_COMMAND_UNIT);
11
11
  commandUnit.addCommand(upload_1.default);
12
12
  commandUnit.addCommand(link_1.default);
13
+ commandUnit.addHelpText('after', `
14
+ EXAMPLES:${texts_1.EXAMPLE_TESTS_UNIT_UPLOAD}
15
+ ${texts_1.EXAMPLE_TESTS_UNIT_LINK}`);
13
16
  exports.default = commandUnit;
@@ -58,4 +58,5 @@ commandVisualLink.action(async (options) => {
58
58
  output_1.default.okSign();
59
59
  output_1.default.exitSuccess(texts_1.TXT_COMMAND_VT_LINK_SUCCESS);
60
60
  });
61
+ commandVisualLink.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_TESTS_VISUAL_LINK}`);
61
62
  exports.default = commandVisualLink;
@@ -29,4 +29,5 @@ commandSessionClose.action(async () => {
29
29
  output_1.default.exitError(`${error}`);
30
30
  }
31
31
  });
32
+ commandSessionClose.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE}`);
32
33
  exports.default = commandSessionClose;
@@ -82,4 +82,5 @@ commandSessionCreate.action(async (command, options) => {
82
82
  output_1.default.exitError(`${error}`);
83
83
  }
84
84
  });
85
+ commandSessionCreate.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CREATE}`);
85
86
  exports.default = commandSessionCreate;
@@ -10,4 +10,7 @@ const close_1 = __importDefault(require("./session/close"));
10
10
  const commandSession = (0, utils_1.newCommand)('session', texts_1.DESC_COMMAND_SESSION);
11
11
  commandSession.addCommand(create_1.default);
12
12
  commandSession.addCommand(close_1.default);
13
+ commandSession.addHelpText('after', `
14
+ EXAMPLES:${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CREATE}
15
+ ${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE}`);
13
16
  exports.default = commandSession;
@@ -17,4 +17,5 @@ commandVisualSetup.action(async () => {
17
17
  output_1.default.exitError(`${error}`);
18
18
  }
19
19
  });
20
+ commandVisualSetup.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_TESTS_VISUAL_SETUP}`);
20
21
  exports.default = commandVisualSetup;
@@ -138,4 +138,5 @@ function getStorybookSnapshots(storiesList) {
138
138
  output_1.default.normal((0, texts_1.TXT_STORIES_AMOUNT)(stories.length));
139
139
  return stories;
140
140
  }
141
+ commandVisualUpload.addHelpText('after', `\nEXAMPLES:${texts_1.EXAMPLE_TESTS_VISUAL_UPLOAD}`);
141
142
  exports.default = commandVisualUpload;
@@ -14,4 +14,10 @@ commandVisual.addCommand(setup_1.default);
14
14
  commandVisual.addCommand(upload_1.default);
15
15
  commandVisual.addCommand(session_1.default);
16
16
  commandVisual.addCommand(link_1.default);
17
+ commandVisual.addHelpText('after', `
18
+ EXAMPLES:${texts_1.EXAMPLE_TESTS_VISUAL_SETUP}
19
+ ${texts_1.EXAMPLE_TESTS_VISUAL_UPLOAD}
20
+ ${texts_1.EXAMPLE_TESTS_VISUAL_LINK}
21
+ ${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CREATE}
22
+ ${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE}`);
17
23
  exports.default = commandVisual;
@@ -12,4 +12,13 @@ const commandTests = (0, utils_1.newCommand)('tests', texts_1.DESC_COMMAND_TESTS
12
12
  commandTests.addCommand(unit_1.default);
13
13
  commandTests.addCommand(visual_1.default);
14
14
  commandTests.addCommand(capture_1.default);
15
+ commandTests.addHelpText('after', `
16
+ EXAMPLES:${texts_1.EXAMPLE_TESTS_UNIT_UPLOAD}
17
+ ${texts_1.EXAMPLE_TESTS_UNIT_LINK}
18
+ ${texts_1.EXAMPLE_TESTS_VISUAL_SETUP}
19
+ ${texts_1.EXAMPLE_TESTS_VISUAL_UPLOAD}
20
+ ${texts_1.EXAMPLE_TESTS_VISUAL_LINK}
21
+ ${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CREATE}
22
+ ${texts_1.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE}
23
+ ${texts_1.EXAMPLE_TESTS_CAPTURE}`);
15
24
  exports.default = commandTests;
@@ -16,7 +16,7 @@ exports.DESC_COMMAND_LOGIN = exports.ERR_API_MEDIA_TYPE_NOT_IMPLEMENTED = export
16
16
  exports.ERR_COMMAND_ROUTE_NO_UPDATE = exports.ERR_COMMAND_DISTRO_NOT_FOUND = exports.ERR_COMMAND_DISTRO_SCOPE = exports.TXT_COMMAND_ROUTE_UPDATED = exports.TXT_ROUTE_SERVE = exports.TXT_COMMAND_ROUTE_CREATED = exports.TXT_COMMAND_DISTRO_CREATED = exports.ERR_COMMAND_DISTRO_NO_PROJECT = exports.OPT_COMMAND_DISTRO_NAME = exports.OPT_COMMAND_ROUTE_TARGET = exports.OPT_COMMAND_ROUTE_PATH = exports.OPT_COMMAND_ROUTE_DOMAIN = exports.OPT_COMMAND_ROUTE_SUBDOMAIN = exports.OPT_COMMAND_ROUTE_TYPE = exports.OPT_COMMAND_ROUTE_ID = exports.OPT_COMMAND_DISTRO_IDENTIFIER = exports.OPT_COMMAND_DISTRO_SCOPE = exports.DESC_COMMAND_ROUTE = exports.DESC_COMMAND_ROUTE_UPDATE = exports.DESC_COMMAND_ROUTE_DELETE = exports.DESC_COMMAND_ROUTE_LIST = exports.DESC_COMMAND_DISTRO_LIST = exports.DESC_COMMAND_DISTRO_DELETE = exports.DESC_COMMAND_ROUTE_CREATE = exports.DESC_COMMAND_DISTRO_CREATE = exports.DESC_COMMAND_DISTRO = exports.ERR_API_MESSAGE_REPLACER = exports.ERR_LOGIN_INVALID_BASE_URL = exports.ERR_LOGIN_NO_WORKSPACE_FOUND = exports.ERR_LOGIN_NO_WORKSPACES = exports.ERR_LOGIN_HTTP_CANCEL = exports.ERR_LOGIN_HTTP_FAILED = exports.ERR_LOGIN_HTTP_SERVER_PORT_TAKEN = exports.TXT_LOGIN_SUCCESS = exports.TXT_LOGIN_SELECT_WORKSPACE = exports.TXT_LOGIN_ENTER_BASE_URL = exports.TXT_LOGIN_PROVIDE_CODE = exports.TXT_LOGIN_OPEN_URL = exports.TXT_LOGIN_OPENING_STAR = exports.TXT_LOGIN_OPENING = exports.TXT_LOGIN_SELECT_REGION = exports.TXT_WORKSPACE_NONE = exports.TXT_WORKSPACE_SET_SUCCESS = exports.ARG_COMMAND_WORKSPACE = exports.DESC_COMMAND_WORKSPACE_GET = exports.DESC_COMMAND_WORKSPACE_SET = exports.DESC_COMMAND_WORKSPACE_LIST = exports.DESC_COMMAND_WORKSPACE = exports.TXT_LOGOUT_SUCCESS = exports.DESC_COMMAND_LOGOUT = void 0;
17
17
  exports.TXT_ARTIFACT_CREATED = exports.TXT_ARTIFACT_VERSION_DELETED = exports.TXT_ARTIFACT_DELETED = exports.ERR_COMMAND_ARTIFACT_TYPE = exports.OPT_COMMAND_ARTIFACT_VERSION = exports.OPT_COMMAND_ARTIFACT_IDENTIFIER = exports.OPT_COMMAND_ARTIFACT_CREATE_IDENTIFIER = exports.OPT_COMMAND_ARTIFACT_NAME = exports.OPT_COMMAND_ARTIFACT_TYPE = exports.DESC_COMMAND_ARTIFACT_CREATE = exports.DESC_COMMAND_ARTIFACT_GET = exports.TXT_ARTIFACT_DOCKER_LOGIN_FAILED = exports.TXT_ARTIFACT_DOCKER_LOGIN_SUCCESS = exports.TXT_ARTIFACT_VERSION_DELETE_CONFIRM = exports.TXT_ARTIFACT_DELETE_CONFIRM = exports.DESC_COMMAND_ARTIFACT_DELETE = exports.ERR_COMMAND_ARTIFACT_NO_PROJECTS = exports.DESC_COMMAND_ARTIFACT_VERSION_GET = exports.DESC_COMMAND_ARTIFACT_VERSION_LIST = exports.DESC_COMMAND_ARTIFACT_VERSION_DELETE = exports.DESC_COMMAND_ARTIFACT_DOCKER_LOGIN = exports.DESC_COMMAND_ARTIFACT_LIST = exports.DESC_COMMAND_ARTIFACT_VERSION = exports.ERR_COMMAND_DOMAIN_UNAVAILABLE = exports.OPTION_COMMAND_DOMAIN_IDENTIFIER = exports.ERR_COMMAND_DOMAIN_NO_DOMAINS = exports.TXT_COMMAND_DOMAIN_PROMPT_REQUIRED = exports.TXT_COMMAND_DOMAIN_BUY_SELECT_DOMAIN = exports.TXT_COMMAND_DOMAIN_PROVIDE_PROMPT = exports.ERR_COMMAND_DOMAIN_NOT_FOUND = exports.OPT_COMMAND_DOMAIN_ONLY_AVAILABLE = exports.OPT_COMMAND_DOMAIN_SORT = exports.OPT_COMMAND_DOMAIN_PHRASE = exports.OPT_COMMAND_DOMAIN_BUY_OWNER = exports.OPT_COMMAND_DOMAIN_BUY_TLD = exports.DESC_COMMAND_DOMAIN_GET = exports.DESC_COMMAND_DOMAIN_LIST = exports.DESC_COMMAND_DOMAIN_SEARCH = exports.DESC_COMMAND_DOMAIN_BUY = exports.DESC_COMMAND_DOMAIN = exports.ERR_ROUTE_NO_DEFAULT = exports.ERR_WRONG_ROUTE_TARGET = exports.ERR_COMMAND_ROUTE_NO_TARGET = exports.ERR_COMMAND_ROUTE_TYPE = exports.TXT_COMMAND_ROUTES_NOT_FOUND = exports.TXT_COMMAND_DISTROS_NOT_FOUND = exports.TXT_COMMAND_ROUTE_DELETED = exports.TXT_COMMAND_DISTRO_DELETED = exports.TXT_COMMAND_ROUTE_DELETE_CONFIRM = exports.TXT_COMMAND_DISTRO_DELETE_CONFIRM = void 0;
18
18
  exports.EXAMPLE_SANDBOX_APP_LIST = exports.EXAMPLE_SANDBOX_EXEC_KILL = exports.EXAMPLE_SANDBOX_EXEC_COMMAND = exports.EXAMPLE_TUNNEL_START = exports.EXAMPLE_TUNNEL_TCP = exports.EXAMPLE_TUNNEL_TLS = exports.EXAMPLE_AGENT_TUNNEL_START = exports.EXAMPLE_AGENT_TUNNEL_STATUS = exports.EXAMPLE_AGENT_TUNNEL_REMOVE = exports.EXAMPLE_AGENT_TUNNEL_LIST = exports.EXAMPLE_TUNNEL_HTTP = exports.EXAMPLE_SANDBOX_CREATE = exports.EXAMPLE_DISTRO_CREATE = exports.EXAMPLE_ROUTE_CREATE = exports.EXAMPLE_ROUTE_LIST = exports.EXAMPLE_ROUTE_UPDATE = exports.EXAMPLE_ROUTE_DELETE = exports.EXAMPLE_DISTRO_DELETE = exports.EXAMPLE_DISTRO_LIST = exports.EXAMPLE_SANDBOX_CP = exports.ERR_PROJECT_NO_PROJECTS = exports.TXT_LOGIN_SELECT_PROJECT = exports.TXT_COMMAND_PROJECT_CREATED = exports.TXT_COMMAND_PROJECT_LINK_NOT_FOUND = exports.TXT_COMMAND_PROJECT_LINK_NAME = exports.TXT_COMMAND_PROJECT_LINK_SELECT_PROJECT = exports.TXT_COMMAND_PROJECT_LINK_TO = exports.TXT_COMMAND_PROJECT_LINK_EXISTING_DESC = exports.TXT_COMMAND_PROJECT_LINK_EXISTING = exports.TXT_COMMAND_PROJECT_LINK_CREATE_NEW_DESC = exports.TXT_COMMAND_PROJECT_LINK_CREATE_NEW = exports.ERR_COMMAND_PROJECT_LINK_DIR_NOT_DIR = exports.TXT_COMMAND_PROJECT_LINK_GIT_REPO_INITIALIZED = exports.TXT_COMMAND_PROJECT_LINK_GIT_REPO = exports.TXT_COMMAND_PROJECT_LINK_DIR_CONFIRM = exports.TXT_COMMAND_PROJECT_LINK_DIR_LINKED = exports.ERR_COMMAND_PROJECT_LINK_DIR_CREATE = exports.OPT_COMMAND_PROJECT_LINK_TRY_NOW = exports.OPT_COMMAND_PROJECT_LINK_SET_GIT_REMOTE = exports.OPT_COMMAND_PROJECT_LINK_HAS_REMOTE = exports.OPT_COMMAND_PROJECT_LINK_DIRECTORY = exports.OPT_COMMAND_PROJECT_LINK_GIT = exports.OPT_COMMAND_PROJECT_LINK_RELINK = exports.DESC_COMMAND_PROJECT_LINK = exports.DESC_COMMAND_PROJECT_LIST = exports.DESC_COMMAND_PROJECT_GIT = exports.DESC_COMMAND_PROJECT_GIT_CREDENTIAL = exports.DESC_COMMAND_PROJECT = exports.TXT_ARTIFACT_VERSION_DOWNLOAD = exports.TXT_ARTIFACT_PUBLISH = void 0;
19
- exports.EXAMPLE_ARTIFACT_VERSION_DELETE = exports.EXAMPLE_ARTIFACT_VERSION_GET = exports.EXAMPLE_ARTIFACT_VERSION_LIST = exports.EXAMPLE_ARTIFACT_CREATE = exports.EXAMPLE_ARTIFACT_DELETE = exports.EXAMPLE_ARTIFACT_DOWNLOAD = exports.EXAMPLE_ARTIFACT_PUBLISH = exports.EXAMPLE_PIPELINE_RUN_RETRY = exports.EXAMPLE_PIPELINE_RUN_LIST = exports.EXAMPLE_PIPELINE_LIST = exports.EXAMPLE_PIPELINE_YML = exports.EXAMPLE_PIPELINE_GET = exports.EXAMPLE_PIPELINE_UPDATE = exports.EXAMPLE_PIPELINE_DELETE = exports.EXAMPLE_PIPELINE_CREATE = exports.EXAMPLE_PIPELINE_RUN_CANCEL = exports.EXAMPLE_PIPELINE_RUN_APPLY = exports.EXAMPLE_PIPELINE_RUN_LOGS = exports.EXAMPLE_PIPELINE_RUN_JSONL = exports.EXAMPLE_PIPELINE_RUN_STATUS = exports.EXAMPLE_PIPELINE_RUN_START = exports.EXAMPLE_SANDBOX_ENDPOINT_LIST = exports.EXAMPLE_SANDBOX_ENDPOINT_GET = exports.EXAMPLE_SANDBOX_ENDPOINT_DELETE = exports.EXAMPLE_SANDBOX_ENDPOINT_CREATE = exports.EXAMPLE_SANDBOX_SNAPSHOT_LIST = exports.EXAMPLE_SANDBOX_SNAPSHOT_GET = exports.EXAMPLE_SANDBOX_SNAPSHOT_DELETE = exports.EXAMPLE_SANDBOX_SNAPSHOT_CREATE = exports.EXAMPLE_SANDBOX_EXEC_STATUS = exports.EXAMPLE_SANDBOX_EXEC_LOGS = exports.EXAMPLE_SANDBOX_APP_STATUS = exports.EXAMPLE_SANDBOX_APP_STOP = exports.EXAMPLE_SANDBOX_APP_REMOVE = exports.EXAMPLE_SANDBOX_APP_ADD = exports.EXAMPLE_SANDBOX_APP_START = exports.EXAMPLE_SANDBOX_APP_LOGS = exports.EXAMPLE_SANDBOX_EXEC_LIST = void 0;
19
+ exports.EXAMPLE_CRAWL_LINK = exports.EXAMPLE_CRAWL_RUN = exports.EXAMPLE_TESTS_CAPTURE = exports.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE = exports.EXAMPLE_TESTS_VISUAL_SESSION_CREATE = exports.EXAMPLE_TESTS_VISUAL_LINK = exports.EXAMPLE_TESTS_VISUAL_UPLOAD = exports.EXAMPLE_TESTS_VISUAL_SETUP = exports.EXAMPLE_TESTS_UNIT_LINK = exports.EXAMPLE_TESTS_UNIT_UPLOAD = exports.EXAMPLE_ARTIFACT_VERSION_DELETE = exports.EXAMPLE_ARTIFACT_VERSION_GET = exports.EXAMPLE_ARTIFACT_VERSION_LIST = exports.EXAMPLE_ARTIFACT_CREATE = exports.EXAMPLE_ARTIFACT_DELETE = exports.EXAMPLE_ARTIFACT_DOWNLOAD = exports.EXAMPLE_ARTIFACT_PUBLISH = exports.EXAMPLE_PIPELINE_RUN_RETRY = exports.EXAMPLE_PIPELINE_RUN_LIST = exports.EXAMPLE_PIPELINE_LIST = exports.EXAMPLE_PIPELINE_YML = exports.EXAMPLE_PIPELINE_GET = exports.EXAMPLE_PIPELINE_UPDATE = exports.EXAMPLE_PIPELINE_DELETE = exports.EXAMPLE_PIPELINE_CREATE = exports.EXAMPLE_PIPELINE_RUN_CANCEL = exports.EXAMPLE_PIPELINE_RUN_APPLY = exports.EXAMPLE_PIPELINE_RUN_LOGS = exports.EXAMPLE_PIPELINE_RUN_JSONL = exports.EXAMPLE_PIPELINE_RUN_STATUS = exports.EXAMPLE_PIPELINE_RUN_START = exports.EXAMPLE_SANDBOX_ENDPOINT_LIST = exports.EXAMPLE_SANDBOX_ENDPOINT_GET = exports.EXAMPLE_SANDBOX_ENDPOINT_DELETE = exports.EXAMPLE_SANDBOX_ENDPOINT_CREATE = exports.EXAMPLE_SANDBOX_SNAPSHOT_LIST = exports.EXAMPLE_SANDBOX_SNAPSHOT_GET = exports.EXAMPLE_SANDBOX_SNAPSHOT_DELETE = exports.EXAMPLE_SANDBOX_SNAPSHOT_CREATE = exports.EXAMPLE_SANDBOX_EXEC_STATUS = exports.EXAMPLE_SANDBOX_EXEC_LOGS = exports.EXAMPLE_SANDBOX_APP_STATUS = exports.EXAMPLE_SANDBOX_APP_STOP = exports.EXAMPLE_SANDBOX_APP_REMOVE = exports.EXAMPLE_SANDBOX_APP_ADD = exports.EXAMPLE_SANDBOX_APP_START = exports.EXAMPLE_SANDBOX_APP_LOGS = exports.EXAMPLE_SANDBOX_EXEC_LIST = void 0;
20
20
  const utils_1 = require("./utils");
21
21
  exports.ERR_CANCELLED = 'Cancelled';
22
22
  exports.ERR_REST_API_GENERAL_ERROR = 'Something went wrong';
@@ -297,21 +297,21 @@ exports.DESC_COMMAND_PIPELINE_DELETE = 'Pipeline delete. Required scopes: EXECUT
297
297
  exports.DESC_COMMAND_PIPELINE_UPDATE = 'Pipeline update. Required scopes: EXECUTION_RUN';
298
298
  exports.DESC_COMMAND_PIPELINE_GET = 'Pipeline info. Required scopes: EXECUTION_INFO';
299
299
  exports.DESC_COMMAND_PIPELINE_RUN_RETRY = 'Pipeline run retry. Required scopes: EXECUTION_RUN';
300
- exports.DESC_COMMAND_TESTS = 'Commands to interact with the test services';
301
- exports.DESC_COMMAND_UNIT = 'Commands to interact with the unit test service';
302
- exports.DESC_COMMAND_VISUAL = 'Commands to interact with the visual test service';
300
+ exports.DESC_COMMAND_TESTS = 'Manage unit tests and visual regression (Storybook, URL captures, test runners)';
301
+ exports.DESC_COMMAND_UNIT = 'Manage unit testing (JUnit XML report uploads, suite linking)';
302
+ exports.DESC_COMMAND_VISUAL = 'Manage visual regression testing across Storybook, URL captures, and test runners';
303
303
  exports.DESC_COMMAND_SESSION = 'Manage visual test sessions';
304
- exports.DESC_COMMAND_SESSION_CREATE = 'Run tests which use visual service plugin';
305
- exports.DESC_COMMAND_SESSION_CLOSE = 'Close visual test session';
306
- exports.DESC_COMMAND_VISUAL_SETUP = 'Install browser for visual test';
307
- exports.DESC_COMMAND_VISUAL_UPLOAD = 'Create visual test session from storybook';
308
- exports.DESC_COMMAND_CAPTURE = 'Create visual test session for specific set of urls';
309
- exports.DESC_COMMAND_CRAWL = 'Commands to interact with the crawl service';
310
- exports.DESC_COMMAND_CRAWL_RUN = 'Run a crawl session';
304
+ exports.DESC_COMMAND_SESSION_CREATE = 'Run a test command and create a visual test session from emitted snapshots';
305
+ exports.DESC_COMMAND_SESSION_CLOSE = 'Close a parallel visual test session early (skip auto-close timeout)';
306
+ exports.DESC_COMMAND_VISUAL_SETUP = 'Install the resource-discovery browser used by `bdy tests visual session create`';
307
+ exports.DESC_COMMAND_VISUAL_UPLOAD = 'Upload a built Storybook to create a visual test session';
308
+ exports.DESC_COMMAND_CAPTURE = 'Create a visual test session from an explicit URL list, a URLs file, or a sitemap';
309
+ exports.DESC_COMMAND_CRAWL = 'Manage web crawls (Markdown, HTML, PNG/JPEG screenshots; suite linking)';
310
+ exports.DESC_COMMAND_CRAWL_RUN = 'Crawl a URL and download the package (PNG/JPEG/MD/HTML) to --outputDir';
311
311
  exports.DESC_COMMAND_UT_UPLOAD = 'Upload unit test reports';
312
- exports.DESC_COMMAND_VT_LINK = 'Link directory with a visual test suite';
313
- exports.DESC_COMMAND_CRAWL_LINK = 'Link directory with a crawl suite';
314
- exports.DESC_COMMAND_UT_LINK = 'Link directory with a unit test suite';
312
+ exports.DESC_COMMAND_VT_LINK = 'Link current directory to a visual test suite';
313
+ exports.DESC_COMMAND_CRAWL_LINK = 'Link current directory to a crawl suite';
314
+ exports.DESC_COMMAND_UT_LINK = 'Link current directory to a unit test suite';
315
315
  exports.OPTION_SUITE_IDENTIFIER = 'Suite identifier';
316
316
  exports.TXT_COMMAND_VT_LINK_SELECT = 'Select visual test suite';
317
317
  exports.TXT_COMMAND_CRAWL_LINK_SELECT = 'Select crawl suite';
@@ -331,9 +331,9 @@ exports.TXT_COMMAND_SUITE_LINK_EXISTING = 'Link existing';
331
331
  exports.TXT_COMMAND_SUITE_LINK_EXISTING_DESC = 'Link to an existing suite';
332
332
  exports.TXT_COMMAND_SUITE_NAME = 'Provide suite name:';
333
333
  exports.TXT_COMMAND_SUITE_CREATED = 'Suite created';
334
- exports.OPTION_UPLOAD_REPORT_GLOB = 'Glob for reports';
334
+ exports.OPTION_UPLOAD_REPORT_GLOB = 'Glob pattern matching report files';
335
335
  exports.OPTION_UPLOAD_REPORT_FORMAT = 'Format of the reports';
336
- exports.OPTION_UPLOAD_DRY_RUN = 'Run command without uploading reports';
336
+ exports.OPTION_UPLOAD_DRY_RUN = 'List matched files without uploading';
337
337
  const TXT_NEW_CLI_DOCKER_VERSION = (version) => `New version of bdy Docker image is available! (${version})\n\n`;
338
338
  exports.TXT_NEW_CLI_DOCKER_VERSION = TXT_NEW_CLI_DOCKER_VERSION;
339
339
  exports.TXT_NEW_AGENT_VERSION = 'Agent upgrade required. Update the agent by running:\n`bdy agent update`\n\n';
@@ -444,33 +444,33 @@ exports.OPTION_AGENT_TAG = 'Tag agent. Can be passed multiple times';
444
444
  exports.OPTION_AGENT_PORT = 'Agent API port';
445
445
  exports.OPTION_AGENT_DEBUG = 'Turns on debug mode';
446
446
  exports.OPTION_EXEC_COMMAND = 'Test runner command';
447
- exports.OPTION_EXEC_SKIP_DISCOVERY = 'Skip resource discovery';
448
- exports.OPTION_EXEC_ONE_BY_ONE = 'Send snapshots one by one';
449
- exports.OPTION_EXEC_PARALLEL = 'Send parts of session from different processes';
450
- exports.OPTION_COMPARE_FOLLOW = 'Crawl all subviews of the page';
447
+ exports.OPTION_EXEC_SKIP_DISCOVERY = 'Skip post-snapshot resource discovery (debugging or asset-free pages)';
448
+ exports.OPTION_EXEC_ONE_BY_ONE = 'Send snapshots progressively for early review during long runs';
449
+ exports.OPTION_EXEC_PARALLEL = 'Run as part of a parallel session (multi-machine/process)';
450
+ exports.OPTION_COMPARE_FOLLOW = 'Follow same-origin links and capture all reachable pages';
451
451
  exports.OPTION_COMPARE_RESPECT_ROBOTS = 'Respect robots.txt';
452
- exports.OPTION_COMPARE_URLS = 'Urls to compare (comma separated list, e.g., --urls "https://example.com,https://example.org")';
453
- exports.OPTION_COMPARE_SITEMAP = 'Url from which sitemap will be gathered (e.g., --sitemap "https://example.com")';
454
- exports.OPTION_COMPARE_URLS_FILE = 'File with urls to compare (e.g., --urlsFile "urls.txt")';
455
- exports.OPTION_COMPARE_DRY_RUN = 'Run command without sending urls list to Buddy';
456
- exports.OPTION_COMPARE_IGNORE_URLS = 'Ignore urls matching the regex pattern (e.g., --ignoreUrls "https://example.com/.*")';
452
+ exports.OPTION_COMPARE_URLS = 'URLs to compare (comma-separated list, e.g., --urls "https://example.com,https://example.org")';
453
+ exports.OPTION_COMPARE_SITEMAP = 'URL of a sitemap to fetch URLs from (e.g., --sitemap "https://example.com/sitemap.xml")';
454
+ exports.OPTION_COMPARE_URLS_FILE = 'File with URLs to compare (e.g., --urlsFile "urls.txt")';
455
+ exports.OPTION_COMPARE_DRY_RUN = 'Print the URL list without sending it to Buddy';
456
+ exports.OPTION_COMPARE_IGNORE_URLS = 'Ignore URLs whose full URL matches the regex (e.g., --ignoreUrls "https://example.com/admin/.*")';
457
457
  exports.OPTION_COMPARE_IGNORE = 'Ignore elements matching selectors while comparing (format: [scope::]type=value, e.g., --ignore "CSS=.ad-banner" "XPATH=//div[@id=\'popup\']" "example.com::CSS=.cookie-notice")';
458
- exports.OPTION_COMPARE_COOKIE = 'Set cookies used when visiting the urls (format: [scope::]cookie_value, e.g., --cookie "session=abc123" "example.com::auth=token123; Path=/; Secure; HttpOnly")';
459
- exports.OPTION_COMPARE_HEADER = 'Set HTTP headers used when visiting the urls (format: [scope::]name=value, e.g., --header "Authorization=Bearer token" "example.com::Accept=application/json")';
458
+ exports.OPTION_COMPARE_COOKIE = 'Set cookies used when visiting the URLs (format: [scope::]cookie_value, e.g., --cookie "session=abc123" "example.com::auth=token123; Path=/; Secure; HttpOnly")';
459
+ exports.OPTION_COMPARE_HEADER = 'Set HTTP headers used when visiting the URLs (format: [scope::]name=value, e.g., --header "Authorization=Bearer token" "example.com::Accept=application/json")';
460
460
  exports.OPTION_COMPARE_DELAY = 'Add delay in milliseconds before taking screenshot (1-60000, format: [scope::]milliseconds, e.g., --delay "1000" "example.com::2000")';
461
461
  exports.OPTION_COMPARE_WAIT_FOR = 'Wait for elements to appear before taking screenshot (format: [scope::]type=value, e.g., --waitFor "CSS=#content" "example.com::XPATH=//div[@class=\'loaded\']")';
462
462
  exports.OPTION_CRAWL_URL = 'URL to crawl (optional; defaults to crawl suite URL)';
463
- exports.OPTION_CRAWL_FOLLOW = 'Crawl all subviews of the page';
463
+ exports.OPTION_CRAWL_FOLLOW = 'Follow same-origin links and crawl all reachable pages';
464
464
  exports.OPTION_CRAWL_OUTPUT_TYPE = 'Output type';
465
- exports.OPTION_CRAWL_QUALITY = 'Quality of the png output (default: "100")';
466
- exports.OPTION_CRAWL_FULL_PAGE = 'Crawl full page';
467
- exports.OPTION_CRAWL_CSS_SELECTOR = 'CSS selector to crawl';
468
- exports.OPTION_CRAWL_XPATH_SELECTOR = 'XPath selector to crawl';
465
+ exports.OPTION_CRAWL_QUALITY = 'JPEG output quality (1-100)';
466
+ exports.OPTION_CRAWL_FULL_PAGE = 'Capture full-page screenshots (not just the viewport)';
467
+ exports.OPTION_CRAWL_CSS_SELECTOR = 'CSS selector to scope the snapshot/extraction';
468
+ exports.OPTION_CRAWL_XPATH_SELECTOR = 'XPath selector to scope the snapshot/extraction';
469
469
  exports.OPTION_CRAWL_COLOR_SCHEME = 'Color scheme to use (LIGHT, DARK, LIGHT_AND_DARK)';
470
- exports.OPTION_CRAWL_BROWSERS = 'Browsers to use (comma separated: chrome,firefox,safari)';
470
+ exports.OPTION_CRAWL_BROWSERS = 'Browsers to use (comma-separated: chrome,firefox,safari)';
471
471
  exports.OPTION_CRAWL_DEVICES = 'Devices definition as JSON array (e.g., --devices \'[{"viewport":"1920x1080","screen":"1920x1080","devicePixelRatio":1,"isMobile":false}]\')';
472
- exports.OPTION_CRAWL_LOCAL_STORAGE = 'Set localStorage values used when visiting urls (format: [scope::]key=value)';
473
- exports.OPTION_CRAWL_DELAY = 'Delay in milliseconds';
472
+ exports.OPTION_CRAWL_LOCAL_STORAGE = 'Set localStorage values used when visiting URLs (format: [scope::]key=value)';
473
+ exports.OPTION_CRAWL_DELAY = 'Delay in milliseconds before capture (format: [scope::]ms)';
474
474
  exports.OPTION_CRAWL_OUTPUT_DIR = 'Output directory';
475
475
  exports.OPTION_CRAWL_OUTPUT_TYPES = 'Output types as JSON array (e.g., --outputTypes \'[{"type":"md","selector":{"type":"CSS","value":".main"}},{"type":"jpeg","quality":80,"fullPage":true}]\')';
476
476
  exports.LOG_REGISTERING_AGENT = 'Registering agent...';
@@ -1384,3 +1384,55 @@ EXAMPLES:
1384
1384
  bdy art ver rm artifact-identifier version
1385
1385
  ### delete artifact version and automatically confirm deletion:
1386
1386
  bdy art ver rm artifact-identifier version -f`;
1387
+ exports.EXAMPLE_TESTS_UNIT_UPLOAD = `
1388
+ ### upload junit xml report:
1389
+ bdy tests unit upload "reports/**/*.xml" --format junit-xml
1390
+ ### preview which files would be uploaded without sending:
1391
+ bdy tests unit upload "reports/**/*.xml" --format junit-xml --dryRun`;
1392
+ exports.EXAMPLE_TESTS_UNIT_LINK = `
1393
+ ### interactively link current directory to a unit test suite:
1394
+ bdy tests unit link
1395
+ ### link non-interactively to a specific suite:
1396
+ bdy tests unit link -w workspace -p project -s suite-identifier`;
1397
+ exports.EXAMPLE_TESTS_VISUAL_SETUP = `
1398
+ ### install the resource-discovery browser (needed by \`session create\` unless --skipDiscovery):
1399
+ bdy tests visual setup`;
1400
+ exports.EXAMPLE_TESTS_VISUAL_UPLOAD = `
1401
+ ### upload a built Storybook to the linked visual test suite:
1402
+ bdy tests visual upload`;
1403
+ exports.EXAMPLE_TESTS_VISUAL_LINK = `
1404
+ ### interactively link current directory to a visual test suite:
1405
+ bdy tests visual link
1406
+ ### link non-interactively to a specific suite:
1407
+ bdy tests visual link -w workspace -p project -s suite-identifier`;
1408
+ exports.EXAMPLE_TESTS_VISUAL_SESSION_CREATE = `
1409
+ ### run your test command with the visual-test plugin server attached:
1410
+ bdy tests visual session create "npm test"
1411
+ ### skip resource discovery (debugging or asset-free pages):
1412
+ bdy tests visual session create "npm test" --skipDiscovery
1413
+ ### send snapshots progressively (quicker review during long runs):
1414
+ bdy tests visual session create "npm test" --oneByOne
1415
+ ### one runner in a parallel session (every runner must share the same $SNAPSHOTS_BUILD_ID):
1416
+ bdy tests visual session create "npm test" --parallel`;
1417
+ exports.EXAMPLE_TESTS_VISUAL_SESSION_CLOSE = `
1418
+ ### close the session after all parallel runners finished (build id read from $SNAPSHOTS_BUILD_ID):
1419
+ bdy tests visual session close`;
1420
+ exports.EXAMPLE_TESTS_CAPTURE = `
1421
+ ### capture an explicit list of urls:
1422
+ bdy tests capture --urls "https://example.com,https://example.com/about"
1423
+ ### capture from a sitemap and follow links:
1424
+ bdy tests capture --sitemap https://example.com/sitemap.xml --follow
1425
+ ### capture from a urls file and ignore a globbed selector:
1426
+ bdy tests capture --urlsFile ./urls.txt --ignore "header>.banner"`;
1427
+ exports.EXAMPLE_CRAWL_RUN = `
1428
+ ### crawl a single page and save md/html into current dir:
1429
+ bdy crawl run https://example.com --outputType md
1430
+ ### follow links and capture full-page screenshots in dark mode:
1431
+ bdy crawl run https://example.com --follow --fullPage --outputType png --colorScheme DARK --outputDir ./out
1432
+ ### crawl with multiple output types and a specific css selector:
1433
+ bdy crawl run https://example.com --outputTypes '["jpeg","md"]' --cssSelector "main"`;
1434
+ exports.EXAMPLE_CRAWL_LINK = `
1435
+ ### interactively link current directory to a crawl suite:
1436
+ bdy crawl link
1437
+ ### link non-interactively to a specific suite:
1438
+ bdy crawl link -w workspace -p project -s suite-identifier`;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "bdy",
3
3
  "preferGlobal": false,
4
- "version": "1.22.47-dev",
4
+ "version": "1.22.48-dev",
5
5
  "type": "commonjs",
6
6
  "license": "MIT",
7
7
  "scripts": {