Adding custom commands throws IDE errors

Current behavior:

When adding a new custom command, like Cypress.Commands.add('login', (user) => {

JetBrains (GoLand in my case) doesn’t recognise the command and throws an error on it.

This shows errors all they way up the file tree in my IDE

Desired behavior:

I would like to be able to register the command to the IDE to prevent theseissues

Versions

Goland 2020.1

[jennifer-shehane]

After relooking at this, it seems that adding the reference to the index.d.ts file at the top of the support/index.ts file will cause the types to work correctly.

@rkorebrits Can you confirm that this fixes your types?

There’s some discussion here on this situation.

support/index.ts

/// <reference path="../support/index.d.ts" />

Cypress.Commands.add('login', (userType, options = {}) => {})

[jennifer-shehane]

I’ve confirmed that this example from our docs to define Type definitions for custom commands does not work when the support/index file where the custom command is defined is a TypeScript file. If you renamed the support/index.ts file to support/index.js (being a JavaScript file) - the type definition works for the spec.

Repro

cypress/support/index.d.ts

declare namespace Cypress {
  interface Chainable {
    login(user: any): void
  }
}

cypress/support/index.ts - works if cypress/support/index.js

Cypress.Commands.add('login', (userType, options = {}) => {})

cypress/integration/spec.ts

it('login', () => {
  cy.login('admin')
})

Not sure if this is some bug or issue with our documentation that needs updating.