checkly 6.0.1 → 6.1.0-prerelease-d4c1886

package/dist/commands/pw-test.js

@@ -0,0 +1,316 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const authCommand_1 = require("./authCommand");
+const util_1 = require("../services/util");
+const checkly_config_loader_1 = require("../services/checkly-config-loader");
+const test_helper_1 = require("../helpers/test-helper");
+const api = __importStar(require("../rest/api"));
+const config_1 = __importDefault(require("../services/config"));
+const project_parser_1 = require("../services/project-parser");
+const constructs_1 = require("../constructs");
+const core_1 = require("@oclif/core");
+const reporter_1 = require("../reporters/reporter");
+const test_runner_1 = __importDefault(require("../services/test-runner"));
+const abstract_check_runner_1 = require("../services/abstract-check-runner");
+const common_messages_1 = __importDefault(require("../messages/common-messages"));
+const node_path_1 = __importDefault(require("node:path"));
+const recast = __importStar(require("recast"));
+const write_config_helpers_1 = require("../helpers/write-config-helpers");
+const JSON5 = __importStar(require("json5"));
+const package_manager_1 = require("../services/check-parser/package-files/package-manager");
+const constants_1 = require("../helpers/constants");
+const sourcegen_1 = require("../sourcegen");
+class PwTestCommand extends authCommand_1.AuthCommand {
+    static coreCommand = true;
+    static hidden = false;
+    static description = 'Test your Playwright Tests on Checkly.';
+    static state = 'beta';
+    static flags = {
+        'location': core_1.Flags.string({
+            char: 'l',
+            default: constants_1.DEFAULT_REGION,
+            description: 'The location to run the checks at.',
+        }),
+        'private-location': core_1.Flags.string({
+            description: 'The private location to run checks at.',
+            exclusive: ['location'],
+        }),
+        env: core_1.Flags.string({
+            char: 'e',
+            description: 'Env vars to be passed to the test run.',
+            exclusive: ['env-file'],
+            multiple: true,
+            default: [],
+        }),
+        'env-file': core_1.Flags.string({
+            description: 'dotenv file path to be passed. For example --env-file="./.env"',
+            exclusive: ['env'],
+        }),
+        'timeout': core_1.Flags.integer({
+            default: abstract_check_runner_1.DEFAULT_CHECK_RUN_TIMEOUT_SECONDS,
+            description: 'A timeout (in seconds) to wait for checks to complete.',
+        }),
+        'verbose': core_1.Flags.boolean({
+            description: 'Always show the full logs of the checks.',
+        }),
+        'reporter': core_1.Flags.string({
+            description: 'A list of custom reporters for the test output.',
+            options: ['list', 'dot', 'ci', 'github', 'json'],
+        }),
+        'config': core_1.Flags.string({
+            description: common_messages_1.default.configFile,
+        }),
+        record: core_1.Flags.boolean({
+            description: 'Record test results in Checkly as a test session with full logs, traces and videos.',
+            default: true,
+            allowNo: true,
+        }),
+        'test-session-name': core_1.Flags.string({
+            description: 'A name to use when storing results in Checkly',
+        }),
+        'create-check': core_1.Flags.boolean({
+            description: 'Create a Checkly check from the Playwright test.',
+            default: false,
+        })
+    };
+    async run() {
+        this.style.actionStart('Parsing your Playwright project');
+        const { checklyFlags, playwrightFlags } = (0, test_helper_1.splitChecklyAndPlaywrightFlags)(this.argv);
+        const { flags } = await this.parse(PwTestCommand, checklyFlags);
+        const { location: runLocation, 'private-location': privateRunLocation, env = [], 'env-file': envFile, timeout, verbose: verboseFlag, reporter: reporterFlag, config: configFilename, record, 'test-session-name': testSessionName, 'create-check': createCheck, } = flags;
+        const { configDirectory, configFilenames } = (0, util_1.splitConfigFilePath)(configFilename);
+        const { config: checklyConfig, constructs: checklyConfigConstructs, } = await (0, checkly_config_loader_1.loadChecklyConfig)(configDirectory, configFilenames, false);
+        const playwrightConfigPath = this.getConfigPath(playwrightFlags) ?? checklyConfig.checks?.playwrightConfigPath;
+        const dir = node_path_1.default.dirname(playwrightConfigPath || '.');
+        const playwrightCheck = await PwTestCommand.createPlaywrightCheck(playwrightFlags, runLocation, dir);
+        if (createCheck) {
+            this.style.actionStart('Creating Checkly check from Playwright test');
+            await this.createPlaywrightCheck(playwrightCheck, playwrightConfigPath);
+            return;
+        }
+        const location = await (0, test_helper_1.prepareRunLocation)(checklyConfig.cli, {
+            runLocation: runLocation,
+            privateRunLocation,
+        }, api, config_1.default.getAccountId());
+        const reporterTypes = (0, test_helper_1.prepareReportersTypes)(reporterFlag, checklyConfig.cli?.reporters);
+        const { data: account } = await api.accounts.get(config_1.default.getAccountId());
+        const { data: availableRuntimes } = await api.runtimes.getAll();
+        const testEnvVars = await (0, util_1.getEnvs)(envFile, env);
+        const project = await (0, project_parser_1.parseProject)({
+            directory: configDirectory,
+            projectLogicalId: checklyConfig.logicalId,
+            projectName: testSessionName ?? checklyConfig.projectName,
+            repoUrl: checklyConfig.repoUrl,
+            includeTestOnlyChecks: true,
+            checkMatch: checklyConfig.checks?.checkMatch,
+            ignoreDirectoriesMatch: checklyConfig.checks?.ignoreDirectoriesMatch,
+            checkDefaults: checklyConfig.checks,
+            availableRuntimes: availableRuntimes.reduce((acc, runtime) => {
+                acc[runtime.name] = runtime;
+                return acc;
+            }, {}),
+            defaultRuntimeId: account.runtimeId,
+            verifyRuntimeDependencies: false,
+            checklyConfigConstructs,
+            playwrightConfigPath,
+            include: checklyConfig.checks?.include,
+            playwrightChecks: [playwrightCheck],
+            checkFilter: check => {
+                if (check instanceof constructs_1.RuntimeCheck) {
+                    if (Object.keys(testEnvVars).length) {
+                        check.environmentVariables = check.environmentVariables
+                            ?.filter((envVar) => !testEnvVars[envVar.key]) || [];
+                        for (const [key, value] of Object.entries(testEnvVars)) {
+                            check.environmentVariables.push({
+                                key,
+                                value,
+                                locked: true,
+                            });
+                        }
+                    }
+                }
+                return true;
+            }
+        });
+        this.style.actionSuccess();
+        this.style.actionStart('Validating project resources');
+        const diagnostics = new constructs_1.Diagnostics();
+        await project.validate(diagnostics);
+        for (const diag of diagnostics.observations) {
+            if (diag.isFatal()) {
+                this.style.longError(diag.title, diag.message);
+            }
+            else if (!diag.isBenign()) {
+                this.style.longWarning(diag.title, diag.message);
+            }
+            else {
+                this.style.longInfo(diag.title, diag.message);
+            }
+        }
+        if (diagnostics.isFatal()) {
+            this.style.actionFailure();
+            this.style.shortError(`Unable to continue due to unresolved validation errors.`);
+            this.exit(1);
+        }
+        this.style.actionSuccess();
+        this.style.actionStart('Bundling project resources');
+        const projectBundle = await (async () => {
+            try {
+                const bundle = await project.bundle();
+                this.style.actionSuccess();
+                return bundle;
+            }
+            catch (err) {
+                this.style.actionFailure();
+                throw err;
+            }
+        })();
+        const checkBundles = Object.values(projectBundle.data.check);
+        if (!checkBundles.length) {
+            this.log(`Unable to find checks to run`);
+            return;
+        }
+        const reporters = (0, reporter_1.createReporters)(reporterTypes, location, verboseFlag);
+        const repoInfo = (0, util_1.getGitInformation)(project.repoUrl);
+        const ciInfo = (0, util_1.getCiInformation)();
+        // TODO: ADD PROPER RETRY STRATEGY HANDLING
+        // const testRetryStrategy = this.prepareTestRetryStrategy(retries, checklyConfig?.cli?.retries)
+        const runner = new test_runner_1.default(config_1.default.getAccountId(), projectBundle, checkBundles, constructs_1.Session.sharedFiles, location, timeout, verboseFlag, record, repoInfo, ciInfo.environment, 
+        // NO NEED TO UPLOAD SNAPSHOTS FOR PLAYWRIGHT TESTS
+        false, configDirectory, 
+        // TODO: ADD PROPER RETRY STRATEGY HANDLING
+        null);
+        runner.on(abstract_check_runner_1.Events.RUN_STARTED, (checks, testSessionId) => reporters.forEach(r => r.onBegin(checks, testSessionId)));
+        runner.on(abstract_check_runner_1.Events.CHECK_INPROGRESS, (check, sequenceId) => {
+            reporters.forEach(r => r.onCheckInProgress(check, sequenceId));
+        });
+        runner.on(abstract_check_runner_1.Events.MAX_SCHEDULING_DELAY_EXCEEDED, () => {
+            reporters.forEach(r => r.onSchedulingDelayExceeded());
+        });
+        runner.on(abstract_check_runner_1.Events.CHECK_ATTEMPT_RESULT, (sequenceId, check, result, links) => {
+            reporters.forEach(r => r.onCheckAttemptResult(sequenceId, {
+                logicalId: check.logicalId,
+                sourceFile: check.getSourceFile(),
+                ...result,
+            }, links));
+        });
+        runner.on(abstract_check_runner_1.Events.CHECK_SUCCESSFUL, (sequenceId, check, result, testResultId, links) => {
+            if (result.hasFailures) {
+                process.exitCode = 1;
+            }
+            reporters.forEach(r => r.onCheckEnd(sequenceId, {
+                logicalId: check.logicalId,
+                sourceFile: check.getSourceFile(),
+                ...result,
+            }, testResultId, links));
+        });
+        runner.on(abstract_check_runner_1.Events.CHECK_FAILED, (sequenceId, check, message) => {
+            reporters.forEach(r => r.onCheckEnd(sequenceId, {
+                ...check,
+                logicalId: check.logicalId,
+                sourceFile: check.getSourceFile(),
+                hasFailures: true,
+                runError: message,
+            }));
+            process.exitCode = 1;
+        });
+        runner.on(abstract_check_runner_1.Events.RUN_FINISHED, () => reporters.forEach(r => r.onEnd()));
+        runner.on(abstract_check_runner_1.Events.ERROR, (err) => {
+            reporters.forEach(r => r.onError(err));
+            process.exitCode = 1;
+        });
+        await runner.run();
+    }
+    static async createPlaywrightCheck(args, runLocation, dir) {
+        const parseArgs = args.map(arg => {
+            if (arg.includes(' ')) {
+                arg = `"${arg}"`;
+            }
+            return arg;
+        });
+        const input = parseArgs.join(' ') || '';
+        const inputLogicalId = (0, sourcegen_1.cased)(input, 'kebab-case').substring(0, 50);
+        const testCommand = await PwTestCommand.getTestCommand(dir, input);
+        return {
+            logicalId: `playwright-check-${inputLogicalId}`,
+            name: `Playwright Test: ${input}`,
+            testCommand,
+            locations: [runLocation],
+            frequency: 10,
+        };
+    }
+    getConfigPath(playwrightFlags) {
+        for (let i = 0; i < playwrightFlags.length; i++) {
+            const arg = playwrightFlags[i];
+            if (arg.startsWith('--config') || arg.startsWith('-c')) {
+                return arg.includes('=') ? arg.split('=')[1] : playwrightFlags[i + 1];
+            }
+        }
+    }
+    async createPlaywrightCheck(playwrightCheck, playwrightConfigPath = './playwright.config.ts') {
+        const dir = process.cwd();
+        const baseName = node_path_1.default.basename(dir);
+        const configFile = await (0, checkly_config_loader_1.getChecklyConfigFile)();
+        if (!configFile) {
+            this.style.shortWarning('No Checkly config file found');
+            this.style.shortInfo('Creating a default checkly config file.');
+            const checklyConfig = (0, util_1.getDefaultChecklyConfig)(baseName, `./${node_path_1.default.relative(dir, playwrightConfigPath)}`, playwrightCheck);
+            await (0, util_1.writeChecklyConfigFile)(dir, checklyConfig);
+            this.style.actionSuccess();
+            return;
+        }
+        const checklyAst = recast.parse(configFile.checklyConfig);
+        const checksAst = (0, write_config_helpers_1.findPropertyByName)(checklyAst, 'checks');
+        if (!checksAst) {
+            this.style.longError('Unable to automatically sync your config file.', 'This can happen if your Checkly config is ' +
+                'built using helper functions or other JS/TS features. You can still manually set Playwright config values in ' +
+                'your Checkly config: https://www.checklyhq.com/docs/cli/constructs-reference/#project');
+            return;
+        }
+        const b = recast.types.builders;
+        const playwrightPropertyNode = b.property('init', b.identifier('playwrightConfigPath'), b.stringLiteral(playwrightConfigPath));
+        const playwrightCheckString = `const playwrightCheck = ${JSON5.stringify(playwrightCheck, { space: 2 })}`;
+        const playwrightCheckAst = recast.parse(playwrightCheckString);
+        const playwrightCheckNode = playwrightCheckAst.program.body[0].declarations[0].init;
+        (0, write_config_helpers_1.addOrReplaceItem)(checksAst.value, playwrightPropertyNode, 'playwrightConfigPath');
+        (0, write_config_helpers_1.addItemToArray)(checksAst.value, playwrightCheckNode, 'playwrightChecks');
+        const checklyConfigData = recast.print(checklyAst, { tabWidth: 2 }).code;
+        const writeDir = node_path_1.default.resolve(node_path_1.default.dirname(configFile.fileName));
+        await (0, write_config_helpers_1.reWriteChecklyConfigFile)(checklyConfigData, configFile.fileName, writeDir);
+        this.style.actionSuccess();
+        return;
+    }
+    static async getTestCommand(directoryPath, input) {
+        const packageManager = await (0, package_manager_1.detectPackageManager)(directoryPath);
+        // Passing the input to the execCommand will return it quoted, which we want to avoid
+        return `${packageManager.execCommand(['playwright', 'test']).unsafeDisplayCommand} ${input}`;
+    }
+}
+exports.default = PwTestCommand;
+//# sourceMappingURL=pw-test.js.map

