feat: make ability for cy.task to be type-safe

[alexsch01]

OPT-IN: adds type-safety and autocomplete to cy.task function

---

cypress.config.js

const { defineConfig } = require('cypress')
const CypressTasks = require('./tasks')

module.exports = {
  ...defineConfig({
    e2e: {
      supportFile: false,
      setupNodeEvents(on, config) {
        on('task', CypressTasks)
      },
    },
  }),
  CypressTasks,
}

---

tasks.js

module.exports = {
  log(args) {
    console.log(args)
    return null;
  },

  /**
   * @param {any[]} args
   */
  logMany(args) {
    console.log(...args)
    return null;
  },

  getData() {
    return {
      response: {
        body: 'OK',
        status: 200,
      }
    }
  },

  /**
   * @param {string} x 
   * @returns {Promise<string>}
   */
  getSelf(x) {
    return new Promise((resolve) => {
      setTimeout(() => {
        resolve(x);
      }, 5000);
    });
  },
}

---

cypress/e2e/spec.cy.js

it('Example of cy.task', () => {
  cy.task('logMany', [1, 2, 3, null, 5])

  cy.task('getData').then(data => {
    expect(data.response.status).to.eq(200)
    expect(data.response.body).to.eq('OK')
  })

  cy.task('getSelf', "=========").then((x) => {
    cy.task('log', x)
  })
})

---

jsconfig.json

{
  "compilerOptions": {
    "types": ["cypress"],
    "checkJs": true,
    "lib": ["ES2021", "DOM"],
    "module": "preserve",
    "strictNullChecks": true,
  },
  "exclude": ["node_modules"]
}

---

[cypress-app-bot]

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

[cursor]

Bug: Cypress Type Definitions Fail to Resolve User Config

The hardcoded relative import path ../../../cypress.config within the Cypress type definitions fails to resolve the user's cypress.config file. As the types file is located in node_modules, this path incorrectly attempts to resolve the config file from within the package directory instead of the user's project root. This causes TypeScript compilation errors, breaking the type-safe cy.task feature, especially for custom config names or locations.

cli/types/cypress.d.ts#L9-L10

cypress/cli/types/cypress.d.ts

Lines 9 to 10 in 701c2be

	type CypressConfig_Data = typeof import('../../../cypress.config');

Fix in Cursor • Fix in Web

---

Was this report helpful? Give feedback by reacting with 👍 or 👎