Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] VS Code extension #980

Open
2 tasks done
utybo opened this issue Dec 10, 2023 · 2 comments
Open
2 tasks done

[FEATURE] VS Code extension #980

utybo opened this issue Dec 10, 2023 · 2 comments
Labels
approved feature a feature that is a good idea and will be accepted, but might not yet be planned feature a thing you'd like to see

Comments

@utybo
Copy link
Contributor

utybo commented Dec 10, 2023

Is there an existing issue for this?

  • I have searched the existing issues

Have you read the CONTRIBUTING guide on posting issues, and CODE_OF_CONDUCT?

  • yes I read the things

Description

I recently migrated my new project from Jest to node-tap. I could not get Jest working with TypeScript and ESM, and was fed up with nothing ever documented working. I dropped Jest for node-tap and everything worked out-of-the-box, which is great! Thank you for making my life much easier 🙏🏻

The main thing that I'm missing from Jest is a VS Code extension that populates the "Test" panel in VS Code. This makes browsing through and running specific tests super easy (both from the Test panel and from the files directly). It would be really cool to also have a code coverage integration in VS Code.

  • Does such an extension already exist?
  • Is there a more general TAP extension that could work with node-tap in VS Code?
  • Are there plans on developing this?
  • Otherwise, if someone has already tried it, what are the current roadblocks for implementing such an extension?

I'd be willing to try creating such an extension, though I don't have any experience with it.

Example

Main features I can think of, in order of priority

  • Implement VS Code's Testing API with node-tap: https://code.visualstudio.com/api/extension-guides/testing
    • Allows running tests by clicking in the gutter
  • Debugging tests
  • Make it Just Work™️ as much as possible, just like node-tap
  • Fully optional configuration (choose which command or script is used for running node-tap, that sort of stuff)
  • Code coverage gutters, either by being compatible with the "Coverage Gutters" plugin, or copying how they do it.

I think a lot of inspiration can be taken from the Jest plugin for most of these.

@utybo utybo added the feature a thing you'd like to see label Dec 10, 2023
@isaacs isaacs added the approved feature a feature that is a good idea and will be accepted, but might not yet be planned label Dec 10, 2023
@isaacs
Copy link
Member

isaacs commented Dec 10, 2023

Yes, i definitely love this idea, but im not sure im the best one to build it, since i dont use vscode and thus dont have much of a sense for what would feel "right" there. (I use nvim, which probably explains why tap is so optimized for the cli, and not much else ;)

Do you want to give it a try? I'd be happy to answer any questions or offer help if i can.

@utybo
Copy link
Contributor Author

utybo commented Dec 10, 2023

Do you want to give it a try? I'd be happy to answer any questions or offer help if i can.

Sure! I'll give it a shot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved feature a feature that is a good idea and will be accepted, but might not yet be planned feature a thing you'd like to see
Projects
None yet
Development

No branches or pull requests

2 participants