yoctore/yocto-api

View on GitHub
src/index.js

Summary

Maintainability
F
1 wk
Test Coverage

Function addRoute has 278 lines of code (exceeds 25 allowed). Consider refactoring.
Open

RouteController.prototype.addRoute = function (pathRequest, nameModel, reqExcluded, param, route,
pathCallback) {

  // Object that will contains all private function
  var httpMethods = {};
Severity: Major
Found in src/index.js - About 1 day to fix

    Function addRoute has a Cognitive Complexity of 45 (exceeds 5 allowed). Consider refactoring.
    Open

    RouteController.prototype.addRoute = function (pathRequest, nameModel, reqExcluded, param, route,
    pathCallback) {
    
      // Object that will contains all private function
      var httpMethods = {};
    Severity: Minor
    Found in src/index.js - About 6 hrs to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    File index.js has 449 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    'use strict';
    
    var joi         = require('joi');
    var _           = require('lodash');
    var logger      = require('yocto-logger');
    Severity: Minor
    Found in src/index.js - About 6 hrs to fix

      Function delete has 53 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

        httpMethods.delete = function (model, path) {
      
          // create route in express instance
          this.app.delete(path, function (req, res, next) {
      
      
      Severity: Major
      Found in src/index.js - About 2 hrs to fix

        Function put has 51 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

          httpMethods.put = function (model, path, param) {
        
            // create route in express instance
            this.app.put(path, function (req, res, next) {
        
        
        Severity: Major
        Found in src/index.js - About 2 hrs to fix

          Function patch has 51 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            httpMethods.patch = function (model, path, param) {
          
              // create route in express instance
              this.app.patch(path, function (req, res, next) {
          
          
          Severity: Major
          Found in src/index.js - About 2 hrs to fix

            Function has a complexity of 8.
            Open

            RouteController.prototype.init = function (core, pathRoutes, yoctoMongoose, pathCallback,
            Severity: Minor
            Found in src/index.js by eslint

            Limit Cyclomatic Complexity (complexity)

            Cyclomatic complexity measures the number of linearly independent paths through a program's source code. This rule allows setting a cyclomatic complexity threshold.

            function a(x) {
                if (true) {
                    return x; // 1st path
                } else if (false) {
                    return x+1; // 2nd path
                } else {
                    return 4; // 3rd path
                }
            }

            Rule Details

            This rule is aimed at reducing code complexity by capping the amount of cyclomatic complexity allowed in a program. As such, it will warn when the cyclomatic complexity crosses the configured threshold (default is 20).

            Examples of incorrect code for a maximum of 2:

            /*eslint complexity: ["error", 2]*/
            
            function a(x) {
                if (true) {
                    return x;
                } else if (false) {
                    return x+1;
                } else {
                    return 4; // 3rd path
                }
            }

            Examples of correct code for a maximum of 2:

            /*eslint complexity: ["error", 2]*/
            
            function a(x) {
                if (true) {
                    return x;
                } else {
                    return 4;
                }
            }

            Options

            Optionally, you may specify a max object property:

            "complexity": ["error", 2]

            is equivalent to

            "complexity": ["error", { "max": 2 }]

            Deprecated: the object property maximum is deprecated. Please use the property max instead.

            When Not To Use It

            If you can't determine an appropriate complexity limit for your code, then it's best to disable this rule.

            Further Reading

            Related Rules

            • [max-depth](max-depth.md)
            • [max-len](max-len.md)
            • [max-nested-callbacks](max-nested-callbacks.md)
            • [max-params](max-params.md)
            • [max-statements](max-statements.md) Source: http://eslint.org/docs/rules/

            Function init has 41 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            RouteController.prototype.init = function (core, pathRoutes, yoctoMongoose, pathCallback,
            pathEndPoints) {
            
              this.logger.debug('[ ControllerRoutes.init ] - initialising api start');
            
            
            Severity: Minor
            Found in src/index.js - About 1 hr to fix

              Function get has 28 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

                httpMethods.get = function (model, path, param) {
              
                  // create route in express instance
                  this.app.get(path, function (req, res, next) {
              
              
              Severity: Minor
              Found in src/index.js - About 1 hr to fix

                Function addRoute has 6 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                RouteController.prototype.addRoute = function (pathRequest, nameModel, reqExcluded, param, route,
                pathCallback) {
                Severity: Minor
                Found in src/index.js - About 45 mins to fix

                  Consider simplifying this complex logical expression.
                  Open

                    if (!_.isString(pathRoutes) || !_.isString(pathCallback) ||
                    _.isEmpty(pathRoutes) || _.isEmpty(pathCallback) ||
                    _.isEmpty(pathEndPoints) || _.isEmpty(pathEndPoints)) {
                      return false;
                    }
                  Severity: Major
                  Found in src/index.js - About 40 mins to fix

                    Function init has 5 arguments (exceeds 4 allowed). Consider refactoring.
                    Open

                    RouteController.prototype.init = function (core, pathRoutes, yoctoMongoose, pathCallback,
                    pathEndPoints) {
                    Severity: Minor
                    Found in src/index.js - About 35 mins to fix

                      Unexpected trailing comma.
                      Open

                              },
                      Severity: Minor
                      Found in src/index.js by eslint

                      require or disallow trailing commas (comma-dangle)

                      Trailing commas in object literals are valid according to the ECMAScript 5 (and ECMAScript 3!) spec. However, IE8 (when not in IE8 document mode) and below will throw an error when it encounters trailing commas in JavaScript.

                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };

                      Trailing commas simplify adding and removing items to objects and arrays, since only the lines you are modifying must be touched. Another argument in favor of trailing commas is that it improves the clarity of diffs when an item is added or removed from an object or array:

                      Less clear:

                      var foo = {
                      -    bar: "baz",
                      -    qux: "quux"
                      +    bar: "baz"
                       };

                      More clear:

                      var foo = {
                           bar: "baz",
                      -    qux: "quux",
                       };

                      Rule Details

                      This rule enforces consistent use of trailing commas in object and array literals.

                      Options

                      This rule has a string option or an object option:

                      {
                          "comma-dangle": ["error", "never"],
                          // or
                          "comma-dangle": ["error", {
                              "arrays": "never",
                              "objects": "never",
                              "imports": "never",
                              "exports": "never",
                              "functions": "ignore",
                          }]
                      }
                      • "never" (default) disallows trailing commas
                      • "always" requires trailing commas
                      • "always-multiline" requires trailing commas when the last element or property is in a different line than the closing ] or } and disallows trailing commas when the last element or property is on the same line as the closing ] or }
                      • "only-multiline" allows (but does not require) trailing commas when the last element or property is in a different line than the closing ] or } and disallows trailing commas when the last element or property is on the same line as the closing ] or }

                      Trailing commas in function declarations and function calls are valid syntax since ECMAScript 2017; however, the string option does not check these situations for backwards compatibility.

                      You can also use an object option to configure this rule for each type of syntax. Each of the following options can be set to "never", "always", "always-multiline", "only-multiline", or "ignore". The default for each option is "never" unless otherwise specified.

                      • arrays is for array literals and array patterns of destructuring. (e.g. let [a,] = [1,];)
                      • objects is for object literals and object patterns of destructuring. (e.g. let {a,} = {a: 1};)
                      • imports is for import declarations of ES Modules. (e.g. import {a,} from "foo";)
                      • exports is for export declarations of ES Modules. (e.g. export {a,};)
                      • functions is for function declarations and function calls. (e.g. (function(a,){ })(b,);)
                        functions is set to "ignore" by default for consistency with the string option.

                      never

                      Examples of incorrect code for this rule with the default "never" option:

                      /*eslint comma-dangle: ["error", "never"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };
                      
                      var arr = [1,2,];
                      
                      foo({
                        bar: "baz",
                        qux: "quux",
                      });

                      Examples of correct code for this rule with the default "never" option:

                      /*eslint comma-dangle: ["error", "never"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux"
                      };
                      
                      var arr = [1,2];
                      
                      foo({
                        bar: "baz",
                        qux: "quux"
                      });

                      always

                      Examples of incorrect code for this rule with the "always" option:

                      /*eslint comma-dangle: ["error", "always"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux"
                      };
                      
                      var arr = [1,2];
                      
                      foo({
                        bar: "baz",
                        qux: "quux"
                      });

                      Examples of correct code for this rule with the "always" option:

                      /*eslint comma-dangle: ["error", "always"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };
                      
                      var arr = [1,2,];
                      
                      foo({
                        bar: "baz",
                        qux: "quux",
                      });

                      always-multiline

                      Examples of incorrect code for this rule with the "always-multiline" option:

                      /*eslint comma-dangle: ["error", "always-multiline"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux"
                      };
                      
                      var foo = { bar: "baz", qux: "quux", };
                      
                      var arr = [1,2,];
                      
                      var arr = [1,
                          2,];
                      
                      var arr = [
                          1,
                          2
                      ];
                      
                      foo({
                        bar: "baz",
                        qux: "quux"
                      });

                      Examples of correct code for this rule with the "always-multiline" option:

                      /*eslint comma-dangle: ["error", "always-multiline"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };
                      
                      var foo = {bar: "baz", qux: "quux"};
                      var arr = [1,2];
                      
                      var arr = [1,
                          2];
                      
                      var arr = [
                          1,
                          2,
                      ];
                      
                      foo({
                        bar: "baz",
                        qux: "quux",
                      });

                      only-multiline

                      Examples of incorrect code for this rule with the "only-multiline" option:

                      /*eslint comma-dangle: ["error", "only-multiline"]*/
                      
                      var foo = { bar: "baz", qux: "quux", };
                      
                      var arr = [1,2,];
                      
                      var arr = [1,
                          2,];

                      Examples of correct code for this rule with the "only-multiline" option:

                      /*eslint comma-dangle: ["error", "only-multiline"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux"
                      };
                      
                      var foo = {bar: "baz", qux: "quux"};
                      var arr = [1,2];
                      
                      var arr = [1,
                          2];
                      
                      var arr = [
                          1,
                          2,
                      ];
                      
                      var arr = [
                          1,
                          2
                      ];
                      
                      foo({
                        bar: "baz",
                        qux: "quux",
                      });
                      
                      foo({
                        bar: "baz",
                        qux: "quux"
                      });

                      functions

                      Examples of incorrect code for this rule with the {"functions": "never"} option:

                      /*eslint comma-dangle: ["error", {"functions": "never"}]*/
                      
                      function foo(a, b,) {
                      }
                      
                      foo(a, b,);
                      new foo(a, b,);

                      Examples of correct code for this rule with the {"functions": "never"} option:

                      /*eslint comma-dangle: ["error", {"functions": "never"}]*/
                      
                      function foo(a, b) {
                      }
                      
                      foo(a, b);
                      new foo(a, b);

                      Examples of incorrect code for this rule with the {"functions": "always"} option:

                      /*eslint comma-dangle: ["error", {"functions": "always"}]*/
                      
                      function foo(a, b) {
                      }
                      
                      foo(a, b);
                      new foo(a, b);

                      Examples of correct code for this rule with the {"functions": "always"} option:

                      /*eslint comma-dangle: ["error", {"functions": "always"}]*/
                      
                      function foo(a, b,) {
                      }
                      
                      foo(a, b,);
                      new foo(a, b,);

                      When Not To Use It

                      You can turn this rule off if you are not concerned with dangling commas. Source: http://eslint.org/docs/rules/

                      Unexpected trailing comma.
                      Open

                                },
                      Severity: Minor
                      Found in src/index.js by eslint

                      require or disallow trailing commas (comma-dangle)

                      Trailing commas in object literals are valid according to the ECMAScript 5 (and ECMAScript 3!) spec. However, IE8 (when not in IE8 document mode) and below will throw an error when it encounters trailing commas in JavaScript.

                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };

                      Trailing commas simplify adding and removing items to objects and arrays, since only the lines you are modifying must be touched. Another argument in favor of trailing commas is that it improves the clarity of diffs when an item is added or removed from an object or array:

                      Less clear:

                      var foo = {
                      -    bar: "baz",
                      -    qux: "quux"
                      +    bar: "baz"
                       };

                      More clear:

                      var foo = {
                           bar: "baz",
                      -    qux: "quux",
                       };

                      Rule Details

                      This rule enforces consistent use of trailing commas in object and array literals.

                      Options

                      This rule has a string option or an object option:

                      {
                          "comma-dangle": ["error", "never"],
                          // or
                          "comma-dangle": ["error", {
                              "arrays": "never",
                              "objects": "never",
                              "imports": "never",
                              "exports": "never",
                              "functions": "ignore",
                          }]
                      }
                      • "never" (default) disallows trailing commas
                      • "always" requires trailing commas
                      • "always-multiline" requires trailing commas when the last element or property is in a different line than the closing ] or } and disallows trailing commas when the last element or property is on the same line as the closing ] or }
                      • "only-multiline" allows (but does not require) trailing commas when the last element or property is in a different line than the closing ] or } and disallows trailing commas when the last element or property is on the same line as the closing ] or }

                      Trailing commas in function declarations and function calls are valid syntax since ECMAScript 2017; however, the string option does not check these situations for backwards compatibility.

                      You can also use an object option to configure this rule for each type of syntax. Each of the following options can be set to "never", "always", "always-multiline", "only-multiline", or "ignore". The default for each option is "never" unless otherwise specified.

                      • arrays is for array literals and array patterns of destructuring. (e.g. let [a,] = [1,];)
                      • objects is for object literals and object patterns of destructuring. (e.g. let {a,} = {a: 1};)
                      • imports is for import declarations of ES Modules. (e.g. import {a,} from "foo";)
                      • exports is for export declarations of ES Modules. (e.g. export {a,};)
                      • functions is for function declarations and function calls. (e.g. (function(a,){ })(b,);)
                        functions is set to "ignore" by default for consistency with the string option.

                      never

                      Examples of incorrect code for this rule with the default "never" option:

                      /*eslint comma-dangle: ["error", "never"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };
                      
                      var arr = [1,2,];
                      
                      foo({
                        bar: "baz",
                        qux: "quux",
                      });

                      Examples of correct code for this rule with the default "never" option:

                      /*eslint comma-dangle: ["error", "never"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux"
                      };
                      
                      var arr = [1,2];
                      
                      foo({
                        bar: "baz",
                        qux: "quux"
                      });

                      always

                      Examples of incorrect code for this rule with the "always" option:

                      /*eslint comma-dangle: ["error", "always"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux"
                      };
                      
                      var arr = [1,2];
                      
                      foo({
                        bar: "baz",
                        qux: "quux"
                      });

                      Examples of correct code for this rule with the "always" option:

                      /*eslint comma-dangle: ["error", "always"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };
                      
                      var arr = [1,2,];
                      
                      foo({
                        bar: "baz",
                        qux: "quux",
                      });

                      always-multiline

                      Examples of incorrect code for this rule with the "always-multiline" option:

                      /*eslint comma-dangle: ["error", "always-multiline"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux"
                      };
                      
                      var foo = { bar: "baz", qux: "quux", };
                      
                      var arr = [1,2,];
                      
                      var arr = [1,
                          2,];
                      
                      var arr = [
                          1,
                          2
                      ];
                      
                      foo({
                        bar: "baz",
                        qux: "quux"
                      });

                      Examples of correct code for this rule with the "always-multiline" option:

                      /*eslint comma-dangle: ["error", "always-multiline"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };
                      
                      var foo = {bar: "baz", qux: "quux"};
                      var arr = [1,2];
                      
                      var arr = [1,
                          2];
                      
                      var arr = [
                          1,
                          2,
                      ];
                      
                      foo({
                        bar: "baz",
                        qux: "quux",
                      });

                      only-multiline

                      Examples of incorrect code for this rule with the "only-multiline" option:

                      /*eslint comma-dangle: ["error", "only-multiline"]*/
                      
                      var foo = { bar: "baz", qux: "quux", };
                      
                      var arr = [1,2,];
                      
                      var arr = [1,
                          2,];

                      Examples of correct code for this rule with the "only-multiline" option:

                      /*eslint comma-dangle: ["error", "only-multiline"]*/
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux",
                      };
                      
                      var foo = {
                          bar: "baz",
                          qux: "quux"
                      };
                      
                      var foo = {bar: "baz", qux: "quux"};
                      var arr = [1,2];
                      
                      var arr = [1,
                          2];
                      
                      var arr = [
                          1,
                          2,
                      ];
                      
                      var arr = [
                          1,
                          2
                      ];
                      
                      foo({
                        bar: "baz",
                        qux: "quux",
                      });
                      
                      foo({
                        bar: "baz",
                        qux: "quux"
                      });

                      functions

                      Examples of incorrect code for this rule with the {"functions": "never"} option:

                      /*eslint comma-dangle: ["error", {"functions": "never"}]*/
                      
                      function foo(a, b,) {
                      }
                      
                      foo(a, b,);
                      new foo(a, b,);

                      Examples of correct code for this rule with the {"functions": "never"} option:

                      /*eslint comma-dangle: ["error", {"functions": "never"}]*/
                      
                      function foo(a, b) {
                      }
                      
                      foo(a, b);
                      new foo(a, b);

                      Examples of incorrect code for this rule with the {"functions": "always"} option:

                      /*eslint comma-dangle: ["error", {"functions": "always"}]*/
                      
                      function foo(a, b) {
                      }
                      
                      foo(a, b);
                      new foo(a, b);

                      Examples of correct code for this rule with the {"functions": "always"} option:

                      /*eslint comma-dangle: ["error", {"functions": "always"}]*/
                      
                      function foo(a, b,) {
                      }
                      
                      foo(a, b,);
                      new foo(a, b,);

                      When Not To Use It

                      You can turn this rule off if you are not concerned with dangling commas. Source: http://eslint.org/docs/rules/

                      Unexpected string concatenation of literals.
                      Open

                            'because id wasn\'t' + 'specified, or the field deleted_date doesn\'t exist in schema');
                      Severity: Minor
                      Found in src/index.js by eslint

                      Disallow unnecessary concatenation of strings (no-useless-concat)

                      It's unnecessary to concatenate two strings together, such as:

                      var foo = "a" + "b";

                      This code is likely the result of refactoring where a variable was removed from the concatenation (such as "a" + b + "b"). In such a case, the concatenation isn't important and the code can be rewritten as:

                      var foo = "ab";

                      Rule Details

                      This rule aims to flag the concatenation of 2 literals when they could be combined into a single literal. Literals can be strings or template literals.

                      Examples of incorrect code for this rule:

                      /*eslint no-useless-concat: "error"*/
                      /*eslint-env es6*/
                      
                      // these are the same as "10"
                      var a = `some` + `string`;
                      var a = '1' + '0';
                      var a = '1' + `0`;
                      var a = `1` + '0';
                      var a = `1` + `0`;

                      Examples of correct code for this rule:

                      /*eslint no-useless-concat: "error"*/
                      
                      // when a non string is included
                      var c = a + b;
                      var c = '1' + a;
                      var a = 1 + '1';
                      var c = 1 - 2;
                      // when the string concatenation is multiline
                      var c = "foo" +
                          "bar";

                      When Not To Use It

                      If you don't want to be notified about unnecessary string concatenation, you can safely disable this rule. Source: http://eslint.org/docs/rules/

                      Unexpected require().
                      Open

                          this.endPoints = require(pathEndPoints);
                      Severity: Minor
                      Found in src/index.js by eslint

                      Enforce require() on the top-level module scope (global-require)

                      In Node.js, module dependencies are included using the require() function, such as:

                      var fs = require("fs");

                      While require() may be called anywhere in code, some style guides prescribe that it should be called only in the top level of a module to make it easier to identify dependencies. For instance, it's arguably harder to identify dependencies when they are deeply nested inside of functions and other statements:

                      function foo() {
                      
                          if (condition) {
                              var fs = require("fs");
                          }
                      }

                      Since require() does a synchronous load, it can cause performance problems when used in other locations.

                      Further, ES6 modules mandate that import and export statements can only occur in the top level of the module's body.

                      Rule Details

                      This rule requires all calls to require() to be at the top level of the module, similar to ES6 import and export statements, which also can occur only at the top level.

                      Examples of incorrect code for this rule:

                      /*eslint global-require: "error"*/
                      /*eslint-env es6*/
                      
                      // calling require() inside of a function is not allowed
                      function readFile(filename, callback) {
                          var fs = require('fs');
                          fs.readFile(filename, callback)
                      }
                      
                      // conditional requires like this are also not allowed
                      if (DEBUG) { require('debug'); }
                      
                      // a require() in a switch statement is also flagged
                      switch(x) { case '1': require('1'); break; }
                      
                      // you may not require() inside an arrow function body
                      var getModule = (name) => require(name);
                      
                      // you may not require() inside of a function body as well
                      function getModule(name) { return require(name); }
                      
                      // you may not require() inside of a try/catch block
                      try {
                          require(unsafeModule);
                      } catch(e) {
                          console.log(e);
                      }

                      Examples of correct code for this rule:

                      /*eslint global-require: "error"*/
                      
                      // all these variations of require() are ok
                      require('x');
                      var y = require('y');
                      var z;
                      z = require('z').initialize();
                      
                      // requiring a module and using it in a function is ok
                      var fs = require('fs');
                      function readFile(filename, callback) {
                          fs.readFile(filename, callback)
                      }
                      
                      // you can use a ternary to determine which module to require
                      var logger = DEBUG ? require('dev-logger') : require('logger');
                      
                      // if you want you can require() at the end of your module
                      function doSomethingA() {}
                      function doSomethingB() {}
                      var x = require("x"),
                          z = require("z");

                      When Not To Use It

                      If you have a module that must be initialized with information that comes from the file-system or if a module is only used in very rare situations and will cause significant overhead to load it may make sense to disable the rule. If you need to require() an optional dependency inside of a try/catch, you can disable this rule for just that dependency using the // eslint-disable-line global-require comment. Source: http://eslint.org/docs/rules/

                      Unexpected require().
                      Open

                              var callbackFile = require(path.normalize(pathCallback + nameModel.toLowerCase() + '.js'));
                      Severity: Minor
                      Found in src/index.js by eslint

                      Enforce require() on the top-level module scope (global-require)

                      In Node.js, module dependencies are included using the require() function, such as:

                      var fs = require("fs");

                      While require() may be called anywhere in code, some style guides prescribe that it should be called only in the top level of a module to make it easier to identify dependencies. For instance, it's arguably harder to identify dependencies when they are deeply nested inside of functions and other statements:

                      function foo() {
                      
                          if (condition) {
                              var fs = require("fs");
                          }
                      }

                      Since require() does a synchronous load, it can cause performance problems when used in other locations.

                      Further, ES6 modules mandate that import and export statements can only occur in the top level of the module's body.

                      Rule Details

                      This rule requires all calls to require() to be at the top level of the module, similar to ES6 import and export statements, which also can occur only at the top level.

                      Examples of incorrect code for this rule:

                      /*eslint global-require: "error"*/
                      /*eslint-env es6*/
                      
                      // calling require() inside of a function is not allowed
                      function readFile(filename, callback) {
                          var fs = require('fs');
                          fs.readFile(filename, callback)
                      }
                      
                      // conditional requires like this are also not allowed
                      if (DEBUG) { require('debug'); }
                      
                      // a require() in a switch statement is also flagged
                      switch(x) { case '1': require('1'); break; }
                      
                      // you may not require() inside an arrow function body
                      var getModule = (name) => require(name);
                      
                      // you may not require() inside of a function body as well
                      function getModule(name) { return require(name); }
                      
                      // you may not require() inside of a try/catch block
                      try {
                          require(unsafeModule);
                      } catch(e) {
                          console.log(e);
                      }

                      Examples of correct code for this rule:

                      /*eslint global-require: "error"*/
                      
                      // all these variations of require() are ok
                      require('x');
                      var y = require('y');
                      var z;
                      z = require('z').initialize();
                      
                      // requiring a module and using it in a function is ok
                      var fs = require('fs');
                      function readFile(filename, callback) {
                          fs.readFile(filename, callback)
                      }
                      
                      // you can use a ternary to determine which module to require
                      var logger = DEBUG ? require('dev-logger') : require('logger');
                      
                      // if you want you can require() at the end of your module
                      function doSomethingA() {}
                      function doSomethingB() {}
                      var x = require("x"),
                          z = require("z");

                      When Not To Use It

                      If you have a module that must be initialized with information that comes from the file-system or if a module is only used in very rare situations and will cause significant overhead to load it may make sense to disable the rule. If you need to require() an optional dependency inside of a try/catch, you can disable this rule for just that dependency using the // eslint-disable-line global-require comment. Source: http://eslint.org/docs/rules/

                      Irregular whitespace not allowed.
                      Open

                        this.logger = yLogger || logger;
                      Severity: Minor
                      Found in src/index.js by eslint

                      disallow irregular whitespace (no-irregular-whitespace)

                      Invalid or irregular whitespace causes issues with ECMAScript 5 parsers and also makes code harder to debug in a similar nature to mixed tabs and spaces.

                      Various whitespace characters can be inputted by programmers by mistake for example from copying or keyboard shortcuts. Pressing Alt + Space on OS X adds in a non breaking space character for example.

                      Known issues these spaces cause:

                      • Zero Width Space
                        • Is NOT considered a separator for tokens and is often parsed as an Unexpected token ILLEGAL
                        • Is NOT shown in modern browsers making code repository software expected to resolve the visualisation
                      • Line Separator
                        • Is NOT a valid character within JSON which would cause parse errors

                      Rule Details

                      This rule is aimed at catching invalid whitespace that is not a normal tab and space. Some of these characters may cause issues in modern browsers and others will be a debugging issue to spot.

                      This rule disallows the following characters except where the options allow:

                      \u000B - Line Tabulation (\v) - <vt>
                      \u000C - Form Feed (\f) - <ff>
                      \u00A0 - No-Break Space - <nbsp>
                      \u0085 - Next Line
                      \u1680 - Ogham Space Mark
                      \u180E - Mongolian Vowel Separator - <mvs>
                      \ufeff - Zero Width No-Break Space - <bom>
                      \u2000 - En Quad
                      \u2001 - Em Quad
                      \u2002 - En Space - <ensp>
                      \u2003 - Em Space - <emsp>
                      \u2004 - Tree-Per-Em
                      \u2005 - Four-Per-Em
                      \u2006 - Six-Per-Em
                      \u2007 - Figure Space
                      \u2008 - Punctuation Space - <puncsp>
                      \u2009 - Thin Space
                      \u200A - Hair Space
                      \u200B - Zero Width Space - <zwsp>
                      \u2028 - Line Separator
                      \u2029 - Paragraph Separator
                      \u202F - Narrow No-Break Space
                      \u205f - Medium Mathematical Space
                      \u3000 - Ideographic Space</zwsp></puncsp></emsp></ensp></bom></mvs></nbsp></ff></vt>

                      Options

                      This rule has an object option for exceptions:

                      • "skipStrings": true (default) allows any whitespace characters in string literals
                      • "skipComments": true allows any whitespace characters in comments
                      • "skipRegExps": true allows any whitespace characters in regular expression literals
                      • "skipTemplates": true allows any whitespace characters in template literals

                      skipStrings

                      Examples of incorrect code for this rule with the default { "skipStrings": true } option:

                      /*eslint no-irregular-whitespace: "error"*/
                      
                      function thing() /*<nbsp>*/{
                          return 'test';
                      }
                      
                      function thing( /*<nbsp>*/){
                          return 'test';
                      }
                      
                      function thing /*<nbsp>*/(){
                          return 'test';
                      }
                      
                      function thing᠎/*<mvs>*/(){
                          return 'test';
                      }
                      
                      function thing() {
                          return 'test'; /*<ensp>*/
                      }
                      
                      function thing() {
                          return 'test'; /*<nbsp>*/
                      }
                      
                      function thing() {
                          // Description <nbsp>: some descriptive text
                      }
                      
                      /*
                      Description <nbsp>: some descriptive text
                      */
                      
                      function thing() {
                          return / <nbsp>regexp/;
                      }
                      
                      /*eslint-env es6*/
                      function thing() {
                          return `template <nbsp>string`;
                      }</nbsp></nbsp></nbsp></nbsp></nbsp></ensp></mvs></nbsp></nbsp></nbsp>

                      Examples of correct code for this rule with the default { "skipStrings": true } option:

                      /*eslint no-irregular-whitespace: "error"*/
                      
                      function thing() {
                          return ' <nbsp>thing';
                      }
                      
                      function thing() {
                          return '​<zwsp>thing';
                      }
                      
                      function thing() {
                          return 'th <nbsp>ing';
                      }</nbsp></zwsp></nbsp>

                      skipComments

                      Examples of additional correct code for this rule with the { "skipComments": true } option:

                      /*eslint no-irregular-whitespace: ["error", { "skipComments": true }]*/
                      
                      function thing() {
                          // Description <nbsp>: some descriptive text
                      }
                      
                      /*
                      Description <nbsp>: some descriptive text
                      */</nbsp></nbsp>

                      skipRegExps

                      Examples of additional correct code for this rule with the { "skipRegExps": true } option:

                      /*eslint no-irregular-whitespace: ["error", { "skipRegExps": true }]*/
                      
                      function thing() {
                          return / <nbsp>regexp/;
                      }</nbsp>

                      skipTemplates

                      Examples of additional correct code for this rule with the { "skipTemplates": true } option:

                      /*eslint no-irregular-whitespace: ["error", { "skipTemplates": true }]*/
                      /*eslint-env es6*/
                      
                      function thing() {
                          return `template <nbsp>string`;
                      }</nbsp>

                      When Not To Use It

                      If you decide that you wish to use whitespace other than tabs and spaces outside of strings in your application.

                      Further Reading

                      Similar blocks of code found in 2 locations. Consider refactoring.
                      Open

                        httpMethods.put = function (model, path, param) {
                      
                          // create route in express instance
                          this.app.put(path, function (req, res, next) {
                      
                      
                      Severity: Major
                      Found in src/index.js and 1 other location - About 3 days to fix
                      src/index.js on lines 368..443

                      Duplicated Code

                      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                      Tuning

                      This issue has a mass of 544.

                      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                      Refactorings

                      Further Reading

                      Similar blocks of code found in 2 locations. Consider refactoring.
                      Open

                        httpMethods.patch = function (model, path, param) {
                      
                          // create route in express instance
                          this.app.patch(path, function (req, res, next) {
                      
                      
                      Severity: Major
                      Found in src/index.js and 1 other location - About 3 days to fix
                      src/index.js on lines 446..521

                      Duplicated Code

                      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                      Tuning

                      This issue has a mass of 544.

                      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                      Refactorings

                      Further Reading

                      Similar blocks of code found in 3 locations. Consider refactoring.
                      Open

                              sms           : joi.object().optional().keys({
                                references  : joi.array().optional().items(
                                  joi.string().empty()
                                ).default([]),
                                enable      : joi.boolean().optional().default(false)
                      Severity: Major
                      Found in src/index.js and 2 other locations - About 5 hrs to fix
                      src/index.js on lines 43..57
                      src/index.js on lines 58..72

                      Duplicated Code

                      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                      Tuning

                      This issue has a mass of 148.

                      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                      Refactorings

                      Further Reading

                      Similar blocks of code found in 3 locations. Consider refactoring.
                      Open

                              notification  : joi.object().optional().keys({
                                references  : joi.array().optional().items(
                                  joi.string().empty()
                                ).default([]),
                                enable      : joi.boolean().optional().default(false)
                      Severity: Major
                      Found in src/index.js and 2 other locations - About 5 hrs to fix
                      src/index.js on lines 28..42
                      src/index.js on lines 43..57

                      Duplicated Code

                      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                      Tuning

                      This issue has a mass of 148.

                      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                      Refactorings

                      Further Reading

                      Similar blocks of code found in 3 locations. Consider refactoring.
                      Open

                              mail          : joi.object().optional().keys({
                                references  : joi.array().optional().items(
                                  joi.string().empty()
                                ).default([]),
                                enable      : joi.boolean().optional().default(false)
                      Severity: Major
                      Found in src/index.js and 2 other locations - About 5 hrs to fix
                      src/index.js on lines 28..42
                      src/index.js on lines 58..72

                      Duplicated Code

                      Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

                      Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

                      When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

                      Tuning

                      This issue has a mass of 148.

                      We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

                      The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

                      If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

                      See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

                      Refactorings

                      Further Reading

                      There are no issues that match your filters.

                      Category
                      Status