1.x 升级到 2.x 指南

.npmignore

@@ -4,4 +4,5 @@ example
 test
 node_modules
 *.js.map
-webpack.config.js
+webpack.config.js
+UPGRADE.md

README.md

@@ -9,7 +9,7 @@
 
 </div>
 
-> v2 和 v1 版本差别较大，如果您使用的是老版本，可以查看 [v1 版本](https://github.com/ChanceYu/we-validator/tree/v1)。推荐使用 2.x 版本。
+> v2 和 v1 版本差别较大，如果您继续使用老版本，可以查看 [v1 版本](https://github.com/ChanceYu/we-validator/tree/v1)。如果您要升级到 2.x 请先阅读[升级指南](./UPGRADE.md)，推荐使用 2.x 版本。
 
 简单灵活的表单验证插件，支持小程序、浏览器、Nodejs。小程序端支持：微信、支付宝、百度智能、今日头条，小程序默认提示使用 `showToast`。
 
@@ -142,7 +142,7 @@ Page({
 | 规则 | 描述 | 默认提示 |
 | --- | --- | --- |
 | `required: true` | 必填 | 此字段必填 |
-| `regex: /^\d+$/` | 正则通用 | 不符合此验证规则 |
+| `pattern: /^\d+$/` | 正则通用 | 不符合此验证规则 |
 | `email: true` | 电子邮件格式 | 请输入有效的电子邮件地址 |
 | `mobile: true` | 11位手机号 | 请输入11位的手机号码 |
 | `tel: true` | 座机号<br>例如：010-1234567、0551-1234567 | 请输入座机号 |

UPGRADE.md

@@ -0,0 +1,134 @@
+## 1.x 升级到 2.x 指南
+
+2.x 和 1.x 版本有所差别，如果您要升级到 2.x 版本，请根据以下内容做修改。
+
+### 添加自定义规则
+> WeValidator.addRule
+
+1.x 版本
+```javascript
+WeValidator.addRule('theRuleName', function(value, param){
+    return /\d/.test(value)
+})
+```
+2.x 版本
+```javascript
+WeValidator.addRule('theRuleName', {
+  message: '默认错误提示文字',
+  rule(value, param){
+    return /\d/.test(value)
+  }
+})
+
+// 或者
+WeValidator.addRule('theRuleName', {
+  message: '默认错误提示文字',
+  rule: /\d/
+})
+```
+
+### 单独校验某个内容
+> WeValidator.checkValue
+
+1.x 版本
+```javascript
+let b1 = WeValidator.mobile('str')
+let b2 = WeValidator.chinese('str')
+```
+2.x 版本
+```javascript
+let b1 = WeValidator.checkValue('mobile', 'str')
+let b2 = WeValidator.checkValue('chinese', 'str')
+```
+
+### 默认校验规则的变化
+2.x 的校验规则大部分重写，删除了不常用的规则，并添加了新的规则
+
+##### 删除的规则（可使用 2.x 相关规则替代）
+```diff
+- bankCard: true
++ range: [16, 19]
+
+- mobileWithSpace
++ pattern: /^1\d{2}\s?\d{4}\s?\d{4}$/
+
+- noZeroStart
++ pattern: /^([1-9][0-9]*)$/
+
+- specialStr
++ pattern: /[^%&',;=?$\x22]+/
+
+- money
++ pattern: /^\d+\.\d{2}$/
+
+- month
++ pattern: /^(0?[1-9]|1[0-2])$/
+
+- day
++ pattern: /^((0?[1-9])|((1|2)[0-9])|30|31)$/
+
+- html
++ pattern: /<(.*)>(.*)<\/(.*)>|<(.*)\/>/
+
+- spaceEnter
++ pattern: /\n[\s| ]*\r/
+
+- qq
++ pattern: /^[1-9][0-9]{4,}$/
+
+- zip
++ pattern: /^[\d]{6}/
+
+- doubleByte
++ pattern: /[^\x00-\xff]/
+
+- intLength: 2
++ pattern: /^\d{2}$/
+
+- decimalLength: 2
++ pattern: /^[0-9]+(.[0-9]{2}$/
+
+- decimalLengthRange: [2, 4]
++ pattern: /^[0-9]+(.[0-9]{2,4}$/
+
+- stringLetter: 'a'
++ pattern: /^[a-z]+$/
+
+- stringLetterDefault
++ pattern: /^\w+$/
+```
+
+##### 规则名称变化
+```diff
+- idCard
++ idcard
+
+- chinese2to8: true
++ rangeChinese: [2, 8]
+
+- intOrFloat
++ number
+
+- int
++ digits
+
+- httpUrl
++ url
+
+- equal: WeValidator.$value('field')
++ equalTo: 'field'
+
+- intLessLength: 2
++ min: 2
+
+- intGreater: 2
++ max: 2
+
+- intLengthRange: [2, 6]
++ range: [2, 6]
+
+- stringLength: 6
++ length: 6
+```
+
+##### 2.x 新增规则[参考](./README.md#默认支持的规则)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "we-validator",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "description": "简单灵活的表单验证插件，支持小程序、浏览器、Nodejs",
   "main": "lib/we-validator.js",
   "scripts": {

src/rules.js

@@ -16,7 +16,7 @@ module.exports = {
   /**
    * 正则通用
    */
-  regex: {
+  pattern: {
     message: '不符合此验证规则',
     rule(value, param){
       return param.test(value)