WIP - TypeScript Support Doc

[jennifer-shehane]

• addresses Typescript Support doc #400

[brian-mann]

What's the rationale for plugin support being in tooling?

[jennifer-shehane]

I guess I thought tooling would be things that are extensions of cypress, but not really specific to the core essential 'run e2e tests' - more specific to your personal workflow and involving 1 other library/third parties code, so:

• using cucumber with cypress
• how to get cypress working in my IDE
• how to have my babel config
• set up a different mocha reporter
• typescript intellisense

[brian-mann]

Some of that makes sense... I guess some may have a corresponding Recipe too, which is also fine.

So Tooling is like... hey... so you wanna add stuff to Cypress to make it better? Maybe stuff for your IDE, or business processes (cucumber), or maybe how you interface with your own node code... here's a list of things.

I'm good with it 👍

[NicholasBoll]

I don't think this method is limited to TypeScript. It should work on JavaScript files as well in VSCode, Atom and probably more editors/IDEs. I ask because the section is labeled "TypeScript Support" which JavaScript developers might just skip over.

[jennifer-shehane]

Good point. I will have to think about a good place to mention this elsewhere in the docs.

[NicholasBoll]

I think this JSON block should be:

If you write your tests in TypeScript, you may find it more convenient to add a tsconfig.json inside your Cypress folder.

{
  "compilerOptions": {
	"strict": true,
    "baseUrl": "../node_modules",
    "target": "es5",
    "lib": ["es5", "dom"],
    "types": ["cypress"],
  },
  "include": [
    "**/*.ts"
  ]
}

The "types" will tell the TypeScript compiler to only include type definitions from Cypress. This will address instances where the project also uses @types/chai or @types/jquery. Since chai and jQuery are namespaces (globals), incompatible versions will cause the package manager (yarn or npm) nest and include multiple definitions and cause conflicts.

[jennifer-shehane]

omg, thank you! I was struggling 😅 I think this has helped finally push it to a shippable state.