三号线

我让人类更容易接受代码审查

文档

您可以找到所有检查的文件 这里

使用量

添加一个 github 工作流程, 并确保它看起来与这个 repo 中的类似 .

这是一个例子,你也许可以 只是通过你安装 dev 依赖的 三平 npm 包 :

name: Threepio Code Review Notes
on:
  pull_request:
    types: [opened, synchronize, edited]

jobs:
  comment:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Use Node.js 20.x
        uses: actions/setup-node@v2
        with:
          node-version: 20.x
      - run: npm i
      - uses: actions/github-script@v6
        with:
          script: |
            const threepio = require('threepio')
            const res = await threepio.review(context, github)

            if (!res) {
              process.exit(1)
            }

配置

您可以创建 .threepio 在工程的根中使用 3pio 来更改 每个项目的配置。 这个 .threepio file 是以下描述的 yaml 文件 . warning 导致在注释中打印信件, 但不是失败 建设. error 做同样的事情,但也导致建设步骤失败.

tests:
  jiraTickets: warning
  testPlanCheck: error
  allFilesTested: error
  checkMigrations: warn
  changeSizeCheck: warning

jira:
  projects:
    - DOOM
    - PLAT

rules:
  allFilesTested:
    exclude:
      - src/types.ts
      - src/test-helpers/index.ts

这个 rules 区域允许将配置传递给特定的测试。 实例 上列排除某些文件 所有已测试的档案 他们不会在读取中出现。 比如说,很可能 不会是测试 src/types.ts 文件只包含类型,所以 排除它会提高评论的信号与噪声的比例.

创建新线条

运行 : bin/new-lint

这将创建您需要的所有文件, 并修改大多数文件的导入 需要导入的地方 才能让你工作 全部归你们 需要更新其中的文档 docs/rules.md,林特代码, 它的测试文件, 以及其它文件中的几个测试, 将开始失败直到 你更新它们 以说明你写的新字条.