package/dist/commands/pw-test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pw-test.js","sourceRoot":"","sources":["../../src/commands/pw-test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAA2C;AAC3C,2CAMyB;AACzB,6EAAkH;AAClH,wDAAkH;AAClH,iDAAkC;AAClC,gEAAuC;AACvC,+DAAyD;AAEzD,8CAAkE;AAClE,sCAAuC;AACvC,oDAAqE;AACrE,0EAAgD;AAChD,6EAAyG;AAEzG,kFAAwD;AAExD,0DAA4B;AAC5B,+CAAgC;AAChC,0EAIwC;AACxC,6CAA8B;AAC9B,4FAA6F;AAC7F,oDAAqD;AACrD,4CAAoC;AAEpC,MAAqB,aAAc,SAAQ,yBAAW;IACpD,MAAM,CAAC,WAAW,GAAG,IAAI,CAAA;IACzB,MAAM,CAAC,MAAM,GAAG,KAAK,CAAA;IACrB,MAAM,CAAC,WAAW,GAAG,wCAAwC,CAAA;IAC7D,MAAM,CAAC,KAAK,GAAG,MAAM,CAAA;IACrB,MAAM,CAAC,KAAK,GAAG;QACb,UAAU,EAAE,YAAK,CAAC,MAAM,CAAC;YACvB,IAAI,EAAE,GAAG;YACT,OAAO,EAAE,0BAAc;YACvB,WAAW,EAAE,oCAAoC;SAClD,CAAC;QACF,kBAAkB,EAAE,YAAK,CAAC,MAAM,CAAC;YAC/B,WAAW,EAAE,wCAAwC;YACrD,SAAS,EAAE,CAAC,UAAU,CAAC;SACxB,CAAC;QACF,GAAG,EAAE,YAAK,CAAC,MAAM,CAAC;YAChB,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,wCAAwC;YACrD,SAAS,EAAE,CAAC,UAAU,CAAC;YACvB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE;SACZ,CAAC;QACF,UAAU,EAAE,YAAK,CAAC,MAAM,CAAC;YACvB,WAAW,EAAE,gEAAgE;YAC7E,SAAS,EAAE,CAAC,KAAK,CAAC;SACnB,CAAC;QACF,SAAS,EAAE,YAAK,CAAC,OAAO,CAAC;YACvB,OAAO,EAAE,yDAAiC;YAC1C,WAAW,EAAE,wDAAwD;SACtE,CAAC;QACF,SAAS,EAAE,YAAK,CAAC,OAAO,CAAC;YACvB,WAAW,EAAE,0CAA0C;SACxD,CAAC;QACF,UAAU,EAAE,YAAK,CAAC,MAAM,CAAC;YACvB,WAAW,EAAE,iDAAiD;YAC9D,OAAO,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,CAAC;SACjD,CAAC;QACF,QAAQ,EAAE,YAAK,CAAC,MAAM,CAAC;YACrB,WAAW,EAAE,yBAAc,CAAC,UAAU;SACvC,CAAC;QACF,MAAM,EAAE,YAAK,CAAC,OAAO,CAAC;YACpB,WAAW,EAAE,qFAAqF;YAClG,OAAO,EAAE,IAAI;YACb,OAAO,EAAE,IAAI;SACd,CAAC;QACF,mBAAmB,EAAE,YAAK,CAAC,MAAM,CAAC;YAChC,WAAW,EAAE,+CAA+C;SAC7D,CAAC;QACF,cAAc,EAAE,YAAK,CAAC,OAAO,CAAC;YAC5B,WAAW,EAAE,kDAAkD;YAC/D,OAAO,EAAE,KAAK;SACf,CAAC;KACH,CAAA;IAED,KAAK,CAAC,GAAG;QACP,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,iCAAiC,CAAC,CAAA;QAEzD,MAAM,EAAE,YAAY,EAAE,eAAe,EAAE,GAAG,IAAA,4CAA8B,EAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEnF,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,YAAY,CAAC,CAAA;QAC/D,MAAM,EACJ,QAAQ,EAAE,WAAW,EACrB,kBAAkB,EAAE,kBAAkB,EACtC,GAAG,GAAG,EAAE,EACR,UAAU,EAAE,OAAO,EACnB,OAAO,EACP,OAAO,EAAE,WAAW,EACpB,QAAQ,EAAE,YAAY,EACtB,MAAM,EAAE,cAAc,EACtB,MAAM,EACN,mBAAmB,EAAE,eAAe,EACpC,cAAc,EAAE,WAAW,GAC5B,GAAG,KAAK,CAAA;QACT,MAAM,EAAE,eAAe,EAAE,eAAe,EAAE,GAAG,IAAA,0BAAmB,EAAC,cAAc,CAAC,CAAA;QAChF,MAAM,EACJ,MAAM,EAAE,aAAa,EACrB,UAAU,EAAE,uBAAuB,GACpC,GAAG,MAAM,IAAA,yCAAiB,EAAC,eAAe,EAAE,eAAe,EAAE,KAAK,CAAC,CAAA;QACpE,MAAM,oBAAoB,GAAG,IAAI,CAAC,aAAa,CAAC,eAAe,CAAC,IAAI,aAAa,CAAC,MAAM,EAAE,oBAAoB,CAAA;QAC9G,MAAM,GAAG,GAAG,mBAAI,CAAC,OAAO,CAAC,oBAAoB,IAAI,GAAG,CAAC,CAAA;QACrD,MAAM,eAAe,GAAG,MAAM,aAAa,CAAC,qBAAqB,CAAC,eAAe,EAAE,WAA2B,EAAE,GAAG,CAAC,CAAA;QACpH,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,6CAA6C,CAAC,CAAA;YACrE,MAAM,IAAI,CAAC,qBAAqB,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAA;YACvE,OAAM;QACR,CAAC;QAGD,MAAM,QAAQ,GAAG,MAAM,IAAA,gCAAkB,EAAC,aAAa,CAAC,GAAG,EAAE;YAC3D,WAAW,EAAE,WAA2B;YACxC,kBAAkB;SACnB,EAAE,GAAG,EAAE,gBAAM,CAAC,YAAY,EAAE,CAAC,CAAA;QAC9B,MAAM,aAAa,GAAG,IAAA,mCAAqB,EAAC,YAA4B,EAAE,aAAa,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;QACvG,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAM,CAAC,YAAY,EAAE,CAAC,CAAA;QACvE,MAAM,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAA;QAC/D,MAAM,WAAW,GAAG,MAAM,IAAA,cAAO,EAAC,OAAO,EAAE,GAAG,CAAC,CAAA;QAG/C,MAAM,OAAO,GAAG,MAAM,IAAA,6BAAY,EAAC;YACjC,SAAS,EAAE,eAAe;YAC1B,gBAAgB,EAAE,aAAa,CAAC,SAAS;YACzC,WAAW,EAAE,eAAe,IAAI,aAAa,CAAC,WAAW;YACzD,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,qBAAqB,EAAE,IAAI;YAC3B,UAAU,EAAE,aAAa,CAAC,MAAM,EAAE,UAAU;YAC5C,sBAAsB,EAAE,aAAa,CAAC,MAAM,EAAE,sBAAsB;YACpE,aAAa,EAAE,aAAa,CAAC,MAAM;YACnC,iBAAiB,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE;gBAC3D,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAA;gBAC3B,OAAO,GAAG,CAAA;YACZ,CAAC,EAA4B,EAAE,CAAC;YAChC,gBAAgB,EAAE,OAAO,CAAC,SAAS;YACnC,yBAAyB,EAAE,KAAK;YAChC,uBAAuB;YACvB,oBAAoB;YACpB,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO;YACtC,gBAAgB,EAAE,CAAC,eAAe,CAAC;YACnC,WAAW,EAAE,KAAK,CAAC,EAAE;gBACnB,IAAI,KAAK,YAAY,yBAAY,EAAE,CAAC;oBAClC,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,EAAE,CAAC;wBACpC,KAAK,CAAC,oBAAoB,GAAG,KAAK,CAAC,oBAAoB;4BACrD,EAAE,MAAM,CAAC,CAAC,MAAW,EAAE,EAAE,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAA;wBAC3D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;4BACvD,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAAC;gCAC9B,GAAG;gCACH,KAAK;gCACL,MAAM,EAAE,IAAI;6BACb,CAAC,CAAA;wBACJ,CAAC;oBACH,CAAC;gBACH,CAAC;gBACD,OAAO,IAAI,CAAA;YACb,CAAC;SACF,CAAC,CAAA;QAEF,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAA;QAE1B,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,8BAA8B,CAAC,CAAA;QAEtD,MAAM,WAAW,GAAG,IAAI,wBAAW,EAAE,CAAA;QACrC,MAAM,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAA;QAEnC,KAAK,MAAM,IAAI,IAAI,WAAW,CAAC,YAAY,EAAE,CAAC;YAC5C,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;gBACnB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;YAChD,CAAC;iBAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;gBAC5B,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;YAClD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;YAC/C,CAAC;QACH,CAAC;QAED,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAA;YAC1B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,yDAAyD,CAAC,CAAA;YAChF,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACd,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAA;QAE1B,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,4BAA4B,CAAC,CAAA;QACpD,MAAM,aAAa,GAAG,MAAM,CAAC,KAAK,IAAI,EAAE;YACtC,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,MAAM,EAAE,CAAA;gBACrC,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAA;gBAC1B,OAAO,MAAM,CAAA;YACf,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAA;gBAC1B,MAAM,GAAG,CAAA;YACX,CAAC;QACH,CAAC,CAAC,EAAE,CAAA;QAEJ,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QAE5D,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YACzB,IAAI,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAA;YACxC,OAAM;QACR,CAAC;QAED,MAAM,SAAS,GAAG,IAAA,0BAAe,EAAC,aAAa,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAA;QACvE,MAAM,QAAQ,GAAG,IAAA,wBAAiB,EAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QACnD,MAAM,MAAM,GAAG,IAAA,uBAAgB,GAAE,CAAA;QACjC,2CAA2C;QAC3C,gGAAgG;QAEhG,MAAM,MAAM,GAAG,IAAI,qBAAU,CAC3B,gBAAM,CAAC,YAAY,EAAE,EACrB,aAAa,EACb,YAAY,EACZ,oBAAO,CAAC,WAAW,EACnB,QAAQ,EACR,OAAO,EACP,WAAW,EACX,MAAM,EACN,QAAQ,EACR,MAAM,CAAC,WAAW;QAClB,mDAAmD;QACnD,KAAK,EACL,eAAe;QACf,2CAA2C;QAC3C,IAAI,CACL,CAAA;QAED,MAAM,CAAC,EAAE,CAAC,8BAAM,CAAC,WAAW,EAC1B,CAAC,MAAqD,EAAE,aAAqB,EAAE,EAAE,CAC/E,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAC3D,CAAA;QAED,MAAM,CAAC,EAAE,CAAC,8BAAM,CAAC,gBAAgB,EAAE,CAAC,KAAU,EAAE,UAAsB,EAAE,EAAE;YACxE,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,iBAAiB,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC,CAAA;QAChE,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,EAAE,CAAC,8BAAM,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACnD,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,yBAAyB,EAAE,CAAC,CAAA;QACvD,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,EAAE,CAAC,8BAAM,CAAC,oBAAoB,EAAE,CAAC,UAAsB,EAAE,KAAK,EAAE,MAAM,EAAE,KAA6B,EAAE,EAAE;YAC9G,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CAAC,UAAU,EAAE;gBACxD,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,UAAU,EAAE,KAAK,CAAC,aAAa,EAAE;gBACjC,GAAG,MAAM;aACV,EAAE,KAAK,CAAC,CAAC,CAAA;QACZ,CAAC,CAAC,CAAA;QAEF,MAAM,CAAC,EAAE,CAAC,8BAAM,CAAC,gBAAgB,EAC/B,CAAC,UAAsB,EAAE,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,KAA6B,EAAE,EAAE;YACrF,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC;gBACvB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;YACtB,CAAC;YAED,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,EAAE;gBAC9C,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,UAAU,EAAE,KAAK,CAAC,aAAa,EAAE;gBACjC,GAAG,MAAM;aACV,EAAE,YAAY,EAAE,KAAK,CAAC,CAAC,CAAA;QAC1B,CAAC,CAAC,CAAA;QAEJ,MAAM,CAAC,EAAE,CAAC,8BAAM,CAAC,YAAY,EAAE,CAAC,UAAsB,EAAE,KAAK,EAAE,OAAe,EAAE,EAAE;YAChF,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,UAAU,EAAE;gBAC9C,GAAG,KAAK;gBACR,SAAS,EAAE,KAAK,CAAC,SAAS;gBAC1B,UAAU,EAAE,KAAK,CAAC,aAAa,EAAE;gBACjC,WAAW,EAAE,IAAI;gBACjB,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAC,CAAA;YACH,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;QACtB,CAAC,CAAC,CAAA;QACF,MAAM,CAAC,EAAE,CAAC,8BAAM,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QACvE,MAAM,CAAC,EAAE,CAAC,8BAAM,CAAC,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE;YAC9B,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;YACtC,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAA;QACtB,CAAC,CAAC,CAAA;QACF,MAAM,MAAM,CAAC,GAAG,EAAE,CAAA;IAClB,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,IAAc,EAAE,WAAyB,EAAE,GAAW;QACvF,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAC/B,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACtB,GAAG,GAAG,IAAI,GAAG,GAAG,CAAA;YAClB,CAAC;YACD,OAAO,GAAG,CAAA;QACZ,CAAC,CAAC,CAAA;QACF,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAA;QACvC,MAAM,cAAc,GAAG,IAAA,iBAAK,EAAC,KAAK,EAAE,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QAClE,MAAM,WAAW,GAAG,MAAM,aAAa,CAAC,cAAc,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAClE,OAAO;YACL,SAAS,EAAE,oBAAoB,cAAc,EAAE;YAC/C,IAAI,EAAE,oBAAoB,KAAK,EAAE;YACjC,WAAW;YACX,SAAS,EAAE,CAAC,WAAW,CAAC;YACxB,SAAS,EAAE,EAAE;SACd,CAAA;IACL,CAAC;IAEO,aAAa,CAAE,eAAyB;QAC9C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAChD,MAAM,GAAG,GAAG,eAAe,CAAC,CAAC,CAAC,CAAA;YAC9B,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvD,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YACvE,CAAC;QACH,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,qBAAqB,CAAE,eAAsC,EAAE,uBAA+B,wBAAwB;QAClI,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAA;QACzB,MAAM,QAAQ,GAAG,mBAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;QAEnC,MAAM,UAAU,GAAG,MAAM,IAAA,4CAAoB,GAAE,CAAA;QAC/C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,8BAA8B,CAAC,CAAA;YACvD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,yCAAyC,CAAC,CAAA;YAC/D,MAAM,aAAa,GAAG,IAAA,8BAAuB,EAAC,QAAQ,EAAE,KAAK,mBAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,oBAAoB,CAAC,EAAE,EAAE,eAAe,CAAC,CAAA;YACzH,MAAM,IAAA,6BAAsB,EAAC,GAAG,EAAE,aAAa,CAAC,CAAA;YAChD,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAA;YAC1B,OAAM;QACR,CAAC;QACD,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;QACzD,MAAM,SAAS,GAAG,IAAA,yCAAkB,EAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QAC1D,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,gDAAgD,EAAE,4CAA4C;gBACjH,+GAA+G;gBAC/G,uFAAuF,CAAC,CAAA;YAE1F,OAAM;QACR,CAAC;QACD,MAAM,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC;QAChC,MAAM,sBAAsB,GAAG,CAAC,CAAC,QAAQ,CACvC,MAAM,EACN,CAAC,CAAC,UAAU,CAAC,sBAAsB,CAAC,EACpC,CAAC,CAAC,aAAa,CAAC,oBAAoB,CAAC,CACtC,CAAC;QAEF,MAAM,qBAAqB,GAAG,2BAA2B,KAAK,CAAC,SAAS,CAAC,eAAe,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;QACzG,MAAM,kBAAkB,GAAG,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAA;QAC9D,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACpF,IAAA,uCAAgB,EAAC,SAAS,CAAC,KAAK,EAAE,sBAAsB,EAAE,sBAAsB,CAAC,CAAA;QACjF,IAAA,qCAAc,EAAC,SAAS,CAAC,KAAK,EAAE,mBAAmB,EAAE,kBAAkB,CAAC,CAAA;QACxE,MAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;QACxE,MAAM,QAAQ,GAAG,mBAAI,CAAC,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAA;QAChE,MAAM,IAAA,+CAAwB,EAAC,iBAAiB,EAAE,UAAU,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;QAChF,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,CAAA;QAC1B,OAAM;IAER,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,KAAa;QACtE,MAAM,cAAc,GAAG,MAAM,IAAA,sCAAoB,EAAC,aAAa,CAAC,CAAA;QAChE,qFAAqF;QACrF,OAAO,GAAG,cAAc,CAAC,WAAW,CAAC,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,oBAAoB,IAAI,KAAK,EAAE,CAAA;IAC9F,CAAC;;AAzUH,gCA0UC"}

