Cypress 自定义命令

自定义命令提供了一种在 Cypress 测试套件中复用特定方法或函数的方式。例如，您可以编写一个用于用户登录的命令，并在项目中适用时进行复用。

GoLand 支持自定义命令，也就是说重命名、导航、代码补全和检查等所有编码辅助功能都可以立即使用。

自定义命令的编码辅助

Cypress 专用检查

Cypress 使用一种链式机制，允许编写一系列命令，将信息从一个命令传递到下一个命令，直到链结束或发生错误。

但是，该机制具有一些特殊要求。例如，任何操作命令都必须始终位于链末，并且只能使用一次。

在此示例中，链中包含两个连续的操作命令，这是不允许的。执行该测试将导致错误。

                        it('Click the search button and type Cypress', () => {
                            cy.get("button[data-test='search-button']")
                                .click()
                                .type('Cypress')
                         })
                    
     

在此示例中，链被拆分为两部分，因此每个链中仅包含一个操作命令。该测试将无误地执行。

                        it('Click the search button and type Cypress', () => {
                            cy.get("button[data-test='search-button']").click()
                            cy.get("input[data-test$='inner']").type('Cypress')
                        })
                    
     

在 JavaScript／TypeScript 中不会执行命令链的验证，而在 Cypress 中只会在运行时执行，这可能在测试执行过程中导致问题。而 GoLand 则会对链式命令执行检查，突出显示错误用法。

函数专用检查

GoLand 会执行函数专用的代码检查，以在项目中检测并修复异常代码。

例如，如果为命令提供了错误数量或类型的参数，将会突出显示有错误的代码。将鼠标悬停在高亮代码上可以查看错误描述。

有关更多信息，请参阅代码检查。

重命名

如果需要重命名命令，您可以使用重命名重构。操作如下：

选中要重命名的命令。
按下 Shift+F6 并为命令提供一个新名称。
（可选）配置其他搜索选项并定义作用域。
单击重构。

有关更多信息，请参阅重命名重构。

创建自定义命令

要创建自定义命令，须先编写该命令，然后为其创建 TypeScript 声明。操作如下：

在代码编辑器中编写命令。
建议在 cypress/support/commands.ts 或 cypress/support/commands.js 文件中指定命令，因为此文件会通过 supportFile 中的 import 语句进行加载，早于任何测试文件的加载。
最初，GoLand 会根据为项目选定的编程语言，将命令标记为错误或弱警告。但是，在创建了 TypeScript 声明之后，该问题将得到解决。
将鼠标悬停在高亮代码上并单击创建缺失的 TypeScript 声明。
或者，将插入符放在高亮代码处，按下 Alt+Enter ，然后选择创建缺失的 TypeScript 声明。