Use camelCase for JS identifiers

FGRibreau · Mar 19, 2016 · 1e099a4 · 1e099a4
1 parent 0461b2d
commit 1e099a4
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 49 deletions.
diff --git a/README.md b/README.md
@@ -37,12 +37,12 @@ MailChecker currently supports:
 ```javascript
 var MailChecker = require('mailchecker');
 
-if(!MailChecker.is_valid('myemail@yopmail.com')){
+if(!MailChecker.isValid('myemail@yopmail.com')){
   console.error('O RLY !');
   process.exit(1);
 }
 
-if(!MailChecker.is_valid('myemail.com')){
+if(!MailChecker.isValid('myemail.com')){
   console.error('O RLY !');
   process.exit(1);
 }
@@ -52,11 +52,11 @@ if(!MailChecker.is_valid('myemail.com')){
 ```html
 <script type="text/javascript" src="MailChecker/platform/javascript/MailChecker.js"></script>
 <script type="text/javascript">
-if(!MailChecker.is_valid('myemail@yopmail.com')){
+if(!MailChecker.isValid('myemail@yopmail.com')){
   console.error('O RLY !');
 }
 
-if(!MailChecker.is_valid('myemail.com')){
+if(!MailChecker.isValid('myemail.com')){
   console.error('O RLY !');
 }
 </script>

diff --git a/platform/javascript/MailChecker.js b/platform/javascript/MailChecker.js
diff --git a/platform/javascript/MailChecker.tmpl.js b/platform/javascript/MailChecker.tmpl.js
@@ -1,12 +1,12 @@
 /**
- * MailChecker.is_valid(String email);
+ * MailChecker.isValid(String email);
  * @return {Boolean} true is the specified email is valid, false otherwise
  *
  * Usage
  *
  * <script type="text/javascript" src="mailchecker/platform/javascript/mailchecker.js"></script>
  * <script type="text/javascript">
- *   alert(MailChecker.is_valid("plop@plop.33mail.com"));
+ *   alert(MailChecker.isValid("plop@plop.33mail.com"));
  * </script>
  */
 
@@ -24,25 +24,25 @@
     return arr;
   }
 
-  function all_domain_suffixes(email) {
-    var domain_components = email.split('@')[1].split('.');
+  function allDomainSuffixes(email) {
+    var domainComponents = email.split('@')[1].split('.');
 
-    return mapRange(0, domain_components.length, function (n) {
-      return domain_components.slice(n).join('.');
+    return mapRange(0, domainComponents.length, function (n) {
+      return domainComponents.slice(n).join('.');
     });
   }
 
-  function is_blacklisted(email) {
-    return all_domain_suffixes(email).some(function (domain_suffix) {
-      return blacklist.indexOf(domain_suffix) >= 0;
+  function isBlacklisted(email) {
+    return allDomainSuffixes(email).some(function (domainSuffix) {
+      return blacklist.indexOf(domainSuffix) >= 0;
     });
   };
 
   global.MailChecker = {
-    is_valid: function (email){
+    isValid: function (email){
       email = email.toLowerCase();
       if(!isValidEmail.test(email)){return false;}
-      return !is_blacklisted(email);
+      return !isBlacklisted(email);
     },
     blacklist: function () {
       return blacklist;

diff --git a/platform/node/index.js b/platform/node/index.js
diff --git a/platform/node/index.tmpl.js b/platform/node/index.tmpl.js
@@ -2,35 +2,35 @@
  * Usage
  *
  * var MailChecker = require('mailchecker/platform/node')
- * MailChecker.is_valid(String email);
+ * MailChecker.isValid(String email);
  * @return {Boolean} true is the specified email is valid, false otherwise
  */
 var range = require('node-range');
 
 var blacklist        = [{{& listSTR }}];
 var isValidEmail     = /{{& regexp }}/;
 
-function all_domain_suffixes(email) {
-  var domain_components = email.split('@')[1].split('.');
+function allDomainSuffixes(email) {
+  var domainComponents = email.split('@')[1].split('.');
 
-  return range(0, domain_components.length).map(function (n) {
-    return domain_components.slice(n).join('.');
+  return range(0, domainComponents.length).map(function (n) {
+    return domainComponents.slice(n).join('.');
   });
 }
 
-function is_blacklisted(email) {
-  function suffix_is_blacklisted(domain_suffix) {
-    return blacklist.indexOf(domain_suffix) >= 0;
+function isBlacklisted(email) {
+  function suffixIsBlacklisted(domainSuffix) {
+    return blacklist.indexOf(domainSuffix) >= 0;
   }
 
-  return all_domain_suffixes(email).some(suffix_is_blacklisted);
+  return allDomainSuffixes(email).some(suffixIsBlacklisted);
 };
 
 module.exports = {
-  is_valid: function (email){
+  isValid: function (email){
     email = email.toLowerCase();
     if(!isValidEmail.test(email)){return false;}
-    return !is_blacklisted(email);
+    return !isBlacklisted(email);
   },
   blacklist: function () {
     return blacklist;

diff --git a/test/platform.node.test.js b/test/platform.node.test.js
@@ -8,7 +8,7 @@ suite('Node', function () {
   });
 
   function _is(b, email) {
-    t.equal(MailChecker.is_valid(email), b, "MailChecker.is_valid(" + email + ") === " + b);
+    t.equal(MailChecker.isValid(email), b, "MailChecker.isValid(" + email + ") === " + b);
   }
   var isValid = _is.bind(this, true);
   var isInvalid = _is.bind(this, false);