Async Validate 项目启动与配置教程

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

Async Validate 是一个用于节点和浏览器的异步类型验证库。它具有最小的依赖关系，并使用插件架构，因此您只需要包含您想要验证的类型插件，并且可以轻松创建自己的验证插件。

项目的主要目录结构如下：

• doc/: 存放项目文档。
• lib/: 包含项目的核心代码。
• plugin/: 存放各种验证插件。
• test/: 包含项目的单元测试。
• .gitignore: 指定Git应该忽略的文件和目录。
• .jscsrc: JSCS配置文件。
• .jshintignore: 指定Jshint应该忽略的文件。
• .jshintrc: Jshint配置文件。
• .travis.yml: Travis CI持续集成配置文件。
• EXAMPLE.md: 项目使用示例文档。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• index.js: 项目入口文件。
• messages.js: 存放错误消息的文件。
• mkdoc.js: 生成文档的脚本。
• package.json: 项目元数据和脚本。
• system.js: 类型系统定义文件。
• yarn.lock: 项目依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件是index.js，它是项目的入口点。在这个文件中，通常会创建Schema类的实例，定义验证规则，然后调用validate方法对数据进行验证。

以下是一个简单的启动文件示例：

const Schema = require('async-validate');
const descriptor = {
  type: 'object',
  fields: {
    name: {
      type: 'string',
      required: true
    }
  }
};

const schema = new Schema(descriptor);
const source = {}; // 需要验证的数据源

schema.plugin([
  require('async-validate/plugin/object'),
  require('async-validate/plugin/string'),
  require('async-validate/plugin/util')
]);

schema.validate(source, function(err, res) {
  if (err) {
    throw err;
  } else if (res) {
    console.dir(res.errors); // 验证失败，输出错误信息
  } else {
    // 验证通过
  }
});

3. 项目的配置文件介绍

项目的配置文件主要包括.jscsrc、.jshintignore、.jshintrc和package.json。

• .jscsrc: JSCS（JavaScript Code Style）配置文件，用于定义代码风格规则。
• .jshintignore: 指定Jshint在静态代码分析时应该忽略的文件。
• .jshintrc: Jshint配置文件，用于定义JavaScript代码的静态分析规则。
• package.json: 项目包配置文件，定义了项目的依赖、脚本和元数据。

例如，package.json中的scripts部分可以定义一些常用的命令，如下所示：

{
  "scripts": {
    "test": "jest",
    "build": "babel src -d lib",
    "start": "node index.js"
  }
}

在这个配置文件中，可以运行npm start来启动项目，npm test来执行测试，以及npm run build来构建项目。