Cypress 10+

开水好喝2024-10-14 18:43

背景

Cypress 10.0.0以后不再支持通过cypress/plugins/index.js配置插件。而是通过cypress.config.js的setupNodeEvents函数配置插件。

javascript 复制代码

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  // setupNodeEvents can be defined in either
  // the e2e or component configuration
  e2e: {
    setupNodeEvents(on, config) {
      // configure plugins here
      const _ = require('lodash') // yup, dev dependencies
      const path = require('path') // yup, core node library
      const debug = require('debug') // yup, dependencies
      const User = require('./lib/models/user') // yup, relative local modules

      console.log(__dirname) // /Users/janelane/Dev/my-project
      console.log(process.cwd()) // /Users/janelane/Dev/my-project

      on('<event>', (arg1, arg2) => {
        // plugin stuff here
      })            
    },
  },
})

配置文件说明

setupNodeEvents

on是一个用来注册cypress公开的各种事件的侦听器，setupNodeEvents中可以有多个侦听器。不同的事件及其代表的意义如下表

Event	Description
after:run	Occurs after the run is finished.
after:screenshot	Occurs after a screenshot is taken.
after:spec	Occurs after a spec is finished running.
before:browser:launch	Occurs immediately before launching a browser.
before:run	Occurs before the run starts.
before:spec	Occurs when a spec is about to be run.
file:preprocessor	Occurs when a spec or spec-related file needs to be transpiled for the browser.
task	Occurs in conjunction with the `cy.task` command.

config是当前项目打开时已解析的cypress配置，此配置包含传递到浏览器中的所有值，某些插件可能会使用或者需要这些值，如果以编程方式修改了这些值，cypress将使用新值。

例子

file:preprocessor事件如何使用@cypress/webpack-preprocessor进行构建和预处理

BREAKING CHANGE: webpack < 5 used to include polyfills for node.js core modules by default