Skip to content

docs: drop ts-node/typescript install step for CLI v8#374

Merged
stefanjudis merged 5 commits into
mainfrom
docs/cli-v8-drop-ts-loader
Jun 9, 2026
Merged

docs: drop ts-node/typescript install step for CLI v8#374
stefanjudis merged 5 commits into
mainfrom
docs/cli-v8-drop-ts-loader

Conversation

@stefanjudis

@stefanjudis stefanjudis commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

What

Checkly CLI v8 dropped ts-node as a TypeScript loader and raised its minimum Node.js version. This updates the docs to match.

Changes

TypeScript loader

  • Remove the ts-node/typescript install instructions from cli/installation.mdx and guides/monitoring-ecommerce-apps-using-playwright.mdx (v8 bundles jiti and supports TypeScript out of the box).
  • Add a shared snippets/ts-loader-note.mdx callout, used on both pages, noting that built-in TypeScript support requires v8+ and that earlier versions still need the loader.

Node.js version (per checkly-cli#1296)

  • Update the prerequisite in cli/installation.mdx (was v16.x) and detect/testing/creating-your-first-test.mdx (was 18+) to Node.js 20.19+ or 22.12+.
  • Phrased as the two LTS lines rather than a bare semver range, so readers don't assume Node 21 (excluded, EOL, no require(ESM) backport) works.

Notes

Out of scope, left untouched: the ecommerce guide still imports from the old @checkly/cli package name (now checkly). Happy to fold that into a follow-up.

Checkly CLI v8 bundles jiti and supports TypeScript out of the box, so
the separate `ts-node`/`typescript` install is no longer required.

Replace the install instructions in the installation page and the
ecommerce guide with a shared `ts-loader-note` snippet that flags the
v8 requirement for users still on earlier versions.
@mintlify

mintlify Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview Jun 9, 2026, 12:11 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@stefanjudis stefanjudis enabled auto-merge June 9, 2026 12:16
@stefanjudis stefanjudis merged commit 68162ac into main Jun 9, 2026
6 checks passed
@stefanjudis stefanjudis deleted the docs/cli-v8-drop-ts-loader branch June 9, 2026 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant