checkly / checkly/checkly-cli

bug: Missed types for PW in 'Advanced Example Project' boilerplate in WebStorm 2024.2 Kali Linux 2024.2

Open
#990 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug tbd
Dominant language
TypeScript
Stars
96
Forks
25
Avg merge
14h 14m
Merged PRs (30d)
38

Description

Node.js version

18.18.0

NPM version

9.8.1

@checkly/cli version

4.14.0

Steps to reproduce

npm create checkly
All default options selected with TS and "'Advanced Example Project'" + deps installation

open created projects in WebStorm 2024.2 running on Kali Linux 2024.2 LTS

What is expected?

PW types are expected to be available in IDE after default project installation

What is actually happening?

PW types are not available for IDE due to missed PW dependency in default package.json

image

Any additional comments?

To use PR types, I currently need to install them manually as described in ReadMe. It would be fantastic if they were included by default when creating a project with the CLI since PW files coming with CLI create command it is expected that types will be available out of the box.
Thank you in advance — you're building an amazing product!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run npm create checkly with the default Advanced Example Project and TypeScript options, then inspect the generated package.json and the included Playwright files. Confirm whether the generated project lacks the dependency needed for IDE Playwright types, and verify that a fresh project exposes those types without manual installation.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js, playwright, typescript
Domain
cli
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.