Revalidate 开源项目教程

Revalidate 开源项目教程

revalidateElegant and composable validations项目地址:https://gitcode.com/gh_mirrors/re/revalidate

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

Revalidate 项目的目录结构如下：

revalidate/
├── src/
│   ├── core/
│   │   ├── createValidator.js
│   │   ├── index.js
│   │   ├── isPromise.js
│   │   ├── utils.js
│   │   └── validators.js
│   ├── index.js
│   └── utils.js
├── test/
│   ├── core/
│   │   ├── createValidator.spec.js
│   │   ├── index.spec.js
│   │   ├── isPromise.spec.js
│   │   ├── utils.spec.js
│   │   └── validators.spec.js
│   ├── index.spec.js
│   └── utils.spec.js
├── .babelrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── package.json
├── README.md
└── yarn.lock

目录结构介绍

• src/: 包含项目的主要源代码。

  • core/: 包含核心功能的实现文件。
    • createValidator.js: 创建验证器的功能。
    • index.js: 核心模块的入口文件。
    • isPromise.js: 判断是否为 Promise 的功能。
    • utils.js: 工具函数。
    • validators.js: 验证器集合。
  • index.js: 项目的入口文件。
  • utils.js: 其他工具函数。

• test/: 包含项目的测试文件。

  • core/: 核心功能的测试文件。
  • index.spec.js: 入口文件的测试。
  • utils.spec.js: 工具函数的测试。

• .babelrc: Babel 配置文件。

• .gitignore: Git 忽略文件配置。

• .npmignore: npm 忽略文件配置。

• .travis.yml: Travis CI 配置文件。

• LICENSE: 项目许可证。

• package.json: 项目依赖和脚本配置。

• README.md: 项目说明文档。

• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js，该文件是整个项目的入口点，负责导出项目的主要功能。

// src/index.js
export { default as createValidator } from './core/createValidator';
export { default as validators } from './core/validators';
export { default as utils } from './utils';

启动文件介绍

• createValidator: 导出创建验证器的功能。
• validators: 导出验证器集合。
• utils: 导出工具函数。

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 .babelrc。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "revalidate",
  "version": "2.0.0",
  "description": "Elegant, flexible validation for React components",
  "main": "dist/index.js",
  "module": "dist/index.es.js",
  "files": [
    "dist"
  ],
  "scripts": {
    "build": "rollup -c",
    "prepublishOnly": "npm run build",
    "test": "jest"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/jfairbank/revalidate.git"
  },
  "keywords": [
    "react",
    "validation",
    "form",
    "validator"
  ],
  "author": "Jeremy Fairbank <elpapapollo@gmail.com> (http://jeremyfairbank.com)",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/jfairbank/revalidate/issues"
  },
  "homepage": "https://github.com/jfairbank/revalidate#readme",
  "devDependencies": {
    "babel-core": "^6.26

revalidateElegant and composable validations项目地址:https://gitcode.com/gh_mirrors/re/revalidate