如何在不运行测试的情况下编译Cypress TypeScript代码

Cypress 官方确实没有提供仅编译TS代码、不运行测试的专用命令，你可以直接借助TypeScript自带的编译能力实现该需求，具体操作如下：

实现步骤 #

• 第一步：确认Cypress专属的TS配置文件
  建议在项目cypress目录下新增tsconfig.json，确保配置覆盖所有Cypress相关的TS文件，参考配置如下：

  {
    "compilerOptions": {
      "target": "ESNext",
      "module": "ESNext",
      "lib": ["ESNext", "DOM"],
      "types": ["cypress", "node"],
      "strict": true
    },
    "include": [
      "**/*.ts", // 匹配cypress目录下所有TS文件（用例、support自定义命令等）
      "../cypress.config.ts" // 匹配根目录下的cypress配置文件
    ]
  }
  

• 第二步：新增类型检查脚本
  在项目根目录的package.json的scripts字段中添加如下命令：

  {
    "scripts": {
      "cy:type-check": "tsc --noEmit -p cypress/tsconfig.json"
    }
  }
  

  其中--noEmit参数表示仅做类型和语法校验，不输出任何编译产物，完全符合提前检查编译问题的需求。
• 第三步：加入代码卡点流程
  可以将该命令接入预提交钩子（如husky的pre-commit阶段）或者CI流水线的代码合并前置校验环节，只要类型检查不通过，就阻断代码提交或合并到主分支，从流程上避免问题代码流入仓库。

常见问题排查 #

如果运行检查时出现自定义Cypress命令类型报错，确认自定义命令的类型声明文件（通常为cypress/support/index.d.ts）已经被tsconfig的include规则覆盖即可。

内容的提问来源于stack exchange，提问作者Ruan Mendes