package/dist/commands/rules.d.ts

@@ -0,0 +1,9 @@
+import { BaseCommand } from './baseCommand';
+export default class Rules extends BaseCommand {
+    static hidden: boolean;
+    static description: string;
+    run(): Promise<void>;
+    private findAIIDEConfigFolder;
+    private readBaseRulesFile;
+    private confirmOverwrite;
+}

package/dist/commands/rules.js

@@ -0,0 +1,126 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const baseCommand_1 = require("./baseCommand");
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const prompts_1 = __importDefault(require("prompts"));
+const BASE_RULES_FILE_PATH = (0, path_1.join)(__dirname, '../rules/checkly.rules.md');
+// AI IDE configurations mapping
+const AI_IDE_CONFIGS = {
+    Windsurf: {
+        rootFolder: '.windsurf',
+        rulesFolder: 'rules',
+        rulesFileName: 'checkly.md',
+    },
+    'GitHub Copilot': {
+        rootFolder: '.github/',
+        rulesFolder: 'instructions',
+        rulesFileName: 'checkly.instructions.md',
+    },
+    Cursor: {
+        rootFolder: '.cursor',
+        rulesFolder: 'rules',
+        rulesFileName: 'checkly.mdc',
+    },
+    None: {
+        rootFolder: 'None',
+        rulesFolder: '',
+        rulesFileName: 'checkly.md',
+    },
+};
+class Rules extends baseCommand_1.BaseCommand {
+    static hidden = false;
+    static description = 'Generate a rules file to use with AI IDEs and Copilots.';
+    async run() {
+        try {
+            // Find AI IDE config folders
+            const result = await this.findAIIDEConfigFolder();
+            const { configPath, ideType } = result;
+            this.log(`Found ${ideType?.rootFolder} config folder: ${configPath}`);
+            // Read the base rules file
+            const rulesContent = await this.readBaseRulesFile();
+            // Create rules directory if it doesn't exist
+            const rulesDir = (0, path_1.join)(configPath, ideType.rulesFolder);
+            if (ideType.rulesFolder) {
+                try {
+                    await (0, promises_1.mkdir)(rulesDir, { recursive: true });
+                }
+                catch {
+                    // Directory might already exist, ignore error
+                }
+            }
+            // Determine the target file path
+            const targetPath = (0, path_1.join)(rulesDir || configPath, ideType.rulesFileName);
+            // Check if file already exists and ask for confirmation
+            const shouldOverwrite = await this.confirmOverwrite(targetPath);
+            if (!shouldOverwrite) {
+                this.log('Operation cancelled.');
+                return;
+            }
+            // Save the rules file
+            await (0, promises_1.writeFile)(targetPath, rulesContent, 'utf8');
+            this.log(`✅ Successfully saved Checkly rules file to: ${targetPath}`);
+        }
+        catch (error) {
+            this.error(`Failed to generate rules file: ${error}`);
+        }
+    }
+    async findAIIDEConfigFolder() {
+        let currentDir = process.cwd();
+        while (true) {
+            for (const ideConfig of Object.values(AI_IDE_CONFIGS)) {
+                const configPath = (0, path_1.join)(currentDir, ideConfig.rootFolder);
+                try {
+                    await (0, promises_1.access)(configPath, fs_1.constants.F_OK);
+                    return { ideType: ideConfig, configPath };
+                }
+                catch {
+                    // Folder doesn't exist, continue searching
+                }
+            }
+            // Check if we've reached the root directory
+            const parentDir = (0, path_1.dirname)(currentDir);
+            if (parentDir === currentDir) {
+                // We've reached the root directory
+                break;
+            }
+            // Move up one directory
+            currentDir = parentDir;
+        }
+        return {
+            configPath: process.cwd(),
+            ideType: AI_IDE_CONFIGS.None,
+        };
+    }
+    async readBaseRulesFile() {
+        try {
+            return await (0, promises_1.readFile)(BASE_RULES_FILE_PATH, 'utf8');
+        }
+        catch (error) {
+            throw new Error(`Failed to read base rules file at ${BASE_RULES_FILE_PATH}: ${error}`);
+        }
+    }
+    async confirmOverwrite(targetPath) {
+        try {
+            await (0, promises_1.access)(targetPath, fs_1.constants.F_OK);
+            // File exists, ask for confirmation
+            const { overwrite } = await (0, prompts_1.default)({
+                type: 'confirm',
+                name: 'overwrite',
+                message: `Rules file already exists at ${targetPath}. Do you want to overwrite it?`,
+                initial: false,
+            });
+            return overwrite ?? false;
+        }
+        catch {
+            // File doesn't exist, no need to confirm
+            return true;
+        }
+    }
+}
+exports.default = Rules;
+//# sourceMappingURL=rules.js.map

