feat: add global addRule method (#46)

Author: fengmk2

.travis.yml

@@ -3,6 +3,7 @@ language: node_js
 notifications:
   email: false
 node_js:
+  - '10'
   - '8'
   - '6'
   - '4'

LICENSE.txt

@@ -1,6 +1,6 @@
 This software is licensed under the MIT License.
 
-Copyright(c) 2013 - 2017 node-modules and other contributors.
+Copyright(c) 2013 - 2018 node-modules and other contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

index.js

@@ -58,7 +58,7 @@ class Parameter {
 
     if (this.validateRoot && (typeof obj !== 'object' || !obj)) {
       return [{
-        message: 'the validated value should be a object',
+        message: this.t('the validated value should be a object'),
         code: this.t('invalid'),
         field: undefined,
       }];
@@ -111,34 +111,6 @@ class Parameter {
       return errors;
     }
   }
-
-  /**
-   * add custom rule
-   *
-   * @param {String} type
-   * @param {Function | RegExp} check
-   * @api public
-   */
-
-  addRule(type, check) {
-    if (!type) {
-      throw new TypeError('`type` required');
-    }
-
-    if (typeof check === 'function') {
-      TYPE_MAP[type] = check;
-      return;
-    }
-
-    if (check instanceof RegExp) {
-      TYPE_MAP[type] = function (rule, value) {
-        return checkString.call(this, {format: check}, value);
-      };
-      return;
-    }
-
-    throw new TypeError('check must be function or regexp');
-  }
 };
 
 /**
@@ -147,6 +119,41 @@ class Parameter {
  */
 module.exports = Parameter;
 
+/**
+ * add custom rule to global rules list.
+ *
+ * @param {String} type
+ * @param {Function | RegExp} check
+ * @param {Boolean} [override] - override exists rule or not, default is true
+ * @api public
+ */
+Parameter.prototype.addRule = Parameter.addRule = function addRule(type, check, override) {
+  if (!type) {
+    throw new TypeError('`type` required');
+  }
+
+  if (typeof override !== 'boolean') {
+    override = true;
+  }
+
+  if (!override && TYPE_MAP[type]) {
+    throw new TypeError('rule `' + type + '` exists');
+  }
+
+  if (typeof check === 'function') {
+    TYPE_MAP[type] = check;
+    return;
+  }
+
+  if (check instanceof RegExp) {
+    TYPE_MAP[type] = function (rule, value) {
+      return checkString.call(this, {format: check}, value);
+    };
+    return;
+  }
+
+  throw new TypeError('check must be function or regexp');
+};
 
 /**
  * Simple type map
@@ -299,7 +306,7 @@ function checkString(rule, value) {
  */
 
 function checkId(rule, value) {
-  return checkString.call(this, {format: ID_RE, allowEmpty: rule.allowEmpty}, value);
+  return checkString.call(this, { format: ID_RE, allowEmpty: rule.allowEmpty }, value);
 }
 
 /**
@@ -313,7 +320,7 @@ function checkId(rule, value) {
  */
 
 function checkDate(rule, value) {
-  return checkString.call(this, {format: DATE_TYPE_RE, allowEmpty: rule.allowEmpty}, value);
+  return checkString.call(this, { format: DATE_TYPE_RE, allowEmpty: rule.allowEmpty }, value);
 }
 
 /**
@@ -327,7 +334,7 @@ function checkDate(rule, value) {
  */
 
 function checkDateTime(rule, value) {
-  return checkString.call(this, {format: DATETIME_TYPE_RE, allowEmpty: rule.allowEmpty}, value);
+  return checkString.call(this, { format: DATETIME_TYPE_RE, allowEmpty: rule.allowEmpty }, value);
 }
 
 /**

test/index.test.js

@@ -1,17 +1,5 @@
-/**
- * Copyright(c) node-modules and other contributors.
- * MIT Licensed
- *
- * Authors:
- *  dead_horse <dead_horse@qq.com>
- */
-
 'use strict';
 
-/**
- * Module dependencies.
- */
-
 var should = require('should');
 var util = require('util');
 var Parameter = require('..');
@@ -350,6 +338,14 @@ describe('parameter', function () {
             message: 'should be an email'
           }
         ]);
+
+        parameter.validate({ name: { type: 'email', message: '错误 email' } }, { name: email }).should.eql([
+          {
+            code: 'invalid',
+            field: 'name',
+            message: '错误 email'
+          }
+        ]);
       });
     });
   });
@@ -407,6 +403,23 @@ describe('parameter', function () {
           message: 'length should bigger than 6'
         }
       ]);
+
+      parameter.validate({
+        password: {
+          type: 'password',
+          min: 4,
+          compare: 're-password'
+        }
+      }, {
+        password: '1',
+        're-password': '1',
+      }).should.eql([
+        {
+          code: 'invalid',
+          field: 'password',
+          message: 'length should bigger than 4'
+        }
+      ]);
     });
   });
 
@@ -475,6 +488,14 @@ describe('parameter', function () {
             message: 'should be a url'
           }
         ]);
+
+        parameter.validate({ name: { type: 'url', message: '不合法 url' } }, { name: url }).should.eql([
+          {
+            code: 'invalid',
+            field: 'name',
+            message: '不合法 url'
+          }
+        ]);
       });
     });
   });
@@ -632,6 +653,18 @@ describe('parameter', function () {
       (function () {
         parameter.addRule();
       }).should.throw('`type` required');
+      (function () {
+        Parameter.addRule();
+      }).should.throw('`type` required');
+    });
+
+    it('should throw error when override exists rule', function () {
+      (function () {
+        parameter.addRule('string', function() {}, false);
+      }).should.throw('rule `string` exists');
+      (function () {
+        Parameter.addRule('string', function() {}, false);
+      }).should.throw('rule `string` exists');
     });
 
     it('should throw without check', function () {
@@ -658,6 +691,13 @@ describe('parameter', function () {
       var value = {key: 'not-prefixed'};
       parameter.validate(rule, value)[0].message.should.equal('should match /^prefix/');
     });
+
+    it('should add with regexp on global', function () {
+      Parameter.addRule('prefix2', /^prefix/);
+      var rule = {key: 'prefix2'};
+      var value = {key: 'not-prefixed'};
+      parameter.validate(rule, value)[0].message.should.equal('should match /^prefix/');
+    });
   });
 
   describe('custom translate function', function(){