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

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

check-build :dart: Check-build - Verifies that your NodeJS project follows team conventions, is well written, up to date and secure. 项目地址: https://gitcode.com/gh_mirrors/ch/check-build

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

check-build 项目是一个用于验证 NodeJS 项目是否遵循团队规范、代码质量、更新状态和安全的工具。以下是项目的目录结构及其组成部分的简要介绍：

• bin/: 存放可执行文件。
• defaults/: 包含项目默认配置文件。
• docs/: 存放项目文档和相关 GIF 演示。
• src/: 源代码目录，包含项目的核心逻辑。
• .dockerignore: 用于 Docker 的构建忽略文件。
• .eslintrc: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• .nvmrc: 指定 Node.js 版本的文件。
• CHANGELOG.md: 变更日志文件。
• Dockerfile: Docker 构建文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• package.json: 项目依赖和脚本定义文件。

2. 项目的启动文件介绍

check-build 的启动主要是通过命令行工具进行的。全局安装 check-build 之后，可以通过以下命令启动项目检查：

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

如果一切正常，命令行会返回 0；如果存在问题，则返回 1。

3. 项目的配置文件介绍

check-build 使用多种工具进行代码检查，并通过配置文件来定制化检查规则。以下是一些主要的配置文件：

• .jshintrc: JSHint 配置文件，用于定义 JavaScript 代码的静态检查规则。
• .eslintrc: ESLint 配置文件，用于定义 JavaScript 和 JSX 代码的检查规则。
• .jscsrc: JSCS 配置文件，用于检查代码风格。
• .checkbuild: check-build 的主配置文件，用于定义启用哪些检查工具，以及其他相关设置。

在项目根目录下创建一个 .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": []
  },
  "david": {
    "dev": false,
    "stable": true,
    "ignore": []
  }
}

通过以上配置，可以定制项目的检查规则，确保代码质量和安全性。

check-build :dart: Check-build - Verifies that your NodeJS project follows team conventions, is well written, up to date and secure. 项目地址: https://gitcode.com/gh_mirrors/ch/check-build