NaturalIntelligence/fast-xml-parser

View on GitHub
src/xmlparser/OrderedObjParser.js

Summary

Maintainability
F
1 wk
Test Coverage

Function parseXml has a Cognitive Complexity of 160 (exceeds 5 allowed). Consider refactoring.
Open

const parseXml = function(xmlData) {
  xmlData = xmlData.replace(/\r\n?/g, "\n"); //TODO: remove this line
  const xmlObj = new xmlNode('!xml');
  let currentNode = xmlObj;
  let textData = "";
Severity: Minor
Found in src/xmlparser/OrderedObjParser.js - About 3 days 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

File OrderedObjParser.js has 480 lines of code (exceeds 250 allowed). Consider refactoring.
Open

'use strict';
///@ts-check

const util = require('../util');
const xmlNode = require('./xmlNode');
Severity: Minor
Found in src/xmlparser/OrderedObjParser.js - About 7 hrs to fix

    Function parseXml has 167 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    const parseXml = function(xmlData) {
      xmlData = xmlData.replace(/\r\n?/g, "\n"); //TODO: remove this line
      const xmlObj = new xmlNode('!xml');
      let currentNode = xmlObj;
      let textData = "";
    Severity: Major
    Found in src/xmlparser/OrderedObjParser.js - About 6 hrs to fix

      Function buildAttributesMap has a Cognitive Complexity of 37 (exceeds 5 allowed). Consider refactoring.
      Open

      function buildAttributesMap(attrStr, jPath, tagName) {
        if (!this.options.ignoreAttributes && typeof attrStr === 'string') {
          // attrStr = attrStr.replace(/\r?\n/g, ' ');
          //attrStr = attrStr || attrStr.trim();
      
      
      Severity: Minor
      Found in src/xmlparser/OrderedObjParser.js - About 5 hrs 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 readStopNodeData has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
      Open

      function readStopNodeData(xmlData, tagName, i){
        const startIndex = i;
        // Starting at 1 since we already have an open tag
        let openTagCount = 1;
      
      
      Severity: Minor
      Found in src/xmlparser/OrderedObjParser.js - About 4 hrs 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 parseTextData has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
      Open

      function parseTextData(val, tagName, jPath, dontTrim, hasAttributes, isLeafNode, escapeEntities) {
        if (val !== undefined) {
          if (this.options.trimValues && !dontTrim) {
            val = val.trim();
          }
      Severity: Minor
      Found in src/xmlparser/OrderedObjParser.js - About 2 hrs 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 tagExpWithClosingIndex has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
      Open

      function tagExpWithClosingIndex(xmlData, i, closingChar = ">"){
        let attrBoundary;
        let tagExp = "";
        for (let index = i; index < xmlData.length; index++) {
          let ch = xmlData[index];
      Severity: Minor
      Found in src/xmlparser/OrderedObjParser.js - About 2 hrs 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 buildAttributesMap has 45 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function buildAttributesMap(attrStr, jPath, tagName) {
        if (!this.options.ignoreAttributes && typeof attrStr === 'string') {
          // attrStr = attrStr.replace(/\r?\n/g, ' ');
          //attrStr = attrStr || attrStr.trim();
      
      
      Severity: Minor
      Found in src/xmlparser/OrderedObjParser.js - About 1 hr to fix

        Function readStopNodeData has 38 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

        function readStopNodeData(xmlData, tagName, i){
          const startIndex = i;
          // Starting at 1 since we already have an open tag
          let openTagCount = 1;
        
        
        Severity: Minor
        Found in src/xmlparser/OrderedObjParser.js - About 1 hr to fix

          Function constructor has 33 lines of code (exceeds 25 allowed). Consider refactoring.
          Open

            constructor(options){
              this.options = options;
              this.currentNode = null;
              this.tagsNodeStack = [];
              this.docTypeEntities = {};
          Severity: Minor
          Found in src/xmlparser/OrderedObjParser.js - About 1 hr to fix

            Function replaceEntitiesValue has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
            Open

            const replaceEntitiesValue = function(val){
            
              if(this.options.processEntities){
                for(let entityName in this.docTypeEntities){
                  const entity = this.docTypeEntities[entityName];
            Severity: Minor
            Found in src/xmlparser/OrderedObjParser.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 tagExpWithClosingIndex has 27 lines of code (exceeds 25 allowed). Consider refactoring.
            Open

            function tagExpWithClosingIndex(xmlData, i, closingChar = ">"){
              let attrBoundary;
              let tagExp = "";
              for (let index = i; index < xmlData.length; index++) {
                let ch = xmlData[index];
            Severity: Minor
            Found in src/xmlparser/OrderedObjParser.js - About 1 hr to fix

              Function readTagExp has 26 lines of code (exceeds 25 allowed). Consider refactoring.
              Open

              function readTagExp(xmlData,i, removeNSPrefix, closingChar = ">"){
                const result = tagExpWithClosingIndex(xmlData, i+1, closingChar);
                if(!result) return;
                let tagExp = result.data;
                const closeIndex = result.index;
              Severity: Minor
              Found in src/xmlparser/OrderedObjParser.js - About 1 hr to fix

                Function parseTextData has 7 arguments (exceeds 4 allowed). Consider refactoring.
                Open

                function parseTextData(val, tagName, jPath, dontTrim, hasAttributes, isLeafNode, escapeEntities) {
                Severity: Major
                Found in src/xmlparser/OrderedObjParser.js - About 50 mins to fix

                  Avoid deeply nested control flow statements.
                  Open

                        } else if(xmlData.substr(i + 1, 3) === '!--') {
                          const endIndex = findClosingIndex(xmlData, "-->", i+4, "Comment is not closed.")
                          if(this.options.commentPropName){
                            const comment = xmlData.substring(i + 4, endIndex - 2);
                  
                  
                  Severity: Major
                  Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

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

                    function parseValue(val, shouldParse, options) {
                      if (shouldParse && typeof val === 'string') {
                        //console.log(options)
                        const newval = val.trim();
                        if(newval === 'true' ) return true;
                    Severity: Minor
                    Found in src/xmlparser/OrderedObjParser.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

                    Avoid deeply nested control flow statements.
                    Open

                            if(xmlData[index + 1] === closingChar[1]){
                              return {
                                data: tagExp,
                                index: index
                              }
                    Severity: Major
                    Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

                      Avoid deeply nested control flow statements.
                      Open

                                  if (openTagCount === 0) {
                                    return {
                                      tagContent: xmlData.substring(startIndex, i),
                                      i : closeIndex
                                    }
                      Severity: Major
                      Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

                        Avoid deeply nested control flow statements.
                        Open

                                if(!tagData) throw new Error("Pi Tag is not closed.");
                        Severity: Major
                        Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

                          Avoid deeply nested control flow statements.
                          Open

                                  if( (this.options.ignoreDeclaration && tagData.tagName === "?xml") || this.options.ignorePiTags){
                          
                                  }else{
                            
                                    const childNode = new xmlNode(tagData.tagName);
                          Severity: Major
                          Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

                            Avoid deeply nested control flow statements.
                            Open

                                      if (tagData) {
                                        const openTagName = tagData && tagData.tagName;
                                        if (openTagName === tagName && tagData.tagExp[tagData.tagExp.length-1] !== "/") {
                                          openTagCount++;
                                        }
                            Severity: Major
                            Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

                              Avoid deeply nested control flow statements.
                              Open

                                      } else if (this.options.allowBooleanAttributes) {
                                        attrs[aName] = true;
                                      }
                              Severity: Major
                              Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

                                Avoid deeply nested control flow statements.
                                Open

                                          if (this.options.trimValues) {
                                            oldVal = oldVal.trim();
                                          }
                                Severity: Major
                                Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

                                  Avoid deeply nested control flow statements.
                                  Open

                                            if(newVal === null || newVal === undefined){
                                              //don't parse
                                              attrs[aName] = oldVal;
                                            }else if(typeof newVal !== typeof oldVal || newVal !== oldVal){
                                              //overwrite
                                  Severity: Major
                                  Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

                                    Avoid deeply nested control flow statements.
                                    Open

                                              if(colonIndex !== -1){
                                                tagName = tagName.substr(colonIndex+1);
                                              }
                                    Severity: Major
                                    Found in src/xmlparser/OrderedObjParser.js - About 45 mins to fix

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

                                      function resolveNameSpace(tagname) {
                                        if (this.options.removeNSPrefix) {
                                          const tags = tagname.split(':');
                                          const prefix = tagname.charAt(0) === '/' ? '/' : '';
                                          if (tags[0] === 'xmlns') {
                                      Severity: Minor
                                      Found in src/xmlparser/OrderedObjParser.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

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

                                      function saveTextToParentTag(textData, currentNode, jPath, isLeafNode) {
                                        if (textData) { //store previously collected data as textNode
                                          if(isLeafNode === undefined) isLeafNode = Object.keys(currentNode.child).length === 0
                                          
                                          textData = this.parseTextData(textData,
                                      Severity: Minor
                                      Found in src/xmlparser/OrderedObjParser.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

                                      Avoid too many return statements within this function.
                                      Open

                                                return val;
                                      Severity: Major
                                      Found in src/xmlparser/OrderedObjParser.js - About 30 mins to fix

                                        Avoid too many return statements within this function.
                                        Open

                                              return '';
                                        Severity: Major
                                        Found in src/xmlparser/OrderedObjParser.js - About 30 mins to fix

                                          Empty block statement.
                                          Open

                                            if(result === false){
                                          Severity: Minor
                                          Found in src/xmlparser/OrderedObjParser.js by eslint

                                          disallow empty block statements (no-empty)

                                          Empty block statements, while not technically errors, usually occur due to refactoring that wasn't completed. They can cause confusion when reading code.

                                          Rule Details

                                          This rule disallows empty block statements. This rule ignores block statements which contain a comment (for example, in an empty catch or finally block of a try statement to indicate that execution should continue regardless of errors).

                                          Examples of incorrect code for this rule:

                                          /*eslint no-empty: "error"*/
                                          
                                          if (foo) {
                                          }
                                          
                                          while (foo) {
                                          }
                                          
                                          switch(foo) {
                                          }
                                          
                                          try {
                                              doSomething();
                                          } catch(ex) {
                                          
                                          } finally {
                                          
                                          }

                                          Examples of correct code for this rule:

                                          /*eslint no-empty: "error"*/
                                          
                                          if (foo) {
                                              // empty
                                          }
                                          
                                          while (foo) {
                                              /* empty */
                                          }
                                          
                                          try {
                                              doSomething();
                                          } catch (ex) {
                                              // continue regardless of error
                                          }
                                          
                                          try {
                                              doSomething();
                                          } finally {
                                              /* continue regardless of error */
                                          }

                                          Options

                                          This rule has an object option for exceptions:

                                          • "allowEmptyCatch": true allows empty catch clauses (that is, which do not contain a comment)

                                          allowEmptyCatch

                                          Examples of additional correct code for this rule with the { "allowEmptyCatch": true } option:

                                          /* eslint no-empty: ["error", { "allowEmptyCatch": true }] */
                                          try {
                                              doSomething();
                                          } catch (ex) {}
                                          
                                          try {
                                              doSomething();
                                          }
                                          catch (ex) {}
                                          finally {
                                              /* continue regardless of error */
                                          }

                                          When Not To Use It

                                          If you intentionally use empty block statements then you can disable this rule.

                                          Related Rules

                                          Empty block statement.
                                          Open

                                                  if( (this.options.ignoreDeclaration && tagData.tagName === "?xml") || this.options.ignorePiTags){
                                          Severity: Minor
                                          Found in src/xmlparser/OrderedObjParser.js by eslint

                                          disallow empty block statements (no-empty)

                                          Empty block statements, while not technically errors, usually occur due to refactoring that wasn't completed. They can cause confusion when reading code.

                                          Rule Details

                                          This rule disallows empty block statements. This rule ignores block statements which contain a comment (for example, in an empty catch or finally block of a try statement to indicate that execution should continue regardless of errors).

                                          Examples of incorrect code for this rule:

                                          /*eslint no-empty: "error"*/
                                          
                                          if (foo) {
                                          }
                                          
                                          while (foo) {
                                          }
                                          
                                          switch(foo) {
                                          }
                                          
                                          try {
                                              doSomething();
                                          } catch(ex) {
                                          
                                          } finally {
                                          
                                          }

                                          Examples of correct code for this rule:

                                          /*eslint no-empty: "error"*/
                                          
                                          if (foo) {
                                              // empty
                                          }
                                          
                                          while (foo) {
                                              /* empty */
                                          }
                                          
                                          try {
                                              doSomething();
                                          } catch (ex) {
                                              // continue regardless of error
                                          }
                                          
                                          try {
                                              doSomething();
                                          } finally {
                                              /* continue regardless of error */
                                          }

                                          Options

                                          This rule has an object option for exceptions:

                                          • "allowEmptyCatch": true allows empty catch clauses (that is, which do not contain a comment)

                                          allowEmptyCatch

                                          Examples of additional correct code for this rule with the { "allowEmptyCatch": true } option:

                                          /* eslint no-empty: ["error", { "allowEmptyCatch": true }] */
                                          try {
                                              doSomething();
                                          } catch (ex) {}
                                          
                                          try {
                                              doSomething();
                                          }
                                          catch (ex) {}
                                          finally {
                                              /* continue regardless of error */
                                          }

                                          When Not To Use It

                                          If you intentionally use empty block statements then you can disable this rule.

                                          Related Rules

                                          'tagName' is defined but never used.
                                          Open

                                          function buildAttributesMap(attrStr, jPath, tagName) {
                                          Severity: Minor
                                          Found in src/xmlparser/OrderedObjParser.js by eslint

                                          Disallow Unused Variables (no-unused-vars)

                                          Variables that are declared and not used anywhere in the code are most likely an error due to incomplete refactoring. Such variables take up space in the code and can lead to confusion by readers.

                                          Rule Details

                                          This rule is aimed at eliminating unused variables, functions, and parameters of functions.

                                          A variable is considered to be used if any of the following are true:

                                          • It represents a function that is called (doSomething())
                                          • It is read (var y = x)
                                          • It is passed into a function as an argument (doSomething(x))
                                          • It is read inside of a function that is passed to another function (doSomething(function() { foo(); }))

                                          A variable is not considered to be used if it is only ever assigned to (var x = 5) or declared.

                                          Examples of incorrect code for this rule:

                                          /*eslint no-unused-vars: "error"*/
                                          /*global some_unused_var*/
                                          
                                          // It checks variables you have defined as global
                                          some_unused_var = 42;
                                          
                                          var x;
                                          
                                          // Write-only variables are not considered as used.
                                          var y = 10;
                                          y = 5;
                                          
                                          // A read for a modification of itself is not considered as used.
                                          var z = 0;
                                          z = z + 1;
                                          
                                          // By default, unused arguments cause warnings.
                                          (function(foo) {
                                              return 5;
                                          })();
                                          
                                          // Unused recursive functions also cause warnings.
                                          function fact(n) {
                                              if (n < 2) return 1;
                                              return n * fact(n - 1);
                                          }
                                          
                                          // When a function definition destructures an array, unused entries from the array also cause warnings.
                                          function getY([x, y]) {
                                              return y;
                                          }

                                          Examples of correct code for this rule:

                                          /*eslint no-unused-vars: "error"*/
                                          
                                          var x = 10;
                                          alert(x);
                                          
                                          // foo is considered used here
                                          myFunc(function foo() {
                                              // ...
                                          }.bind(this));
                                          
                                          (function(foo) {
                                              return foo;
                                          })();
                                          
                                          var myFunc;
                                          myFunc = setTimeout(function() {
                                              // myFunc is considered used
                                              myFunc();
                                          }, 50);
                                          
                                          // Only the second argument from the descructured array is used.
                                          function getY([, y]) {
                                              return y;
                                          }

                                          exported

                                          In environments outside of CommonJS or ECMAScript modules, you may use var to create a global variable that may be used by other scripts. You can use the /* exported variableName */ comment block to indicate that this variable is being exported and therefore should not be considered unused.

                                          Note that /* exported */ has no effect for any of the following:

                                          • when the environment is node or commonjs
                                          • when parserOptions.sourceType is module
                                          • when ecmaFeatures.globalReturn is true

                                          The line comment // exported variableName will not work as exported is not line-specific.

                                          Examples of correct code for /* exported variableName */ operation:

                                          /* exported global_var */
                                          
                                          var global_var = 42;

                                          Options

                                          This rule takes one argument which can be a string or an object. The string settings are the same as those of the vars property (explained below).

                                          By default this rule is enabled with all option for variables and after-used for arguments.

                                          {
                                              "rules": {
                                                  "no-unused-vars": ["error", { "vars": "all", "args": "after-used", "ignoreRestSiblings": false }]
                                              }
                                          }

                                          vars

                                          The vars option has two settings:

                                          • all checks all variables for usage, including those in the global scope. This is the default setting.
                                          • local checks only that locally-declared variables are used but will allow global variables to be unused.

                                          vars: local

                                          Examples of correct code for the { "vars": "local" } option:

                                          /*eslint no-unused-vars: ["error", { "vars": "local" }]*/
                                          /*global some_unused_var */
                                          
                                          some_unused_var = 42;

                                          varsIgnorePattern

                                          The varsIgnorePattern option specifies exceptions not to check for usage: variables whose names match a regexp pattern. For example, variables whose names contain ignored or Ignored.

                                          Examples of correct code for the { "varsIgnorePattern": "[iI]gnored" } option:

                                          /*eslint no-unused-vars: ["error", { "varsIgnorePattern": "[iI]gnored" }]*/
                                          
                                          var firstVarIgnored = 1;
                                          var secondVar = 2;
                                          console.log(secondVar);

                                          args

                                          The args option has three settings:

                                          • after-used - only the last argument must be used. This allows you, for instance, to have two named parameters to a function and as long as you use the second argument, ESLint will not warn you about the first. This is the default setting.
                                          • all - all named arguments must be used.
                                          • none - do not check arguments.

                                          args: after-used

                                          Examples of incorrect code for the default { "args": "after-used" } option:

                                          /*eslint no-unused-vars: ["error", { "args": "after-used" }]*/
                                          
                                          // 1 error
                                          // "baz" is defined but never used
                                          (function(foo, bar, baz) {
                                              return bar;
                                          })();

                                          Examples of correct code for the default { "args": "after-used" } option:

                                          /*eslint no-unused-vars: ["error", {"args": "after-used"}]*/
                                          
                                          (function(foo, bar, baz) {
                                              return baz;
                                          })();

                                          args: all

                                          Examples of incorrect code for the { "args": "all" } option:

                                          /*eslint no-unused-vars: ["error", { "args": "all" }]*/
                                          
                                          // 2 errors
                                          // "foo" is defined but never used
                                          // "baz" is defined but never used
                                          (function(foo, bar, baz) {
                                              return bar;
                                          })();

                                          args: none

                                          Examples of correct code for the { "args": "none" } option:

                                          /*eslint no-unused-vars: ["error", { "args": "none" }]*/
                                          
                                          (function(foo, bar, baz) {
                                              return bar;
                                          })();

                                          ignoreRestSiblings

                                          The ignoreRestSiblings option is a boolean (default: false). Using a Rest Property it is possible to "omit" properties from an object, but by default the sibling properties are marked as "unused". With this option enabled the rest property's siblings are ignored.

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

                                          /*eslint no-unused-vars: ["error", { "ignoreRestSiblings": true }]*/
                                          // 'type' is ignored because it has a rest property sibling.
                                          var { type, ...coords } = data;

                                          argsIgnorePattern

                                          The argsIgnorePattern option specifies exceptions not to check for usage: arguments whose names match a regexp pattern. For example, variables whose names begin with an underscore.

                                          Examples of correct code for the { "argsIgnorePattern": "^_" } option:

                                          /*eslint no-unused-vars: ["error", { "argsIgnorePattern": "^_" }]*/
                                          
                                          function foo(x, _y) {
                                              return x + 1;
                                          }
                                          foo();

                                          caughtErrors

                                          The caughtErrors option is used for catch block arguments validation.

                                          It has two settings:

                                          • none - do not check error objects. This is the default setting.
                                          • all - all named arguments must be used.

                                          caughtErrors: none

                                          Not specifying this rule is equivalent of assigning it to none.

                                          Examples of correct code for the { "caughtErrors": "none" } option:

                                          /*eslint no-unused-vars: ["error", { "caughtErrors": "none" }]*/
                                          
                                          try {
                                              //...
                                          } catch (err) {
                                              console.error("errors");
                                          }

                                          caughtErrors: all

                                          Examples of incorrect code for the { "caughtErrors": "all" } option:

                                          /*eslint no-unused-vars: ["error", { "caughtErrors": "all" }]*/
                                          
                                          // 1 error
                                          // "err" is defined but never used
                                          try {
                                              //...
                                          } catch (err) {
                                              console.error("errors");
                                          }

                                          caughtErrorsIgnorePattern

                                          The caughtErrorsIgnorePattern option specifies exceptions not to check for usage: catch arguments whose names match a regexp pattern. For example, variables whose names begin with a string 'ignore'.

                                          Examples of correct code for the { "caughtErrorsIgnorePattern": "^ignore" } option:

                                          /*eslint no-unused-vars: ["error", { "caughtErrorsIgnorePattern": "^ignore" }]*/
                                          
                                          try {
                                              //...
                                          } catch (ignoreErr) {
                                              console.error("errors");
                                          }

                                          When Not To Use It

                                          If you don't want to be notified about unused variables or function arguments, you can safely turn this rule off. Source: http://eslint.org/docs/rules/

                                          TODO found
                                          Open

                                            xmlData = xmlData.replace(/\r\n?/g, "\n"); //TODO: remove this line
                                          Severity: Minor
                                          Found in src/xmlparser/OrderedObjParser.js by fixme

                                          TODO found
                                          Open

                                          //TODO: use jPath to simplify the logic
                                          Severity: Minor
                                          Found in src/xmlparser/OrderedObjParser.js by fixme

                                          TODO found
                                          Open

                                          //TODO: change regex to capture NS
                                          Severity: Minor
                                          Found in src/xmlparser/OrderedObjParser.js by fixme

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

                                          function readStopNodeData(xmlData, tagName, i){
                                            const startIndex = i;
                                            // Starting at 1 since we already have an open tag
                                            let openTagCount = 1;
                                          
                                          
                                          Severity: Major
                                          Found in src/xmlparser/OrderedObjParser.js and 1 other location - About 2 days to fix
                                          src/v5/XmlPartReader.js on lines 9..51

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

                                          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

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

                                                      if(tagName[tagName.length - 1] === "/"){ //remove trailing '/'
                                                        tagName = tagName.substr(0, tagName.length - 1);
                                                        jPath = jPath.substr(0, jPath.length - 1);
                                                        tagExp = tagName;
                                                      }else{
                                          Severity: Major
                                          Found in src/xmlparser/OrderedObjParser.js and 1 other location - About 3 hrs to fix
                                          src/xmlparser/OrderedObjParser.js on lines 352..358

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

                                          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

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

                                                      if(tagName[tagName.length - 1] === "/"){ //remove trailing '/'
                                                        tagName = tagName.substr(0, tagName.length - 1);
                                                        jPath = jPath.substr(0, jPath.length - 1);
                                                        tagExp = tagName;
                                                      }else{
                                          Severity: Major
                                          Found in src/xmlparser/OrderedObjParser.js and 1 other location - About 3 hrs to fix
                                          src/xmlparser/OrderedObjParser.js on lines 314..320

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

                                          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