package/dist/commands/rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../src/commands/rules.ts"],"names":[],"mappings":";;;;;AAAA,+CAA4C;AAC5C,0CAAiE;AACjE,+BAAqC;AACrC,2BAA+B;AAC/B,sDAA8B;AAE9B,MAAM,oBAAoB,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,2BAA2B,CAAC,CAAC;AAE1E,gCAAgC;AAChC,MAAM,cAAc,GAAG;IACrB,QAAQ,EAAE;QACR,UAAU,EAAE,WAAW;QACvB,WAAW,EAAE,OAAO;QACpB,aAAa,EAAE,YAAY;KAC5B;IACD,gBAAgB,EAAE;QAChB,UAAU,EAAE,UAAU;QACtB,WAAW,EAAE,cAAc;QAC3B,aAAa,EAAE,yBAAyB;KACzC;IACD,MAAM,EAAE;QACN,UAAU,EAAE,SAAS;QACrB,WAAW,EAAE,OAAO;QACpB,aAAa,EAAE,aAAa;KAC7B;IACD,IAAI,EAAE;QACJ,UAAU,EAAE,MAAM;QAClB,WAAW,EAAE,EAAE;QACf,aAAa,EAAE,YAAY;KAC5B;CACO,CAAC;AAEX,MAAqB,KAAM,SAAQ,yBAAW;IAC5C,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC;IACtB,MAAM,CAAC,WAAW,GAChB,yDAAyD,CAAC;IAE5D,KAAK,CAAC,GAAG;QACP,IAAI,CAAC;YACH,6BAA6B;YAC7B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;YAElD,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;YACvC,IAAI,CAAC,GAAG,CAAC,SAAS,OAAO,EAAE,UAAU,mBAAmB,UAAU,EAAE,CAAC,CAAC;YAEtE,2BAA2B;YAC3B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAEpD,6CAA6C;YAC7C,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;YACvD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;gBACxB,IAAI,CAAC;oBACH,MAAM,IAAA,gBAAK,EAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC7C,CAAC;gBAAC,MAAM,CAAC;oBACP,8CAA8C;gBAChD,CAAC;YACH,CAAC;YAED,iCAAiC;YACjC,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,QAAQ,IAAI,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;YAEvE,wDAAwD;YACxD,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;YAEhE,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;gBACjC,OAAO;YACT,CAAC;YAED,sBAAsB;YACtB,MAAM,IAAA,oBAAS,EAAC,UAAU,EAAE,YAAY,EAAE,MAAM,CAAC,CAAC;YAElD,IAAI,CAAC,GAAG,CAAC,+CAA+C,UAAU,EAAE,CAAC,CAAC;QACxE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,KAAK,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,qBAAqB;QACjC,IAAI,UAAU,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QAE/B,OAAO,IAAI,EAAE,CAAC;YACZ,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,EAAE,CAAC;gBACtD,MAAM,UAAU,GAAG,IAAA,WAAI,EAAC,UAAU,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;gBAC1D,IAAI,CAAC;oBACH,MAAM,IAAA,iBAAM,EAAC,UAAU,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;oBACzC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,CAAC;gBAC5C,CAAC;gBAAC,MAAM,CAAC;oBACP,2CAA2C;gBAC7C,CAAC;YACH,CAAC;YAED,4CAA4C;YAC5C,MAAM,SAAS,GAAG,IAAA,cAAO,EAAC,UAAU,CAAC,CAAC;YACtC,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;gBAC7B,mCAAmC;gBACnC,MAAM;YACR,CAAC;YAED,wBAAwB;YACxB,UAAU,GAAG,SAAS,CAAC;QACzB,CAAC;QAED,OAAO;YACL,UAAU,EAAE,OAAO,CAAC,GAAG,EAAE;YACzB,OAAO,EAAE,cAAc,CAAC,IAAI;SAC7B,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,iBAAiB;QAC7B,IAAI,CAAC;YACH,OAAO,MAAM,IAAA,mBAAQ,EAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CACb,qCAAqC,oBAAoB,KAAK,KAAK,EAAE,CACtE,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAAC,UAAkB;QAC/C,IAAI,CAAC;YACH,MAAM,IAAA,iBAAM,EAAC,UAAU,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;YAEzC,oCAAoC;YACpC,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAA,iBAAO,EAAC;gBAClC,IAAI,EAAE,SAAS;gBACf,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,gCAAgC,UAAU,gCAAgC;gBACnF,OAAO,EAAE,KAAK;aACf,CAAC,CAAC;YAEH,OAAO,SAAS,IAAI,KAAK,CAAC;QAC5B,CAAC;QAAC,MAAM,CAAC;YACP,yCAAyC;YACzC,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;;AAxGH,wBAyGC"}

