Shortest 使用教程

Shortest 使用教程

shortest QA via natural language AI tests 项目地址: https://gitcode.com/gh_mirrors/sh/shortest

1. 项目目录结构及介绍

Shortest 是一个基于自然语言的人工智能端到端测试框架，其项目目录结构如下：

shortest/
├── .github/                # GitHub 相关配置
├── app/                    # 应用程序代码
├── components/             # 通用组件
├── eslint/                 # ESLint 配置
├── examples/               # 示例测试文件
├── gem/                    # 相关依赖和资源
├── hooks/                  # 自定义钩子
├── lib/                    # 库文件
├── packages/               # 包文件，包含 Shortest 核心代码
├── test-cli/               # 命令行测试工具
├── .cursorrules/           # 光标规则
├── .env.example            # 环境变量示例文件
├── .git-blame-ignore-revs  # Git blame 忽略的提交
├── .gitignore              # Git 忽略文件
├── .prettierrc             # Prettier 配置
├── README.md               # 项目说明文件
├── components.json         # 组件配置文件
├── drizzle.config.ts        # Drizzle 配置文件
├── eslint.config.js        # ESLint 配置文件
├── license.md              # 许可文件
├── middleware.ts           # 中间件
├── next.config.ts          # Next.js 配置文件
├── package.json            # 项目包配置
├── pnpm-lock.yaml          # pnpm 锁文件
├── pnpm-workspace.yaml      # pnpm 工作空间配置
├── postcss.config.mjs      # PostCSS 配置
├── shortest.config.ts      # Shortest 配置文件
├── shortest.yml            # Shortest 配置文件（YAML 格式）
├── tailwind.config.ts      # Tailwind CSS 配置
└── tsconfig.json           # TypeScript 配置

2. 项目的启动文件介绍

项目的启动主要是通过 pnpm（Performant npm）来管理。以下是一些基本的命令：

• 安装依赖：pnpm install
• 运行测试：pnpm shortest
• 运行特定测试文件：pnpm shortest login.test.ts
• 运行特定测试文件中的特定测试：pnpm shortest login.test.ts:23
• 在无头模式下运行测试：pnpm shortest --headless

3. 项目的配置文件介绍

Shortest 项目的配置主要涉及以下几个文件：

• .env.example：环境变量示例文件，包含了项目运行所需要的环境变量的示例值。
• shortest.config.ts 或 shortest.yml：Shortest 的配置文件，用于设置测试框架的参数，如 baseUrl、browser 配置、testPattern、AI 提供商等。

以下是一个 shortest.config.ts 的配置示例：

import type { ShortestConfig } from "@antiwork/shortest";

export default {
  headless: false,
  baseUrl: "http://localhost:3000",
  browser: {
    contextOptions: {
      ignoreHTTPSErrors: true,
    },
  },
  testPattern: "**/*.test.ts",
  ai: {
    provider: "anthropic",
  },
} satisfies ShortestConfig;

这个配置文件设置了测试运行时的基本参数，包括无头模式、基础 URL、浏览器上下文选项、测试文件模式以及 AI 提供商。根据项目需求，这些参数可以进行相应的调整。

shortest QA via natural language AI tests 项目地址: https://gitcode.com/gh_mirrors/sh/shortest