Cypress应用

如何使用Cypress插件

info

你将学到

• 如何安装插件
• 如何使用插件

Cypress维护了一个由我们和社区创建的精选插件列表。 来自我们官方列表的插件都是npm模块。这使得它们可以 独立进行版本控制和更新，而无需更新Cypress本身。

你可以使用npm安装任何已发布的插件：

npm

npm install <插件名称> --save-dev

yarn

yarn add <插件名称> --dev

pnpm

pnpm add --save-dev <插件名称>

使用插件

将你的插件添加到Cypress配置中的 setupNodeEvents 函数。请遵循插件文档提供的任何额外说明。 以下是一个示例：

cypress.config.js 文件

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  // setupNodeEvents can be defined in either
  // the e2e or component configuration
  e2e: {
    setupNodeEvents(on, config) {
      // 绑定我们关心的事件
      on('<事件>', (arg1, arg2) => {
        // 插件相关操作在这里
      })
    },
  },
})

cypress.config.ts 文件

import { defineConfig } from 'cypress'

export default defineConfig({
  // setupNodeEvents can be defined in either
  // the e2e or component configuration
  e2e: {
    setupNodeEvents(on, config) {
      // 绑定我们关心的事件
      on('<事件>', (arg1, arg2) => {
        // 插件相关操作在这里
      })
    },
  },
})

有关编写插件的信息，请查看我们的 Node Events概述。