checkly 3.1.1 → 4.0.0

package/oclif.manifest.json

@@ -0,0 +1,423 @@
+{
+  "version": "4.0.0",
+  "commands": {
+    "authCommand": {
+      "id": "authCommand",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": true,
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "baseCommand": {
+      "id": "baseCommand",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": true,
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "deploy": {
+      "id": "deploy",
+      "description": "Deploy your project to your Checkly account.",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "preview": {
+          "name": "preview",
+          "type": "boolean",
+          "char": "p",
+          "description": "Show a preview of the changes made by the deploy command.",
+          "allowNo": false
+        },
+        "output": {
+          "name": "output",
+          "type": "boolean",
+          "char": "o",
+          "description": "Shows the changes made after the deploy command.",
+          "allowNo": false
+        },
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "char": "f",
+          "description": "Force mode. Skips the confirmation dialog.",
+          "allowNo": false
+        },
+        "config": {
+          "name": "config",
+          "type": "option",
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "multiple": false
+        }
+      },
+      "args": {}
+    },
+    "destroy": {
+      "id": "destroy",
+      "description": "Destroy your project with all its related resources.",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "char": "f",
+          "description": "Force mode. Skips the confirmation dialog.",
+          "allowNo": false
+        },
+        "config": {
+          "name": "config",
+          "type": "option",
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "multiple": false
+        }
+      },
+      "args": {}
+    },
+    "login": {
+      "id": "login",
+      "description": "Login to your Checkly account or create a new one.",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "api-key": {
+          "name": "api-key",
+          "type": "option",
+          "char": "k",
+          "description": "Checkly User API Key. \nIf you did not have one, create it at: https://app.checklyhq.com/settings/user/api-keys.",
+          "multiple": false
+        },
+        "account-id": {
+          "name": "account-id",
+          "type": "option",
+          "char": "i",
+          "description": "Checkly account ID. (This flag is required if you are using -k (--api-key) flag.",
+          "multiple": false
+        }
+      },
+      "args": {}
+    },
+    "logout": {
+      "id": "logout",
+      "description": "Log out and clear any local credentials.",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "char": "f",
+          "description": "Force mode. Skips the confirmation dialog.",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "runtimes": {
+      "id": "runtimes",
+      "description": "List all supported runtimes and dependencies.",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "switch": {
+      "id": "switch",
+      "description": "Switch user account.",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "account-id": {
+          "name": "account-id",
+          "type": "option",
+          "char": "a",
+          "description": "The id of the account you want to switch to.",
+          "multiple": false
+        }
+      },
+      "args": {}
+    },
+    "test": {
+      "id": "test",
+      "description": "Test your checks on Checkly.",
+      "strict": false,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "location": {
+          "name": "location",
+          "type": "option",
+          "char": "l",
+          "description": "The location to run the checks at.",
+          "multiple": false
+        },
+        "private-location": {
+          "name": "private-location",
+          "type": "option",
+          "description": "The private location to run checks at.",
+          "multiple": false,
+          "exclusive": [
+            "location"
+          ]
+        },
+        "grep": {
+          "name": "grep",
+          "type": "option",
+          "char": "g",
+          "description": "Only run checks where the check name matches a regular expression.",
+          "multiple": false,
+          "default": ".*"
+        },
+        "env": {
+          "name": "env",
+          "type": "option",
+          "char": "e",
+          "description": "Env vars to be passed to the test run.",
+          "multiple": true,
+          "exclusive": [
+            "env-file"
+          ],
+          "default": []
+        },
+        "env-file": {
+          "name": "env-file",
+          "type": "option",
+          "description": "dotenv file path to be passed. For example --env-file=\"./.env\"",
+          "multiple": false,
+          "exclusive": [
+            "env"
+          ]
+        },
+        "list": {
+          "name": "list",
+          "type": "boolean",
+          "description": "list all checks but don't run them.",
+          "allowNo": false
+        },
+        "timeout": {
+          "name": "timeout",
+          "type": "option",
+          "description": "A timeout (in seconds) to wait for checks to complete.",
+          "multiple": false,
+          "default": 240
+        },
+        "verbose": {
+          "name": "verbose",
+          "type": "boolean",
+          "char": "v",
+          "description": "Always show the full logs of the checks.",
+          "allowNo": true
+        },
+        "reporter": {
+          "name": "reporter",
+          "type": "option",
+          "char": "r",
+          "description": "A list of custom reporters for the test output.",
+          "multiple": false,
+          "options": [
+            "list",
+            "dot",
+            "ci",
+            "github"
+          ]
+        },
+        "config": {
+          "name": "config",
+          "type": "option",
+          "char": "c",
+          "description": "The Checkly CLI configuration file. If not passed, uses the checkly.config.ts|js file in the current directory.",
+          "multiple": false
+        },
+        "record": {
+          "name": "record",
+          "type": "boolean",
+          "description": "Record test results in Checkly as a test session with full logs, traces and videos.",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "fileArgs": {
+          "name": "fileArgs",
+          "description": "Only run checks where the file name matches a regular expression",
+          "required": false,
+          "default": ".*"
+        }
+      }
+    },
+    "whoami": {
+      "id": "whoami",
+      "description": "See your currently logged in account and user.",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "env:add": {
+      "id": "env:add",
+      "description": "Add environment variable via \"checkly env add <key> <value>\".",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "locked": {
+          "name": "locked",
+          "type": "boolean",
+          "char": "l",
+          "description": "Indicate that the environment variable will be locked.",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "key": {
+          "name": "key",
+          "description": "Environment variable key.",
+          "required": true
+        },
+        "value": {
+          "name": "value",
+          "description": "Environment variable value.",
+          "required": false
+        }
+      }
+    },
+    "env:ls": {
+      "id": "env:ls",
+      "description": "List all Checkly environment variables via \"checkly env ls\".",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {},
+      "args": {}
+    },
+    "env:pull": {
+      "id": "env:pull",
+      "description": "Pull Checkly environment variables via \"checkly env pull <filename>\".",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "char": "f",
+          "description": "Force to overwrite existing file.",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "filename": {
+          "name": "filename",
+          "description": "Filename of the generated file.",
+          "required": false,
+          "default": ".env"
+        }
+      }
+    },
+    "env:rm": {
+      "id": "env:rm",
+      "description": "Remove environment variable via \"checkly env rm <key>\".",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "force": {
+          "name": "force",
+          "type": "boolean",
+          "char": "f",
+          "description": "Force to skip the confirmation prompt.",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "key": {
+          "name": "key",
+          "description": "Environment variable key to remove.",
+          "required": true
+        }
+      }
+    },
+    "env:update": {
+      "id": "env:update",
+      "description": "Update environment variable via \"checkly env update <key> <value>\".",
+      "strict": true,
+      "pluginName": "checkly",
+      "pluginAlias": "checkly",
+      "pluginType": "core",
+      "hidden": false,
+      "aliases": [],
+      "flags": {
+        "locked": {
+          "name": "locked",
+          "type": "boolean",
+          "char": "l",
+          "description": "Indicate if environment variable is locked.",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "key": {
+          "name": "key",
+          "description": "Environment variable key.",
+          "required": true
+        },
+        "value": {
+          "name": "value",
+          "description": "Environment variable value.",
+          "required": false
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -1,27 +1,172 @@
 {
   "name": "checkly",
-  "version": "3.1.1",
-  "description": "Truthy, falsey & equality checks simplified.",
-  "main": "index.js",
+  "version": "4.0.0",
+  "description": "Checkly CLI",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "engines": {
+    "node": ">=16.0.0"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "clean": "rimraf ./dist",
+    "test": "jest --selectProjects unit",
+    "version": "node -e \"console.log(require('./package.json').version)\"",
+    "test:e2e": "npm run prepare && cross-env NODE_CONFIG_DIR=./e2e/config jest --selectProjects E2E",
+    "watch": "tsc --watch",
+    "prepare": "npm run clean && tsc --build",
+    "prepack": "npx oclif manifest",
+    "lint": "eslint src"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/xemasiv/checkly.git"
-  },
-  "keywords": [
-    "check",
-    "truthy",
-    "falsey",
-    "falsy",
-    "equality",
-    "checks"
-  ],
-  "author": "xemasiv <xemasiv@gmail.com>",
-  "license": "CC0-1.0",
+    "url": "git+https://github.com/checkly/checkly-cli.git"
+  },
+  "author": "Checkly Engineering <support@checklyhq.com>",
+  "license": "Apache-2.0",
   "bugs": {
-    "url": "https://github.com/xemasiv/checkly/issues"
+    "url": "https://github.com/checkly/checkly-cli/issues"
+  },
+  "files": [
+    "/bin",
+    "/dist",
+    "/constructs.js",
+    "/constructs.d.ts",
+    "/oclif.manifest.json"
+  ],
+  "oclif": {
+    "bin": "checkly",
+    "commands": "./dist/commands",
+    "topicSeparator": " ",
+    "additionalHelpFlags": [
+      "-h"
+    ],
+    "additionalVersionFlags": [
+      "-v",
+      "version"
+    ],
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-warn-if-update-available",
+      "@oclif/plugin-not-found",
+      "@oclif/plugin-autocomplete"
+    ],
+    "warn-if-update-available": {
+      "timeoutInDays": 30,
+      "message": "<%= config.name %> update available from <%= chalk.greenBright(config.version) %> to <%= chalk.greenBright(latest) %>."
+    },
+    "topics": {
+      "env": { "description": "Manage Checkly environment variables" }
+    },
+    "helpClass": "./dist/help/help-extension"
+  },
+  "bin": {
+    "checkly": "./bin/run"
+  },
+  "homepage": "https://github.com/checkly/checkly-cli#readme",
+  "dependencies": {
+    "@oclif/core": "2.0.7",
+    "@oclif/plugin-autocomplete": "2.1.8",
+    "@oclif/plugin-help": "5.1.20",
+    "@oclif/plugin-not-found": "2.3.23",
+    "@oclif/plugin-plugins": "2.3.0",
+    "@oclif/plugin-warn-if-update-available": "2.0.24",
+    "@typescript-eslint/typescript-estree": "5.46.1",
+    "acorn": "8.8.1",
+    "acorn-walk": "8.2.0",
+    "async-mqtt": "2.6.3",
+    "axios": "1.2.1",
+    "chalk": "4.1.2",
+    "ci-info": "3.7.1",
+    "conf": "10.2.0",
+    "dotenv": "16.0.3",
+    "git-repo-info": "2.1.1",
+    "glob": "8.0.3",
+    "indent-string": "4.0.0",
+    "inquirer": "8.2.3",
+    "jwt-decode": "3.1.2",
+    "log-symbols": "4.1.0",
+    "luxon": "3.2.1",
+    "open": "8.4.0",
+    "p-queue": "6.6.2",
+    "uuid": "9.0.0"
+  },
+  "devDependencies": {
+    "@checkly/eslint-config": "0.14.1",
+    "@types/config": "3.3.0",
+    "@types/glob": "8.0.0",
+    "@types/inquirer": "8.2.3",
+    "@types/jest": "29.2.4",
+    "@types/luxon": "3.2.0",
+    "@types/node": "18.11.18",
+    "@types/uuid": "9.0.1",
+    "@types/ws": "8.5.3",
+    "@typescript-eslint/eslint-plugin": "5.46.1",
+    "@typescript-eslint/parser": "5.46.1",
+    "config": "3.3.8",
+    "cross-env": "7.0.3",
+    "eslint": "8.30.0",
+    "jest": "29.3.1",
+    "oclif": "3.7.3",
+    "ts-jest": "29.0.3",
+    "ts-node": "10.9.1",
+    "typescript": "4.9.4"
+  },
+  "eslintConfig": {
+    "rules": {
+      "@typescript-eslint/type-annotation-spacing": 2,
+      "@typescript-eslint/no-explicit-any": 0,
+      "@typescript-eslint/ban-ts-comment": 0,
+      "no-console": 2,
+      "no-restricted-syntax": [
+        "error",
+        {
+          "selector": "TSEnumDeclaration",
+          "message": "Don't declare enums, use union types instead"
+        }
+      ]
+    },
+    "extends": [
+      "@checkly/eslint-config",
+      "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "plugins": [
+      "@typescript-eslint"
+    ],
+    "overrides": [
+      {
+        "files": [
+          "src/commands/*",
+          "src/reporters/*"
+        ],
+        "rules": {
+          "no-console": 0
+        }
+      }
+    ]
   },
-  "homepage": "https://github.com/xemasiv/checkly#readme"
+  "jest": {
+    "projects": [
+      {
+        "displayName": "unit",
+        "testMatch": [
+          "<rootDir>/src/**/*.spec.ts"
+        ],
+        "preset": "ts-jest",
+        "testEnvironment": "node"
+      },
+      {
+        "displayName": "E2E",
+        "testMatch": [
+          "<rootDir>/e2e/__tests__/**/*.spec.ts"
+        ],
+        "preset": "ts-jest",
+        "testEnvironment": "node"
+      }
+    ],
+    "reporters": [
+      "default",
+      "github-actions"
+    ]
+  }
 }