radare/radare2-webui

View on GitHub
www/m/js/modules/hexdump/HexPairNavigator.js

Summary

Maintainability
B
5 hrs
Test Coverage

Function getFlags has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    getFlags(minSize, callback) {
        var filter = function(flags) {
            var filteredFlags = [];
            for (var i = 0 ; i < flags.length ; i++) {
                if (flags[i].size >= minSize) {
Severity: Minor
Found in www/m/js/modules/hexdump/HexPairNavigator.js - About 1 hr to fix

    Function getFlags has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
    Open

        getFlags(minSize, callback) {
            var filter = function(flags) {
                var filteredFlags = [];
                for (var i = 0 ; i < flags.length ; i++) {
                    if (flags[i].size >= minSize) {
    Severity: Minor
    Found in www/m/js/modules/hexdump/HexPairNavigator.js - About 35 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

    Missing JSDoc comment.
    Open

        constructor(howManyLines, nbCols, startOffset) {

    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

        refreshChunk(which, callback) {

    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

        refreshCurrent(callback) {

    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

        getBytes(range) {

    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

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

            for (var i = 0 ; i < this.smallModifications.length ; i++) {
                if (this.smallModifications[i].offset === offset) {
                    return this.smallModifications[i].value;
                }
            }
    Severity: Major
    Found in www/m/js/modules/hexdump/HexPairNavigator.js and 2 other locations - About 1 hr to fix
    www/m/js/modules/disasm/DisassemblyNavigator.js on lines 206..210
    www/m/js/modules/hexdump/Hexdump.js on lines 1150..1154

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

    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

            this.get(NavigatorDirection.CURRENT, function(chunk) {
                flags = flags.concat(chunk.flags);
                actuator();
            });
    Severity: Minor
    Found in www/m/js/modules/hexdump/HexPairNavigator.js and 2 other locations - About 35 mins to fix
    www/m/js/modules/hexdump/HexPairNavigator.js on lines 130..133
    www/m/js/modules/hexdump/HexPairNavigator.js on lines 134..137

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

    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

            this.get(NavigatorDirection.AFTER, function(chunk) {
                flags = flags.concat(chunk.flags);
                actuator();
            });
    Severity: Minor
    Found in www/m/js/modules/hexdump/HexPairNavigator.js and 2 other locations - About 35 mins to fix
    www/m/js/modules/hexdump/HexPairNavigator.js on lines 126..129
    www/m/js/modules/hexdump/HexPairNavigator.js on lines 130..133

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

    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

            this.get(NavigatorDirection.BEFORE, function(chunk) {
                flags = flags.concat(chunk.flags);
                actuator();
            });
    Severity: Minor
    Found in www/m/js/modules/hexdump/HexPairNavigator.js and 2 other locations - About 35 mins to fix
    www/m/js/modules/hexdump/HexPairNavigator.js on lines 126..129
    www/m/js/modules/hexdump/HexPairNavigator.js on lines 134..137

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

    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