HTML5Validate 项目教程

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

html5Validate/
├── src/
│   └── jquery-html5Validate.js
├── test/
│   └── index.html
├── .gitattributes
├── .gitignore
├── LICENSE-MIT
├── README.md
└── package.json

目录结构介绍

• src/: 存放项目的主要源代码文件，其中 jquery-html5Validate.js 是基于HTML5表单验证的jQuery插件。
• test/: 存放测试文件，index.html 是用于测试表单验证功能的页面。
• .gitattributes: Git 属性配置文件，用于定义文件的属性。
• .gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
• LICENSE-MIT: 项目的许可证文件，采用 MIT 许可证。
• README.md: 项目的说明文档，包含项目的基本信息和使用说明。
• package.json: 项目的配置文件，包含项目的元数据和依赖信息。

2. 项目的启动文件介绍

项目的启动文件是 src/jquery-html5Validate.js。这个文件是基于HTML5表单验证的jQuery插件，提供了对HTML5表单元素的验证功能。

启动文件功能介绍

• 表单验证: 支持 type="email"、type="number"、type="tel"、type="url"、type="zipcode" 等HTML5表单元素的验证。
• 自定义扩展属性: 支持 data-key、data-target、data-min、data-max 等自定义扩展属性。
• 多类型支持: 支持多类型验证，如 type="email|tel"。

3. 项目的配置文件介绍

项目的配置文件是 package.json。这个文件包含了项目的元数据和依赖信息。

配置文件内容介绍

{
  "name": "html5Validate",
  "version": "1.0.0",
  "description": "基于HTML5新特性新规范的表单验证jQuery插件",
  "main": "src/jquery-html5Validate.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/zhangxinxu/html5Validate.git"
  },
  "author": "zhangxinxu",
  "license": "MIT",
  "bugs": {
    "url": "https://github.com/zhangxinxu/html5Validate/issues"
  },
  "homepage": "https://github.com/zhangxinxu/html5Validate#readme"
}

配置文件字段说明

• name: 项目名称，这里是 html5Validate。
• version: 项目版本号，当前版本为 1.0.0。
• description: 项目描述，简要介绍了项目是一个基于HTML5新特性新规范的表单验证jQuery插件。
• main: 项目的入口文件，指向 src/jquery-html5Validate.js。
• scripts: 定义了一些脚本命令，例如 test 命令用于运行测试。
• repository: 项目的代码仓库信息，包括类型和URL。
• author: 项目作者，这里是 zhangxinxu。
• license: 项目采用的许可证，这里是 MIT。
• bugs: 项目的问题追踪地址，指向 GitHub 上的 issues 页面。
• homepage: 项目的官方主页，指向 GitHub 上的 README 页面。