package/dist/commands/sync-playwright.d.ts

@@ -4,7 +4,4 @@ export default class SyncPlaywright extends BaseCommand {
     static description: string;
     run(): Promise<void>;
     private handleError;
-    private findPropertyByName;
-    private addOrReplacePlaywrightConfig;
-    private reWriteChecklyConfigFile;
 }

package/dist/commands/sync-playwright.js

@@ -30,10 +30,10 @@ const baseCommand_1 = require("./baseCommand");
 const recast = __importStar(require("recast"));
 const checkly_config_loader_1 = require("../services/checkly-config-loader");
 const playwright_config_loader_1 = require("../playwright/playwright-config-loader");
-const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const core_1 = require("@oclif/core");
 const playwright_config_template_1 = __importDefault(require("../playwright/playwright-config-template"));
+const write_config_helpers_1 = require("../helpers/write-config-helpers");
 class SyncPlaywright extends baseCommand_1.BaseCommand {
     static hidden = false;
     static description = 'Copy Playwright config into the Checkly config file.';
@@ -50,18 +50,18 @@ class SyncPlaywright extends baseCommand_1.BaseCommand {
         if (!config) {
             return this.handleError('Could not find any playwright.config file.');
         }
-        const checksAst = this.findPropertyByName(checklyAst, 'checks');
+        const checksAst = (0, write_config_helpers_1.findPropertyByName)(checklyAst, 'checks');
         if (!checksAst) {
             return this.handleError('Unable to automatically sync your config file. This can happen if your Checkly config is ' +
                 'built using helper functions or other JS/TS features. You can still manually set Playwright config values in ' +
                 'your Checkly config: https://www.checklyhq.com/docs/cli/constructs-reference/#project');
         }
         const pwtConfig = new playwright_config_template_1.default(config).getConfigTemplate();
-        const pwtConfigAst = this.findPropertyByName(recast.parse(pwtConfig), 'playwrightConfig');
-        this.addOrReplacePlaywrightConfig(checksAst.value, pwtConfigAst);
+        const pwtConfigAst = (0, write_config_helpers_1.findPropertyByName)(recast.parse(pwtConfig), 'playwrightConfig');
+        (0, write_config_helpers_1.addOrReplaceItem)(checksAst.value, pwtConfigAst, 'playwrightConfig');
         const checklyConfigData = recast.print(checklyAst, { tabWidth: 2 }).code;
         const dir = path_1.default.resolve(path_1.default.dirname(configFile.fileName));
-        this.reWriteChecklyConfigFile(checklyConfigData, configFile.fileName, dir);
+        await (0, write_config_helpers_1.reWriteChecklyConfigFile)(checklyConfigData, configFile.fileName, dir);
         if (this.fancy) {
             core_1.ux.action.stop('✅ ');
         }
@@ -75,30 +75,6 @@ class SyncPlaywright extends baseCommand_1.BaseCommand {
         this.log(message);
         this.exit(1);
     }
-    findPropertyByName(ast, name) {
-        let node;
-        recast.visit(ast, {
-            visitProperty(path) {
-                if (path.node.key.name === name) {
-                    node = path.node;
-                }
-                return false;
-            },
-        });
-        return node;
-    }
-    addOrReplacePlaywrightConfig(ast, node) {
-        const playWrightConfig = this.findPropertyByName(ast, 'playwrightConfig');
-        if (playWrightConfig) {
-            playWrightConfig.value = node.value;
-        }
-        else {
-            ast.properties.push(node);
-        }
-    }
-    reWriteChecklyConfigFile(data, fileName, dir) {
-        fs_1.default.writeFileSync(path_1.default.join(dir, fileName), data);
-    }
 }
 exports.default = SyncPlaywright;
 //# sourceMappingURL=sync-playwright.js.map

package/dist/commands/sync-playwright.js.map

@@ -1 +1 @@
-{"version":3,"file":"sync-playwright.js","sourceRoot":"","sources":["../../src/commands/sync-playwright.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAA2C;AAC3C,+CAAgC;AAChC,6EAAwE;AACxE,qFAA6E;AAC7E,4CAAmB;AACnB,gDAAuB;AACvB,sCAAgC;AAChC,0GAA+E;AAE/E,MAAqB,cAAe,SAAQ,yBAAW;IACrD,MAAM,CAAC,MAAM,GAAG,KAAK,CAAA;IACrB,MAAM,CAAC,WAAW,GAAG,sDAAsD,CAAA;IAE3E,KAAK,CAAC,GAAG;QACP,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,sDAAsD,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;QACtG,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAA,4CAAoB,GAAE,CAAA;QAC/C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,CAAC,CAAA;QACjE,CAAC;QACD,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;QAEzD,MAAM,MAAM,GAAG,MAAM,IAAA,+CAAoB,GAAE,CAAA;QAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAAA;QACvE,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QAC/D,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,IAAI,CAAC,WAAW,CAAC,2FAA2F;gBAC/G,+GAA+G;gBAC/G,uFAAuF,CAAC,CAAA;QAC9F,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,oCAAwB,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE,CAAA;QAC1E,MAAM,YAAY,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC,CAAA;QACzF,IAAI,CAAC,4BAA4B,CAAC,SAAS,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;QAEhE,MAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;QACxE,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC3D,IAAI,CAAC,wBAAwB,CAAC,iBAAiB,EAAE,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;QAE1E,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,SAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACtB,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACd,CAAC;IAEO,WAAW,CAAE,OAAe;QAClC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,SAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACrB,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACjB,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACd,CAAC;IAEO,kBAAkB,CAAE,GAAQ,EAAE,IAAY;QAChD,IAAI,IAAI,CAAA;QACR,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE;YAChB,aAAa,CAAE,IAAS;gBACtB,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;gBAClB,CAAC;gBACD,OAAO,KAAK,CAAA;YACd,CAAC;SACF,CAAC,CAAA;QACF,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,4BAA4B,CAAE,GAAQ,EAAE,IAAS;QACvD,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAA;QACzE,IAAI,gBAAgB,EAAE,CAAC;YACrB,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAA;QACrC,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC3B,CAAC;IACH,CAAC;IAEO,wBAAwB,CAAE,IAAY,EAAE,QAAgB,EAAE,GAAW;QAC3E,YAAE,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAA;IAClD,CAAC;;AA1EH,iCA2EC"}
+{"version":3,"file":"sync-playwright.js","sourceRoot":"","sources":["../../src/commands/sync-playwright.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAA2C;AAC3C,+CAAgC;AAChC,6EAAwE;AACxE,qFAA6E;AAC7E,gDAAuB;AACvB,sCAAgC;AAChC,0GAA+E;AAC/E,0EAAgH;AAEhH,MAAqB,cAAe,SAAQ,yBAAW;IACrD,MAAM,CAAC,MAAM,GAAG,KAAK,CAAA;IACrB,MAAM,CAAC,WAAW,GAAG,sDAAsD,CAAA;IAE3E,KAAK,CAAC,GAAG;QACP,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,SAAE,CAAC,MAAM,CAAC,KAAK,CAAC,sDAAsD,EAAE,SAAS,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAA;QACtG,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAA,4CAAoB,GAAE,CAAA;QAC/C,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,WAAW,CAAC,sCAAsC,CAAC,CAAA;QACjE,CAAC;QACD,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,CAAA;QAEzD,MAAM,MAAM,GAAG,MAAM,IAAA,+CAAoB,GAAE,CAAA;QAC3C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,WAAW,CAAC,4CAA4C,CAAC,CAAA;QACvE,CAAC;QAED,MAAM,SAAS,GAAG,IAAA,yCAAkB,EAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QAC1D,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,OAAO,IAAI,CAAC,WAAW,CAAC,2FAA2F;gBAC/G,+GAA+G;gBAC/G,uFAAuF,CAAC,CAAA;QAC9F,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,oCAAwB,CAAC,MAAM,CAAC,CAAC,iBAAiB,EAAE,CAAA;QAC1E,MAAM,YAAY,GAAG,IAAA,yCAAkB,EAAC,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC,CAAA;QACpF,IAAA,uCAAgB,EAAC,SAAS,CAAC,KAAK,EAAE,YAAY,EAAE,kBAAkB,CAAC,CAAA;QAEnE,MAAM,iBAAiB,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,IAAI,CAAA;QACxE,MAAM,GAAG,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC3D,MAAM,IAAA,+CAAwB,EAAC,iBAAiB,EAAE,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;QAE3E,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,SAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACtB,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,0CAA0C,CAAC,CAAA;QACpD,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACd,CAAC;IAEO,WAAW,CAAE,OAAe;QAClC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,SAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QACrB,CAAC;QACD,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;QACjB,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IACd,CAAC;;AAhDH,iCAiDC"}

package/dist/commands/test.d.ts

@@ -1,7 +1,4 @@
-import { RunLocation, PrivateRunLocation } from '../services/abstract-check-runner';
 import { AuthCommand } from './authCommand';
-import type { Region } from '..';
-import { ReporterType } from '../reporters/reporter';
 export default class Test extends AuthCommand {
     static coreCommand: boolean;
     static hidden: boolean;
@@ -30,15 +27,6 @@ export default class Test extends AuthCommand {
     static strict: boolean;
     run(): Promise<void>;
     prepareVerboseFlag(verboseFlag?: boolean, cliVerboseFlag?: boolean): boolean;
-    prepareReportersTypes(reporterFlag: ReporterType, cliReporters?: ReporterType[]): ReporterType[];
-    prepareRunLocation(configOptions?: {
-        runLocation?: keyof Region;
-        privateRunLocation?: string;
-    }, cliFlags?: {
-        runLocation?: keyof Region;
-        privateRunLocation?: string;
-    }): Promise<RunLocation>;
-    preparePrivateRunLocation(privateLocationSlugName: string): Promise<PrivateRunLocation>;
     prepareTestRetryStrategy(retries?: number, configRetries?: number): import("../constructs").RetryStrategy | null;
     private listChecks;
     private getCheckGroup;