Check-Build 项目启动与配置教程

1. 项目目录结构及介绍

Check-Build 是一个用于验证 NodeJS 项目是否遵循团队规范、编写良好、更新及时且安全的工具。项目的主要目录结构如下：

• bin/: 存放可执行脚本文件。
• defaults/: 默认配置文件。
• docs/: 项目文档。
• src/: 源代码目录。
• .dockerignore: Docker 忽略文件。
• .eslintrc: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• .nvmrc: Node.js 版本管理配置文件。
• CHANGELOG.md: 更新日志。
• Dockerfile: Docker 容器构建文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• package.json: 项目依赖及配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 bin/ 目录中的脚本进行。全局安装 check-build 后，可以在项目目录中使用 check-build 命令来启动检查。

npm install check-build -g
cd /path/to/your/project
check-build

如果一切正常，命令行将返回 0；如果有错误，将返回 1。

3. 项目的配置文件介绍

Check-Build 使用多种工具来检查代码质量和安全，这些工具的配置文件通常以点文件（.config.json）的形式存在。

• .jshintrc: JSHint 配置文件，用于静态分析 JavaScript 代码。
• .eslintrc: ESLint 配置文件，用于 JavaScript 和 JSX 代码的语法检查。
• .jscsrc: JSCS 配置文件，用于检查代码风格。
• .checkbuild: Check-Build 的配置文件，用于自定义检查过程。

在项目根目录下创建 .checkbuild 文件，可以自定义项目的检查配置。以下是一个 .checkbuild 的配置示例：

{
  "checkbuild": {
    "enable": ["jshint", "eslint", "jscs", "jsinspect", "plato", "nsp", "david"],
    "continueOnError": true,
    "allowFailures": false
  },
  "david": {
    "warn": {
      "E404": true
    },
    "ignore": ["socket.io"]
  },
  "jshint": {
    "args": ["src/**/*.js"]
  },
  "eslint": {
    "args": ["src/**/*.js", "src/**/*.jsx"]
  },
  "jscs": {
    "args": ["lib/**/*.js"]
  },
  "jsinspect": {
    "args": ["*.js"],
    "diff": true
  },
  "buddyjs": {
    "args": ["*.js"],
    "ignore": [0, 1, 200]
  },
  "plato": {
    "args": ["*.js"],
    "maintainability": 75.00
  },
  "nsp": {
    "args": []
  }
}

确保按照项目需求调整配置文件，以便正确执行检查。