Make the position argument type of click, dblclick, rightclick more specific

[sainthkh]

Current behavior:

Currently, the type of position in click, dblclick, rightclick is just string. Because of this, we cannot get the help of Intellisense.

Desired behavior:

They should be replaced to PositionType like scrollTo, etc.

Test code to reproduce

it('test', () => {
  cy.get('#button').click('top')`. 
}

Intellisense doesn't work.

Versions

3.8.3

[markoelez]

@sainthkh Could I try tackling this issue? I am new to the codebase but would like to start contributing if possible :)

[sainthkh]

Good. Go on.

[markoelez]

@sainthkh So I found the VALID_POSITIONS in packages/driver/src/cy/ensures.coffee, but I am not sure where to define the PositionType object. For Intellisense to work, I assume we would need to restrict the type in packages/driver/src/cy/commands/actions/click.js correct?

[sainthkh]

Cypress types are defined in cli/type/index.d.ts. Check the file, please.

[cypress-bot]

The code for this is done in cypress-io/cypress#6668, but has yet to be released.
We'll update this issue and reference the changelog when it's released.

[cypress-bot]

Released in 4.2.0.

This comment thread has been locked. If you are still experiencing this issue after upgrading to
Cypress v4.2.0, please open a new issue.