Add section in README on how to activate intellisense for library

[kylemh]

Not a bug, so I didn't follow the issue template! This is a feature request.

I'd like for intellisense to exist off of the cy object with the methods from @testing-library/dom. How do I do this? Is it possible?

[NicholasBoll]

Great suggestion! Intellisense can be tricky for libraries that use globals/namespaces like Cypress. The experience ranges from everything working right out of the box to messing with the config in ways that are specific to your project.

I think the easiest way in a JavaScript project is to add the following to the top of each Cypress spec file:

/// <reference types="@testing-library/cypress" />

This is called a Triple-Slash Directive and it informs of external types to bring in. This should give intellisense to your files for this library.

The other way is to add a cypress/jsconfig.json file, but that adds Typescript checking in JavaScript files. You can set the jsconfig.json to be as loose as JavaScript and just get type definitions:

{
  "compilerOptions": {
    "types": ["@testing-library/cypress"]
  }
}

The rest of the config will depend on your project.

[NicholasBoll]

If that works for you and you have time, could you create a pull request that updates the readme?

[kylemh]

I have a project coming up in a few weeks where I'll be starting a fresh set of Cypress tests. I'll make sure I hit this back up and add a PR!

edit: project got scrapped, but this is on my radar nonetheless.

[kylemh]

@NicholasBoll it doesn't look like types is a valid property of compilerOptions in jsconfig.json.

I tried doing:

// VS Code Configuration
{
  "compilerOptions": {
    "checkJs": true
  },
  "include": ["@testing-library/cypress"]
}

but nothing seemed to happen... I wonder how this strategy plays out if I already have a root-level (as opposed to in the cypress folder) jsconfig file? This seems like an abstracted tsconfig.json so perhaps I need to extend?

[kylemh]

The triple slash directive isn't working for me either. I simply get a lint error (which I can obviously ignore), but no intellisense.

[kylemh]

Just found this 🤦‍♂️

I had a exclude: ['node_modules'] which didnt seem to pair well with anything.

I've fixed intellisense for my project by removing exclude and just having "include": ["node_modules/cypress", "./cypress/**/*.js"] among my next to my compiler options.

I'll add a PR for documentation on this - should be simple!

[kentcdodds]

🎉 This issue has been resolved in version 6.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