markdown-note/markdown-notes

View on GitHub

Showing 144 of 144 total issues

File note-client.js has 282 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/*****************************************************************
 * Acts like a controller and contains code to handle notes in the
 * application. It calls and coordinates the activities of other
 * note-related modules such as the notes, note editor and events.
 *
Severity: Minor
Found in src/browser/notes/note-client.js - About 2 hrs to fix

    Function NotebookUtils has 67 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    var NotebookUtils = function() {
      function getNotebookItem(notebook, isChecked) {
        var checkedHTML = '';
        if (isChecked) {
          checkedHTML = 'checked';
    Severity: Major
    Found in src/browser/notebooks/notebook-utils.js - About 2 hrs to fix

      File notebook-client.js has 275 lines of code (exceeds 250 allowed). Consider refactoring.
      Open

      /* jshint esnext: true */
      'use strict';
      
      var _i18n = require('i18n');
      var _async = require('async');
      Severity: Minor
      Found in src/browser/notebooks/notebook-client.js - About 2 hrs to fix

        File note.js has 273 lines of code (exceeds 250 allowed). Consider refactoring.
        Open

        /*************************************************
         * Contains code to communicate with the Notes
         * database.
         * @author : Abijeet Patro
         *************************************************/
        Severity: Minor
        Found in src/browser/notes/note.js - About 2 hrs to fix

          Function SettingsClient has 62 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

          var SettingsClient = function() {
            var dlg = null;
            var allTabs = null;
            var allTabAnchors = null;
            var defaultMsgClass = 'alert';
          Severity: Major
          Found in src/browser/settings/setting-client.js - About 2 hrs to fix

            Function handleTextModifier has 58 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

              function handleTextModifier(note, modifierType) {
                var sel = window.getSelection();
                if (sel.rangeCount) {
                  var range = sel.getRangeAt(0);
                  var noteStr = note.innerText;
            Severity: Major
            Found in src/browser/notes/note-editor.js - About 2 hrs to fix

              Function 'handleTextModifier' has a complexity of 11.
              Open

                function handleTextModifier(note, modifierType) {
              Severity: Minor
              Found in src/browser/notes/note-editor.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 MarkdownNotes has 52 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              var MarkdownNotes = function() {
                // Keep a track of whether the settings have changed.
                // Some settings need to be applied at application
                // close.
                var settingsToBeApplied = null;
              Severity: Major
              Found in src/renderer/markdown-notes.js - About 2 hrs to fix

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

                    }, function(err, html) {
                      if (!_appUtil.checkAndInsertDialog(err, html, _i18n.__('error.about_dialog_display'))) {
                        return;
                      }
                      var $dlg = jQuery('#dlgAbout');
                Severity: Major
                Found in src/browser/app/app-events.js and 1 other location - About 2 hrs to fix
                src/browser/notebooks/notebook-events.js on lines 162..170

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

                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

                    _appUtil.loadDialog('new-notebook.html', {}, function(err, html) {
                      if (!_appUtil.checkAndInsertDialog(err, html, _i18n.__('error.new_notebook_display_error'))) {
                        return;
                      }
                      var $dlg = jQuery('#dlgNewNotebook');
                Severity: Major
                Found in src/browser/notebooks/notebook-events.js and 1 other location - About 2 hrs to fix
                src/browser/app/app-events.js on lines 34..42

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

                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

                Function App has 48 lines of code (exceeds 25 allowed). Consider refactoring.
                Open

                var App = function() {
                  var dbObjs = {};
                
                  /**
                   * Called when the application starts.
                Severity: Minor
                Found in src/browser/app/app.js - About 1 hr to fix

                  Function AppEvents has 47 lines of code (exceeds 25 allowed). Consider refactoring.
                  Open

                  var AppEvents = function() {
                  
                    function init() {
                      document.getElementById('1_btnShortcutHelp').addEventListener('click', showShortcutDialog, false);
                      document.getElementById('1_btnAboutUs').addEventListener('click', showAboutDialog, false);
                  Severity: Minor
                  Found in src/browser/app/app-events.js - About 1 hr to fix

                    Function has a complexity of 7.
                    Open

                    var AppError = function(err, customMsg, log, overrideMsg) {
                    Severity: Minor
                    Found in src/common/app-error.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 MainWindow has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
                    Open

                    var MainWindow = function() {
                      var mainWindow = null;
                      var isMaximized = false;
                    
                      function init() {
                    Severity: Minor
                    Found in src/renderer/main-window.js - About 1 hr 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

                    Function MainWindow has 43 lines of code (exceeds 25 allowed). Consider refactoring.
                    Open

                    var MainWindow = function() {
                      var mainWindow = null;
                      var isMaximized = false;
                    
                      function init() {
                    Severity: Minor
                    Found in src/renderer/main-window.js - About 1 hr to fix

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

                        function showTab(notebookID, updateActiveNotebook, cbMain) {
                          // Fetch the notebook details
                          _notebooks.getFullDetailByID(notebookID, function(err, notebookData) {
                            if (err) {
                              err.display();
                      Severity: Minor
                      Found in src/browser/notebooks/notebook-client.js - About 1 hr to fix

                        Function NotebookUtils has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
                        Open

                        var NotebookUtils = function() {
                          function getNotebookItem(notebook, isChecked) {
                            var checkedHTML = '';
                            if (isChecked) {
                              checkedHTML = 'checked';
                        Severity: Minor
                        Found in src/browser/notebooks/notebook-utils.js - About 1 hr 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

                        Function updateSettings has 35 lines of code (exceeds 25 allowed). Consider refactoring.
                        Open

                          var updateSettings = function(newSettings, cbMain) {
                            var oldSettings = getAppSettings();
                            var requiresRestart = false;
                            var newSettingsToApply = {};
                            if (newSettings.dbLocation !== oldSettings.dbLocation) {
                        Severity: Minor
                        Found in src/common/settings.js - About 1 hr to fix

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

                            var init = function(cbMain) {
                              // Generate the db storage locations based on settings.
                              var settings = _settings.getAppSettings();
                              var dbBasePath = settings.dbLocation;
                          
                          
                          Severity: Minor
                          Found in src/browser/app/app.js - About 1 hr to fix

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

                              function changeNoteDate(noteID, updatedDate, isComplete, cbMain) {
                                var notesDb = _app.getNotesDb();
                                var err = null;
                                if (!noteID) {
                                  err = new _appError(new Error('Please provide the note ID.'),
                            Severity: Minor
                            Found in src/browser/notes/note.js - About 1 hr to fix
                              Severity
                              Category
                              Status
                              Source
                              Language