radare/radare2-webui

View on GitHub
www/m/workers/hexchunkProvider.js

Summary

Maintainability
A
2 hrs
Test Coverage

Function getChunk has 39 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function getChunk(howManyBytes, addr, nbCols) {
    if (addr < 0) {
        return {
            offset: 0,
            hex: [],
Severity: Minor
Found in www/m/workers/hexchunkProvider.js - About 1 hr to fix

    Missing JSDoc comment.
    Open

    function hexPairToASCII(pair) {
    Severity: Minor
    Found in www/m/workers/hexchunkProvider.js by eslint

    require JSDoc comments (require-jsdoc)

    JSDoc is a JavaScript API documentation generator. It uses specially-formatted comments inside of code to generate API documentation automatically. For example, this is what a JSDoc comment looks like for a function:

    /**
     * Adds two numbers together.
     * @param {int} num1 The first number.
     * @param {int} num2 The second number.
     * @returns {int} The sum of the two numbers.
     */
    function sum(num1, num2) {
        return num1 + num2;
    }

    Some style guides require JSDoc comments for all functions as a way of explaining function behavior.

    Rule Details

    This rule requires JSDoc comments for specified nodes. Supported nodes:

    • "FunctionDeclaration"
    • "ClassDeclaration"
    • "MethodDefinition"
    • "ArrowFunctionExpression"

    Options

    This rule has a single object option:

    • "require" requires JSDoc comments for the specified nodes

    Default option settings are:

    {
        "require-jsdoc": ["error", {
            "require": {
                "FunctionDeclaration": true,
                "MethodDefinition": false,
                "ClassDeclaration": false,
                "ArrowFunctionExpression": false
            }
        }]
    }

    require

    Examples of incorrect code for this rule with the { "require": { "FunctionDeclaration": true, "MethodDefinition": true, "ClassDeclaration": true, "ArrowFunctionExpression": true } } option:

    /*eslint "require-jsdoc": ["error", {
        "require": {
            "FunctionDeclaration": true,
            "MethodDefinition": true,
            "ClassDeclaration": true
        }
    }]*/
    
    function foo() {
        return 10;
    }
    
    var foo = () => {
        return 10;
    }
    
    class Test{
        getDate(){}
    }

    Examples of correct code for this rule with the { "require": { "FunctionDeclaration": true, "MethodDefinition": true, "ClassDeclaration": true, "ArrowFunctionExpression": true } } option:

    /*eslint "require-jsdoc": ["error", {
        "require": {
            "FunctionDeclaration": true,
            "MethodDefinition": true,
            "ClassDeclaration": true
        }
    }]*/
    
    /**
     * It returns 10
     */
    function foo() {
        return 10;
    }
    
    /**
     * It returns test + 10
     * @params {int} test - some number
     * @returns {int} sum of test and 10
     */
    var foo = (test) => {
        return test + 10;
    }
    
    /**
     * It returns 10
     */
    var foo = () => {
        return 10;
    }
    
    /**
     * It returns 10
     */
    var foo = function() {
        return 10;
    }
    
    var array = [1,2,3];
    array.filter(function(item) {
        return item > 2;
    });
    
    /**
     * It returns 10
     */
    class Test{
        /**
        * returns the date
        */
        getDate(){}
    }
    
    setTimeout(() => {}, 10); // since it's an anonymous arrow function

    When Not To Use It

    If you do not require JSDoc for your functions, then you can leave this rule off.

    Related Rules

    Missing JSDoc comment.
    Open

    function getChunk(howManyBytes, addr, nbCols) {
    Severity: Minor
    Found in www/m/workers/hexchunkProvider.js by eslint

    require JSDoc comments (require-jsdoc)

    JSDoc is a JavaScript API documentation generator. It uses specially-formatted comments inside of code to generate API documentation automatically. For example, this is what a JSDoc comment looks like for a function:

    /**
     * Adds two numbers together.
     * @param {int} num1 The first number.
     * @param {int} num2 The second number.
     * @returns {int} The sum of the two numbers.
     */
    function sum(num1, num2) {
        return num1 + num2;
    }

    Some style guides require JSDoc comments for all functions as a way of explaining function behavior.

    Rule Details

    This rule requires JSDoc comments for specified nodes. Supported nodes:

    • "FunctionDeclaration"
    • "ClassDeclaration"
    • "MethodDefinition"
    • "ArrowFunctionExpression"

    Options

    This rule has a single object option:

    • "require" requires JSDoc comments for the specified nodes

    Default option settings are:

    {
        "require-jsdoc": ["error", {
            "require": {
                "FunctionDeclaration": true,
                "MethodDefinition": false,
                "ClassDeclaration": false,
                "ArrowFunctionExpression": false
            }
        }]
    }

    require

    Examples of incorrect code for this rule with the { "require": { "FunctionDeclaration": true, "MethodDefinition": true, "ClassDeclaration": true, "ArrowFunctionExpression": true } } option:

    /*eslint "require-jsdoc": ["error", {
        "require": {
            "FunctionDeclaration": true,
            "MethodDefinition": true,
            "ClassDeclaration": true
        }
    }]*/
    
    function foo() {
        return 10;
    }
    
    var foo = () => {
        return 10;
    }
    
    class Test{
        getDate(){}
    }

    Examples of correct code for this rule with the { "require": { "FunctionDeclaration": true, "MethodDefinition": true, "ClassDeclaration": true, "ArrowFunctionExpression": true } } option:

    /*eslint "require-jsdoc": ["error", {
        "require": {
            "FunctionDeclaration": true,
            "MethodDefinition": true,
            "ClassDeclaration": true
        }
    }]*/
    
    /**
     * It returns 10
     */
    function foo() {
        return 10;
    }
    
    /**
     * It returns test + 10
     * @params {int} test - some number
     * @returns {int} sum of test and 10
     */
    var foo = (test) => {
        return test + 10;
    }
    
    /**
     * It returns 10
     */
    var foo = () => {
        return 10;
    }
    
    /**
     * It returns 10
     */
    var foo = function() {
        return 10;
    }
    
    var array = [1,2,3];
    array.filter(function(item) {
        return item > 2;
    });
    
    /**
     * It returns 10
     */
    class Test{
        /**
        * returns the date
        */
        getDate(){}
    }
    
    setTimeout(() => {}, 10); // since it's an anonymous arrow function

    When Not To Use It

    If you do not require JSDoc for your functions, then you can leave this rule off.

    Related Rules

    'importScripts' is not defined.
    Open

    importScripts(m_root + '/r2.js');
    Severity: Minor
    Found in www/m/workers/hexchunkProvider.js by eslint

    Disallow Undeclared Variables (no-undef)

    This rule can help you locate potential ReferenceErrors resulting from misspellings of variable and parameter names, or accidental implicit globals (for example, from forgetting the var keyword in a for loop initializer).

    Rule Details

    Any reference to an undeclared variable causes a warning, unless the variable is explicitly mentioned in a /*global ...*/ comment.

    Examples of incorrect code for this rule:

    /*eslint no-undef: "error"*/
    
    var a = someFunction();
    b = 10;

    Examples of correct code for this rule with global declaration:

    /*global someFunction b:true*/
    /*eslint no-undef: "error"*/
    
    var a = someFunction();
    b = 10;

    The b:true syntax in /*global */ indicates that assignment to b is correct.

    Examples of incorrect code for this rule with global declaration:

    /*global b*/
    /*eslint no-undef: "error"*/
    
    b = 10;

    By default, variables declared in /*global */ are read-only, therefore assignment is incorrect.

    Options

    • typeof set to true will warn for variables used inside typeof check (Default false).

    typeof

    Examples of correct code for the default { "typeof": false } option:

    /*eslint no-undef: "error"*/
    
    if (typeof UndefinedIdentifier === "undefined") {
        // do something ...
    }

    You can use this option if you want to prevent typeof check on a variable which has not been declared.

    Examples of incorrect code for the { "typeof": true } option:

    /*eslint no-undef: ["error", { "typeof": true }] */
    
    if(typeof a === "string"){}

    Examples of correct code for the { "typeof": true } option with global declaration:

    /*global a*/
    /*eslint no-undef: ["error", { "typeof": true }] */
    
    if(typeof a === "string"){}

    Environments

    For convenience, ESLint provides shortcuts that pre-define global variables exposed by popular libraries and runtime environments. This rule supports these environments, as listed in Specifying Environments. A few examples are given below.

    browser

    Examples of correct code for this rule with browser environment:

    /*eslint no-undef: "error"*/
    /*eslint-env browser*/
    
    setTimeout(function() {
        alert("Hello");
    });

    node

    Examples of correct code for this rule with node environment:

    /*eslint no-undef: "error"*/
    /*eslint-env node*/
    
    var fs = require("fs");
    module.exports = function() {
        console.log(fs);
    };

    When Not To Use It

    If explicit declaration of global variables is not to your taste.

    Compatibility

    This rule provides compatibility with treatment of global variables in JSHint and JSLint. Source: http://eslint.org/docs/rules/

    BUG found
    Open

        // BUG? callback called more than once
    Severity: Minor
    Found in www/m/workers/hexchunkProvider.js by fixme

    TODO found
    Open

            // TODO: handle "substract" if partial required (first)
    Severity: Minor
    Found in www/m/workers/hexchunkProvider.js by fixme

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

    function hexPairToASCII(pair) {
        var chr = parseInt(pair, 16);
        if (chr >= 33 && chr <= 126) {
            return String.fromCharCode(chr);
        }
    Severity: Minor
    Found in www/m/workers/hexchunkProvider.js and 1 other location - About 55 mins to fix
    www/m/js/modules/hexdump/tools.legacy.js on lines 1..8

    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 54.

    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