From 53d83a01321e06ad1560dbe41ebcb5c2d3af64e4 Mon Sep 17 00:00:00 2001 From: stefan judis Date: Thu, 11 Jun 2026 13:14:51 +0200 Subject: [PATCH] docs: drop jiti/TS-loader steps from getting-started guides Checkly CLI v8+ supports TypeScript out of the box, so no separate loader install is needed. Remove the jiti install steps from the Playwright quickstart, the checkly init reference, and the AI setup prompt, and route the quickstart through the shared ts-loader-note snippet. The note now lists jiti (preferred) and ts-node/typescript as options for users still on pre-v8 CLI versions. --- cli/checkly-init.mdx | 2 +- quickstarts/playwright-check.mdx | 13 +++++-------- snippets/playwright-check-suite-setup-prompt.mdx | 2 +- snippets/ts-loader-note.mdx | 2 +- 4 files changed, 8 insertions(+), 11 deletions(-) diff --git a/cli/checkly-init.mdx b/cli/checkly-init.mdx index 343f08bd..367df0f0 100644 --- a/cli/checkly-init.mdx +++ b/cli/checkly-init.mdx @@ -49,7 +49,7 @@ npx checkly init -t cursor The `init` command detects your project context and adjusts its flow: - **No `package.json`** — prompts you to create one before continuing. -- **No Checkly config** — creates a `checkly.config.ts` and installs `checkly` and `jiti` as dev dependencies. +- **No Checkly config** — creates a `checkly.config.ts` and installs `checkly` as a dev dependency. - **Playwright detected** — provides context-aware setup that accounts for your existing test infrastructure. - **Existing Checkly project** — refreshes your agent skill to the latest version. diff --git a/quickstarts/playwright-check.mdx b/quickstarts/playwright-check.mdx index 8b44b815..a8193f75 100644 --- a/quickstarts/playwright-check.mdx +++ b/quickstarts/playwright-check.mdx @@ -4,9 +4,10 @@ description: 'Turn your Playwright tests into production monitors by creating a sidebarTitle: 'Playwright Check Suite' --- -import { YoutubeEmbed } from "/snippets/youtube-embed.jsx" -import { CopyPromptButton } from "/snippets/copy-prompt-button.jsx" -import SetupPrompt from "/snippets/playwright-check-suite-setup-prompt.mdx" +import { CopyPromptButton } from "/snippets/copy-prompt-button.jsx"; +import SetupPrompt from "/snippets/playwright-check-suite-setup-prompt.mdx"; +import TsLoaderNote from '/snippets/ts-loader-note.mdx'; +import { YoutubeEmbed } from "/snippets/youtube-embed.jsx"; Turn your Playwright tests into production monitors. Generate a working configuration with AI, or configure manually. @@ -52,11 +53,7 @@ This prompt is also available in the Checkly UI when [creating a Playwright Chec npm install --save-dev checkly ``` -If you use TypeScript, also install `jiti` to bundle config and test files correctly: - -```bash terminal -npm install --save-dev jiti -``` + ## Step 2: Create Your checkly.config.ts diff --git a/snippets/playwright-check-suite-setup-prompt.mdx b/snippets/playwright-check-suite-setup-prompt.mdx index c9991c58..8f2a2cc3 100644 --- a/snippets/playwright-check-suite-setup-prompt.mdx +++ b/snippets/playwright-check-suite-setup-prompt.mdx @@ -45,7 +45,7 @@ Set up the smallest possible working Checkly Playwright Check Suite from this re * Use `pwProjects` and/or `pwTags` when that is the cleanest way to select tests. * Configure `frequency` and `locations` for the check suite based on my choices. * If needed, set `cli.runLocation` to one of the chosen locations for local validation. -* If this repo uses TypeScript for config/tests, make sure `checkly` is installed and add `jiti` if needed. +* If this repo uses TypeScript for config/tests, make sure `checkly` is installed. * Only customize `installCommand` or `testCommand` if the repo layout or package manager requires it. ### Alert Channel Setup diff --git a/snippets/ts-loader-note.mdx b/snippets/ts-loader-note.mdx index 67def70b..ffbaf5f4 100644 --- a/snippets/ts-loader-note.mdx +++ b/snippets/ts-loader-note.mdx @@ -1,3 +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`. +Built-in TypeScript support requires Checkly CLI `v8` or later. On earlier versions, also install a TypeScript loader with `npm install --save-dev jiti` (preferred) or `npm install --save-dev ts-node typescript`.