dracco1993/GitHubUtils

View on GitHub

Showing 3 of 3 total issues

Function getComments has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function getComments(source, repo) {
  var content = source.find(".js-comment-container");
  var prNumber = source
    .find(".gh-header-number")
    .first()
Severity: Minor
Found in githubutils.user.js - About 1 hr to fix

    Function getComments has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    function getComments(source, repo) {
      var content = source.find(".js-comment-container");
      var prNumber = source
        .find(".gh-header-number")
        .first()
    Severity: Minor
    Found in githubutils.user.js - About 45 mins 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

    Move the invocation into the parens that contain the function.
    Open

    (function() {
    Severity: Minor
    Found in githubutils.user.js by eslint

    Require IIFEs to be Wrapped (wrap-iife)

    You can immediately invoke function expressions, but not function declarations. A common technique to create an immediately-invoked function expression (IIFE) is to wrap a function declaration in parentheses. The opening parentheses causes the contained function to be parsed as an expression, rather than a declaration.

    // function expression could be unwrapped
    var x = function () { return { y: 1 };}();
    
    // function declaration must be wrapped
    function () { /* side effects */ }(); // SyntaxError

    Rule Details

    This rule requires all immediately-invoked function expressions to be wrapped in parentheses.

    Options

    This rule has two options, a string option and an object option.

    String option:

    • "outside" enforces always wrapping the call expression. The default is "outside".
    • "inside" enforces always wrapping the function expression.
    • "any" enforces always wrapping, but allows either style.

    Object option:

    • "functionPrototypeMethods": true additionally enforces wrapping function expressions invoked using .call and .apply. The default is false.

    outside

    Examples of incorrect code for the default "outside" option:

    /*eslint wrap-iife: ["error", "outside"]*/
    
    var x = function () { return { y: 1 };}(); // unwrapped
    var x = (function () { return { y: 1 };})(); // wrapped function expression

    Examples of correct code for the default "outside" option:

    /*eslint wrap-iife: ["error", "outside"]*/
    
    var x = (function () { return { y: 1 };}()); // wrapped call expression

    inside

    Examples of incorrect code for the "inside" option:

    /*eslint wrap-iife: ["error", "inside"]*/
    
    var x = function () { return { y: 1 };}(); // unwrapped
    var x = (function () { return { y: 1 };}()); // wrapped call expression

    Examples of correct code for the "inside" option:

    /*eslint wrap-iife: ["error", "inside"]*/
    
    var x = (function () { return { y: 1 };})(); // wrapped function expression

    any

    Examples of incorrect code for the "any" option:

    /*eslint wrap-iife: ["error", "any"]*/
    
    var x = function () { return { y: 1 };}(); // unwrapped

    Examples of correct code for the "any" option:

    /*eslint wrap-iife: ["error", "any"]*/
    
    var x = (function () { return { y: 1 };}()); // wrapped call expression
    var x = (function () { return { y: 1 };})(); // wrapped function expression

    functionPrototypeMethods

    Examples of incorrect code for this rule with the "inside", { "functionPrototypeMethods": true } options:

    /* eslint wrap-iife: [2, "inside", { functionPrototypeMethods: true }] */
    
    var x = function(){ foo(); }()
    var x = (function(){ foo(); }())
    var x = function(){ foo(); }.call(bar)
    var x = (function(){ foo(); }.call(bar))

    Examples of correct code for this rule with the "inside", { "functionPrototypeMethods": true } options:

    /* eslint wrap-iife: [2, "inside", { functionPrototypeMethods: true }] */
    
    var x = (function(){ foo(); })()
    var x = (function(){ foo(); }).call(bar)

    Source: http://eslint.org/docs/rules/

    Severity
    Category
    Status
    Source
    Language