codesandbox / codesandbox/codesandbox-client

On sandbox/template rename, Jest related typings stop working

Open
#5,850 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

🐛 Bug VS Code
Dominant language
JavaScript
Stars
13.6k
Forks
2.4k
Avg merge
6d 19h
Merged PRs (30d)
2

Description

🐛 bug report

Preflight Checklist

  • I have read the Contributing Guidelines for this project.
  • I agree to follow the Code of Conduct that this project adheres to.
  • I have searched the issue tracker for an issue that matches the one I want to file, without success.

Description of the problem

In a TypeScript sandbox, once you rename the project (via the Sandbox Info section or by clicking the top title), the Jest typing support stop working in *.spec.ts files:

  • Such function names as describe, it, expect get red underlined
  • Jest/Mocha-related code completion won't work too.
  • Adding @types

How has this issue affected you? What are you trying to accomplish?

TDD is not viable after just renaming the sandbox.

To Reproduce
  1. Create a new Sandbox using the Vanilla Typescript official template,
  2. Add some ts stuff, create *.spec.ts file, declare some tests,
  3. Click the Sandbox title at the top,
  4. Rename to whatever you want,
  • After a while, the test-related statements get underlined as errors.
  • The tests themselves keep working.

The behavior is true for templates and new sandboxes created from that renamed and broken templates.

Link to sandbox: link

image

Your Environment
Software Name/Version
Сodesandbox https://codesandbox.io
Browser Chrome 91.0.4472.77
Operating System Windows 10.0.19042

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

Start by reproducing the failure in the linked Vanilla TypeScript sandbox: rename the project and inspect the resulting errors in workout.spec.ts. Trace the sandbox/template rename flow and the Jest or TypeScript typings setup. Done means describe, it, expect, and related completion work again after renaming, including in templates and new sandboxes created from them.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
developer-experience, testing-qa
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.