初始化环境

本文,主要是对于开发与测试环境的初始化。在本项目中,将采用 jest 作为功能测试框架。使用 typescript 作为主要开发语言。

请按照以下步骤初始化环境:

1. 初始化仓库

为了更好管理仓库的版本,请使用 Git 作为版本管理工具,请确保你的仓库中已初始化 Git

请确保你的仓库已经初始化 package.json

请确保该仓库使用的包管理工具是 pnpm

2. 安装必要的包

# 安装 typescript
pnpm add -D typescript
# 配置 tsconfig.json
npx tsc --init
# 安装 jest @types/jest
pnpm add -D jest @types/jest

3. 配置 npm script

{
    “scripts”: {
        "test": "jest"
    }
}

可以通过 pnpm test 来运行所有的单元测试,也可以通过 VS Code 插件 Jest Runner 来对某一个参数单独 Debug 或 Run。

这里需要说明一下,如果使用 Jest Runner 来单独对某个测试进行 Run 的话,可能会出现报错问题(v27.5.1)这个版本会出现,解决办法如下:

  1. 创建 /.vscode/settings.json

  2. 将下面的代码添加到此配置文件中

    {
      "jestrunner.jestPath": "node_modules/jest/bin/jest.js"
    }
    
  3. 关于此问题的 issueopen in new window

4. 配置 jest ESM support

为了更好的编写测试代码,我们需要让 jest 支持 ESM。方法如下:

  1. 安装必要的包

    pnpm add -D babel-jest @babel/core @babel/preset-env @babel/preset-typescript
    
  2. 创建 bable.config.js,并将下面的内容加入到配置文件中

    module.exports = {
      presets: [
          ['@babel/preset-env', {targets: {node: 'current'}}],
          '@babel/preset-typescript',
      ],
    };
    
  3. 即可

以上,项目初始化配置已经配完。