marionebl/jogwheel

View on GitHub
tasks/partials/page-layout.js

Summary

Maintainability
A
1 hr
Test Coverage

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

module.exports = function (props) {
    return `<!doctype html>
<html lang="en" prefix="og: http://ogp.me/ns#">
    <head>
        <title>${props.pkg.name} - ${props.pkg.description}</title>
Severity: Minor
Found in tasks/partials/page-layout.js - About 1 hr to fix

    Unexpected var, use let or const instead.
    Open

                            var className = item.active ? 'jogwheel-item jogwheel-item--active' : 'jogwheel-item';
    Severity: Minor
    Found in tasks/partials/page-layout.js by eslint

    require let or const instead of var (no-var)

    ECMAScript 6 allows programmers to create variables with block scope instead of function scope using the let and const keywords. Block scope is common in many other programming languages and helps programmers avoid mistakes such as:

    var count = people.length;
    var enoughFood = count > sandwiches.length;
    
    if (enoughFood) {
        var count = sandwiches.length; // accidentally overriding the count variable
        console.log("We have " + count + " sandwiches for everyone. Plenty for all!");
    }
    
    // our count variable is no longer accurate
    console.log("We have " + count + " people and " + sandwiches.length + " sandwiches!");

    Rule Details

    This rule is aimed at discouraging the use of var and encouraging the use of const or let instead.

    Examples

    Examples of incorrect code for this rule:

    /*eslint no-var: "error"*/
    
    var x = "y";
    var CONFIG = {};

    Examples of correct code for this rule:

    /*eslint no-var: "error"*/
    /*eslint-env es6*/
    
    let x = "y";
    const CONFIG = {};

    When Not To Use It

    In addition to non-ES6 environments, existing JavaScript projects that are beginning to introduce ES6 into their codebase may not want to apply this rule if the cost of migrating from var to let is too costly. Source: http://eslint.org/docs/rules/

    Missing space before function parentheses.
    Open

                        ${props.navigation.map(function(item) {
    Severity: Minor
    Found in tasks/partials/page-layout.js by eslint

    Require or disallow a space before function parenthesis (space-before-function-paren)

    When formatting a function, whitespace is allowed between the function name or function keyword and the opening paren. Named functions also require a space between the function keyword and the function name, but anonymous functions require no whitespace. For example:

    function withoutSpace(x) {
        // ...
    }
    
    function withSpace (x) {
        // ...
    }
    
    var anonymousWithoutSpace = function() {};
    
    var anonymousWithSpace = function () {};

    Style guides may require a space after the function keyword for anonymous functions, while others specify no whitespace. Similarly, the space after a function name may or may not be required.

    Rule Details

    This rule aims to enforce consistent spacing before function parentheses and as such, will warn whenever whitespace doesn't match the preferences specified.

    Options

    This rule has a string option or an object option:

    {
        "space-before-function-paren": ["error", "always"],
        // or
        "space-before-function-paren": ["error", {
            "anonymous": "always",
            "named": "always",
            "asyncArrow": "ignore"
        }],
    }
    • always (default) requires a space followed by the ( of arguments.
    • never disallows any space followed by the ( of arguments.

    The string option does not check async arrow function expressions for backward compatibility.

    You can also use a separate option for each type of function. Each of the following options can be set to "always", "never", or "ignore". Default is "always" basically.

    • anonymous is for anonymous function expressions (e.g. function () {}).
    • named is for named function expressions (e.g. function foo () {}).
    • asyncArrow is for async arrow function expressions (e.g. async () => {}). asyncArrow is set to "ignore" by default for backwards compatibility.

    "always"

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

    /*eslint space-before-function-paren: "error"*/
    /*eslint-env es6*/
    
    function foo() {
        // ...
    }
    
    var bar = function() {
        // ...
    };
    
    var bar = function foo() {
        // ...
    };
    
    class Foo {
        constructor() {
            // ...
        }
    }
    
    var foo = {
        bar() {
            // ...
        }
    };

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

    /*eslint space-before-function-paren: "error"*/
    /*eslint-env es6*/
    
    function foo () {
        // ...
    }
    
    var bar = function () {
        // ...
    };
    
    var bar = function foo () {
        // ...
    };
    
    class Foo {
        constructor () {
            // ...
        }
    }
    
    var foo = {
        bar () {
            // ...
        }
    };
    
    // async arrow function expressions are ignored by default.
    var foo = async () => 1
    var foo = async() => 1

    "never"

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

    /*eslint space-before-function-paren: ["error", "never"]*/
    /*eslint-env es6*/
    
    function foo () {
        // ...
    }
    
    var bar = function () {
        // ...
    };
    
    var bar = function foo () {
        // ...
    };
    
    class Foo {
        constructor () {
            // ...
        }
    }
    
    var foo = {
        bar () {
            // ...
        }
    };

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

    /*eslint space-before-function-paren: ["error", "never"]*/
    /*eslint-env es6*/
    
    function foo() {
        // ...
    }
    
    var bar = function() {
        // ...
    };
    
    var bar = function foo() {
        // ...
    };
    
    class Foo {
        constructor() {
            // ...
        }
    }
    
    var foo = {
        bar() {
            // ...
        }
    };
    
    // async arrow function expressions are ignored by default.
    var foo = async () => 1
    var foo = async() => 1

    {"anonymous": "always", "named": "never", "asyncArrow": "always"}

    Examples of incorrect code for this rule with the {"anonymous": "always", "named": "never", "asyncArrow": "always"} option:

    /*eslint space-before-function-paren: ["error", {"anonymous": "always", "named": "never", "asyncArrow": "always"}]*/
    /*eslint-env es6*/
    
    function foo () {
        // ...
    }
    
    var bar = function() {
        // ...
    };
    
    class Foo {
        constructor () {
            // ...
        }
    }
    
    var foo = {
        bar () {
            // ...
        }
    };
    
    var foo = async(a) => await a

    Examples of correct code for this rule with the {"anonymous": "always", "named": "never", "asyncArrow": "always"} option:

    /*eslint space-before-function-paren: ["error", {"anonymous": "always", "named": "never", "asyncArrow": "always"}]*/
    /*eslint-env es6*/
    
    function foo() {
        // ...
    }
    
    var bar = function () {
        // ...
    };
    
    class Foo {
        constructor() {
            // ...
        }
    }
    
    var foo = {
        bar() {
            // ...
        }
    };
    
    var foo = async (a) => await a

    {"anonymous": "never", "named": "always"}

    Examples of incorrect code for this rule with the {"anonymous": "never", "named": "always"} option:

    /*eslint space-before-function-paren: ["error", { "anonymous": "never", "named": "always" }]*/
    /*eslint-env es6*/
    
    function foo() {
        // ...
    }
    
    var bar = function () {
        // ...
    };
    
    class Foo {
        constructor() {
            // ...
        }
    }
    
    var foo = {
        bar() {
            // ...
        }
    };

    Examples of correct code for this rule with the {"anonymous": "never", "named": "always"} option:

    /*eslint space-before-function-paren: ["error", { "anonymous": "never", "named": "always" }]*/
    /*eslint-env es6*/
    
    function foo () {
        // ...
    }
    
    var bar = function() {
        // ...
    };
    
    class Foo {
        constructor () {
            // ...
        }
    }
    
    var foo = {
        bar () {
            // ...
        }
    };

    {"anonymous": "ignore", "named": "always"}

    Examples of incorrect code for this rule with the {"anonymous": "ignore", "named": "always"} option:

    /*eslint space-before-function-paren: ["error", { "anonymous": "ignore", "named": "always" }]*/
    /*eslint-env es6*/
    
    function foo() {
        // ...
    }
    
    class Foo {
        constructor() {
            // ...
        }
    }
    
    var foo = {
        bar() {
            // ...
        }
    };

    Examples of correct code for this rule with the {"anonymous": "ignore", "named": "always"} option:

    /*eslint space-before-function-paren: ["error", { "anonymous": "ignore", "named": "always" }]*/
    /*eslint-env es6*/
    
    var bar = function() {
        // ...
    };
    
    var bar = function () {
        // ...
    };
    
    function foo () {
        // ...
    }
    
    class Foo {
        constructor () {
            // ...
        }
    }
    
    var foo = {
        bar () {
            // ...
        }
    };

    When Not To Use It

    You can turn this rule off if you are not concerned with the consistency of spacing before function parenthesis.

    Related Rules

    Missing semicolon.
    Open

                            return `<li class="${className}"><a href="${item.href}">${item.name}</a></li>`
    Severity: Minor
    Found in tasks/partials/page-layout.js by eslint

    require or disallow semicolons instead of ASI (semi)

    JavaScript is unique amongst the C-like languages in that it doesn't require semicolons at the end of each statement. In many cases, the JavaScript engine can determine that a semicolon should be in a certain spot and will automatically add it. This feature is known as automatic semicolon insertion (ASI) and is considered one of the more controversial features of JavaScript. For example, the following lines are both valid:

    var name = "ESLint"
    var website = "eslint.org";

    On the first line, the JavaScript engine will automatically insert a semicolon, so this is not considered a syntax error. The JavaScript engine still knows how to interpret the line and knows that the line end indicates the end of the statement.

    In the debate over ASI, there are generally two schools of thought. The first is that we should treat ASI as if it didn't exist and always include semicolons manually. The rationale is that it's easier to always include semicolons than to try to remember when they are or are not required, and thus decreases the possibility of introducing an error.

    However, the ASI mechanism can sometimes be tricky to people who are using semicolons. For example, consider this code:

    return
    {
        name: "ESLint"
    };

    This may look like a return statement that returns an object literal, however, the JavaScript engine will interpret this code as:

    return;
    {
        name: "ESLint";
    }

    Effectively, a semicolon is inserted after the return statement, causing the code below it (a labeled literal inside a block) to be unreachable. This rule and the [no-unreachable](no-unreachable.md) rule will protect your code from such cases.

    On the other side of the argument are those who says that since semicolons are inserted automatically, they are optional and do not need to be inserted manually. However, the ASI mechanism can also be tricky to people who don't use semicolons. For example, consider this code:

    var globalCounter = { }
    
    (function () {
        var n = 0
        globalCounter.increment = function () {
            return ++n
        }
    })()

    In this example, a semicolon will not be inserted after the first line, causing a run-time error (because an empty object is called as if it's a function). The [no-unexpected-multiline](no-unexpected-multiline.md) rule can protect your code from such cases.

    Although ASI allows for more freedom over your coding style, it can also make your code behave in an unexpected way, whether you use semicolons or not. Therefore, it is best to know when ASI takes place and when it does not, and have ESLint protect your code from these potentially unexpected cases. In short, as once described by Isaac Schlueter, a \n character always ends a statement (just like a semicolon) unless one of the following is true:

    1. The statement has an unclosed paren, array literal, or object literal or ends in some other way that is not a valid way to end a statement. (For instance, ending with . or ,.)
    2. The line is -- or ++ (in which case it will decrement/increment the next token.)
    3. It is a for(), while(), do, if(), or else, and there is no {
    4. The next line starts with [, (, +, *, /, -, ,, ., or some other binary operator that can only be found between two tokens in a single expression.

    Rule Details

    This rule enforces consistent use of semicolons.

    Options

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

    String option:

    • "always" (default) requires semicolons at the end of statements
    • "never" disallows semicolons as the end of statements (except to disambiguate statements beginning with [, (, /, +, or -)

    Object option:

    • "omitLastInOneLineBlock": true ignores the last semicolon in a block in which its braces (and therefore the content of the block) are in the same line

    always

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

    /*eslint semi: ["error", "always"]*/
    
    var name = "ESLint"
    
    object.method = function() {
        // ...
    }

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

    /*eslint semi: "error"*/
    
    var name = "ESLint";
    
    object.method = function() {
        // ...
    };

    never

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

    /*eslint semi: ["error", "never"]*/
    
    var name = "ESLint";
    
    object.method = function() {
        // ...
    };

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

    /*eslint semi: ["error", "never"]*/
    
    var name = "ESLint"
    
    object.method = function() {
        // ...
    }
    
    var name = "ESLint"
    
    ;(function() {
        // ...
    })()

    omitLastInOneLineBlock

    Examples of additional correct code for this rule with the "always", { "omitLastInOneLineBlock": true } options:

    /*eslint semi: ["error", "always", { "omitLastInOneLineBlock": true}] */
    
    if (foo) { bar() }
    
    if (foo) { bar(); baz() }

    When Not To Use It

    If you do not want to enforce semicolon usage (or omission) in any particular way, then you can turn this rule off.

    Further Reading

    Related Rules

    • [no-extra-semi](no-extra-semi.md)
    • [no-unexpected-multiline](no-unexpected-multiline.md)
    • [semi-spacing](semi-spacing.md) Source: http://eslint.org/docs/rules/

    Unexpected function expression.
    Open

                        ${props.navigation.map(function(item) {
    Severity: Minor
    Found in tasks/partials/page-layout.js by eslint

    Suggest using arrow functions as callbacks. (prefer-arrow-callback)

    Arrow functions are suited to callbacks, because:

    • this keywords in arrow functions bind to the upper scope's.
    • The notation of the arrow function is shorter than function expression's.

    Rule Details

    This rule is aimed to flag usage of function expressions in an argument list.

    The following patterns are considered problems:

    /*eslint prefer-arrow-callback: "error"*/
    
    foo(function(a) { return a; });
    foo(function() { return this.a; }.bind(this));

    The following patterns are not considered problems:

    /*eslint prefer-arrow-callback: "error"*/
    /*eslint-env es6*/
    
    foo(a => a);
    foo(function*() { yield; });
    
    // this is not a callback.
    var foo = function foo(a) { return a; };
    
    // using `this` without `.bind(this)`.
    foo(function() { return this.a; });
    
    // recursively.
    foo(function bar(n) { return n && n + bar(n - 1); });

    Options

    This rule takes one optional argument, an object which is an options object.

    allowNamedFunctions

    This is a boolean option and it is false by default. When set to true, the rule doesn't warn on named functions used as callbacks.

    Examples of correct code for the { "allowNamedFunctions": true } option:

    /*eslint prefer-arrow-callback: ["error", { "allowNamedFunctions": true }]*/
    
    foo(function bar() {});

    allowUnboundThis

    This is a boolean option and it is true by default. When set to false, this option allows the use of this without restriction and checks for dynamically assigned this values such as when using Array.prototype.map with a context argument. Normally, the rule will flag the use of this whenever a function does not use bind() to specify the value of this constantly.

    Examples of incorrect code for the { "allowUnboundThis": false } option:

    /*eslint prefer-arrow-callback: ["error", { "allowUnboundThis": false }]*/
    /*eslint-env es6*/
    
    foo(function() { this.a; });
    
    foo(function() { (() => this); });
    
    someArray.map(function (itm) { return this.doSomething(itm); }, someObject);

    When Not To Use It

    This rule should not be used in ES3/5 environments.

    In ES2015 (ES6) or later, if you don't want to be notified about function expressions in an argument list, you can safely disable this rule. Source: http://eslint.org/docs/rules/

    There are no issues that match your filters.

    Category
    Status