Cucumber-js-tsflow 项目教程

Cucumber-js-tsflow 项目教程

cucumber-js-tsflowProvides 'specflow' like bindings for Cucumber.js in TypeScript 1.7+.项目地址:https://gitcode.com/gh_mirrors/cu/cucumber-js-tsflow

1. 项目的目录结构及介绍

cucumber-js-tsflow/
├── CONTRIBUTE.md
├── LICENSE
├── README.md
├── cucumber-js
│   ├── features/
│   │   └── example.feature
│   ├── step_definitions/
│   │   └── example_steps.ts
│   ├── support/
│   │   ├── hooks.ts
│   │   └── world.ts
│   ├── tsconfig.json
│   └── tslint.json
├── lerna.json
├── package.json
├── tsconfig.json
└── tslint.json

• CONTRIBUTE.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• cucumber-js/: CucumberJS 相关文件夹。
  • features/: 存放功能文件，描述测试场景。
  • step_definitions/: 存放步骤定义文件，实现功能文件中的步骤。
  • support/: 存放支持文件，如钩子文件和世界文件。
  • tsconfig.json: TypeScript 配置文件。
  • tslint.json: TypeScript 代码风格检查配置文件。
• lerna.json: Lerna 多包管理配置文件。
• package.json: 项目依赖和脚本配置文件。
• tsconfig.json: 根目录下的 TypeScript 配置文件。
• tslint.json: 根目录下的 TypeScript 代码风格检查配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 cucumber-js/step_definitions/example_steps.ts，该文件定义了 CucumberJS 的步骤实现。以下是一个示例：

import { binding, given, when, then } from 'cucumber-tsflow';

@binding()
class ArithmeticSteps {
  private computedResult: number = 0;

  @given(/I have entered (\d+) into the calculator/)
  public givenNumberEntered(num: string): void {
    this.computedResult = parseInt(num);
  }

  @when(/I press add/)
  public whenPressAdd(): void {
    this.computedResult += this.computedResult;
  }

  @then(/the result should be (\d+) on the screen/)
  public thenResultShouldBe(expectedResult: string): void {
    if (this.computedResult !== parseInt(expectedResult)) {
      throw new Error('Arithmetic Error');
    }
  }
}

export = ArithmeticSteps;

3. 项目的配置文件介绍

tsconfig.json

tsconfig.json 文件用于配置 TypeScript 编译选项。以下是一个示例配置：

{
  "compilerOptions": {
    "module": "commonjs",
    "target": "es6",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "experimentalDecorators": true
  },
  "include": ["src/**/*"]
}

package.json

package.json 文件用于配置项目的依赖和脚本。以下是一个示例配置：

{
  "name": "cucumber-js-tsflow",
  "version": "1.0.0",
  "description": "Provides 'specflow' like bindings for CucumberJS in TypeScript",
  "main": "index.js",
  "scripts": {
    "test": "cucumber-js"
  },
  "dependencies": {
    "@cucumber/cucumber": "^7.0.0",
    "cucumber-tsflow": "^4.0.0"
  },
  "devDependencies": {
    "typescript": "^4.0.0"
  }
}

通过以上配置，您可以安装依赖并运行测试脚本：

npm install
npm test

希望这份教程能帮助您更好地理解和使用 cucumber-js-tsflow 项目。

cucumber-js-tsflowProvides 'specflow' like bindings for Cucumber.js in TypeScript 1.7+.项目地址:https://gitcode.com/gh_mirrors/cu/cucumber-js-tsflow