diff --git a/cli/installation.mdx b/cli/installation.mdx index dc283fd8..090b3f2f 100644 --- a/cli/installation.mdx +++ b/cli/installation.mdx @@ -4,12 +4,14 @@ description: 'Creating a CLI project from scratch' sidebarTitle: 'Installation' --- +import TsLoaderNote from '/snippets/ts-loader-note.mdx'; + To kickstart a new project with the CLI, we recommend running `npx checkly init`. But you can also add the CLI from scratch with the following steps. ## Prerequisites -- Node.js `v16.x` or higher. +- Node.js `20.19+` or `22.12+`. - A text editor like [Visual Studio Code](https://code.visualstudio.com/). ## Installation @@ -20,11 +22,7 @@ First, install the CLI. npm i --save-dev checkly ``` -To use TypeScript, also install `ts-node` and `typescript`: - -```bash Terminal -npm i --save-dev ts-node typescript -``` + Create a minimal `checkly.config.ts` (or `checkly.config.js`) at the root of your project. We recommend using TypeScript. diff --git a/detect/testing/creating-your-first-test.mdx b/detect/testing/creating-your-first-test.mdx index 23d12458..1a0a2749 100644 --- a/detect/testing/creating-your-first-test.mdx +++ b/detect/testing/creating-your-first-test.mdx @@ -8,7 +8,7 @@ Checkly enables you to transform your existing Playwright tests into powerful sy -- Node.js 18+ installed +- Node.js `20.19+` or `22.12+` installed - A Checkly account (sign up at [checklyhq.com](https://www.checklyhq.com)) - Basic familiarity with JavaScript/TypeScript diff --git a/detect/uptime-monitoring/cli-configuration.mdx b/detect/uptime-monitoring/cli-configuration.mdx index 101c1a2e..9805e1e4 100644 --- a/detect/uptime-monitoring/cli-configuration.mdx +++ b/detect/uptime-monitoring/cli-configuration.mdx @@ -477,7 +477,7 @@ jobs: - name: Setup Node.js uses: actions/setup-node@v3 with: - node-version: '18' + node-version: '20' cache: 'npm' - name: Install dependencies diff --git a/guides/monitoring-ecommerce-apps-using-playwright.mdx b/guides/monitoring-ecommerce-apps-using-playwright.mdx index f6a043a0..80482969 100644 --- a/guides/monitoring-ecommerce-apps-using-playwright.mdx +++ b/guides/monitoring-ecommerce-apps-using-playwright.mdx @@ -7,6 +7,7 @@ tags: Playwright import CliAuth from '/snippets/cli-auth.mdx'; import CliProjectInit from '/snippets/cli-project-init.mdx'; +import TsLoaderNote from '/snippets/ts-loader-note.mdx'; import { YoutubeEmbed } from "/snippets/youtube-embed.jsx" ## Inspired by Infrastructure-as-Code and E2E-Testing @@ -187,11 +188,7 @@ First, install the CLI. npm install --save-dev checkly ``` -Since we are using TypeScript, also install ts-node and typescript: - -```bash install-typescript-dependencies -npm install --save-dev ts-node typescript -``` + Next up, we want to create our `checkly.config.ts` file and include the basic Checkly configuration as follows: diff --git a/integrations/ci-cd/jenkins/overview.mdx b/integrations/ci-cd/jenkins/overview.mdx index 05ab16bf..8b5aa217 100644 --- a/integrations/ci-cd/jenkins/overview.mdx +++ b/integrations/ci-cd/jenkins/overview.mdx @@ -63,7 +63,7 @@ should look as follows: pipeline { agent any - tools {nodejs "Node 18"} + tools {nodejs "Node 20"} environment { CHECKLY_API_KEY = credentials('checkly-api-key') CHECKLY_ACCOUNT_ID = credentials('checkly-account-id') diff --git a/snippets/ts-loader-note.mdx b/snippets/ts-loader-note.mdx new file mode 100644 index 00000000..67def70b --- /dev/null +++ b/snippets/ts-loader-note.mdx @@ -0,0 +1,3 @@ + +Built-in TypeScript support requires Checkly CLI `v8` or later. On earlier versions, also install a TypeScript loader with `npm install --save-dev ts-node typescript`. +