roperzh/jroff

View on GitHub

Showing 8 of 8 total issues

File jroff.js has 1047 lines of code (exceeds 250 allowed). Consider refactoring.
Open

/**
 * Jroff 0.0.1 <http://roperzh.github.io/jroff.js>
 * Copyright (c)2015 Roberto Dip <http://roperzh.com>
 * @license Distributed under MIT license
 * @module Jroff
Severity: Major
Found in dist/jroff.js - About 2 days to fix

    Function It has 53 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        It: function (args) {
          var list = this.buffer.lists[0],
            pre = list.isOpen ? '</span></li>' : '',
            tagStyles = '',
            tag = '',
    Severity: Major
    Found in dist/jroff.js - About 2 hrs to fix

      Method 'It' has a complexity of 13.
      Open

          It: function (args) {
      Severity: Minor
      Found in dist/jroff.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 Dt has 29 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          Dt: function (args) {
            var sideText,
              midText,
              title,
              section,
      Severity: Minor
      Found in dist/jroff.js - About 1 hr to fix

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

            vs: function (spacing) {
              spacing = spacing || 12;
        
              this.buffer.openTags.push('section');
        
        
        Severity: Major
        Found in dist/jroff.js and 1 other location - About 1 hr to fix
        dist/jroff.js on lines 981..987

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

        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

            in : function (indent) {
              indent = indent || 3;
        
              this.buffer.openTags.push('section');
        
        
        Severity: Major
        Found in dist/jroff.js and 1 other location - About 1 hr to fix
        dist/jroff.js on lines 951..957

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

        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

        TODO found
        Open

              /* TODO: apply this property somewhere */
        Severity: Minor
        Found in dist/jroff.js by fixme

        TODO found
        Open

              /* TODO: apply this property somewhere */
        Severity: Minor
        Found in dist/jroff.js by fixme
        Severity
        Category
        Status
        Source
        Language