Sign upLogin

gregaou/esdoc-rst-plugin

View on GitHub
Star

Showing 10 of 10 total issues

File Plugin.js has 295 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import fs from 'fs';
import path from 'path';
import mkpath from 'mkpath'

let option;
Severity: Minor
Found in src/Plugin.js - About 3 hrs to fix

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

      classe.methods.sort((a, b) => { return (a.tag.name < b.tag.name) ? -1 : (a.tag.name > b.tag.name) ? 1 : 0 })
    Severity: Major
    Found in src/Plugin.js and 1 other location - About 2 hrs to fix
    src/Plugin.js on lines 284..284

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

    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

      classe.members.sort((a, b) => { return (a.tag.name < b.tag.name) ? -1 : (a.tag.name > b.tag.name) ? 1 : 0 })
    Severity: Major
    Found in src/Plugin.js and 1 other location - About 2 hrs to fix
    src/Plugin.js on lines 283..283

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

    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 5 locations. Consider refactoring.
    Open

    function processMethod(tag) {
  const newMethod = {}
  newMethod.tag = tag
  data.methods[tag.longname] = newMethod
  data.classes[tag.memberof].methods.push(newMethod)
    Severity: Major
    Found in src/Plugin.js and 4 other locations - About 1 hr to fix
    src/Plugin.js on lines 154..159
    src/Plugin.js on lines 161..166
    src/Plugin.js on lines 168..173
    src/Plugin.js on lines 175..180

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

    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 5 locations. Consider refactoring.
    Open

    function processSet(tag) {
  const newSet = {}
  newSet.tag = tag
  data.sets[tag.longname] = newSet
  data.classes[tag.memberof].sets.push(newSet)
    Severity: Major
    Found in src/Plugin.js and 4 other locations - About 1 hr to fix
    src/Plugin.js on lines 147..152
    src/Plugin.js on lines 154..159
    src/Plugin.js on lines 161..166
    src/Plugin.js on lines 168..173

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

    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 5 locations. Consider refactoring.
    Open

    function processFunction(tag) {
  const newFunction = {}
  newFunction.tag = tag
  data.functions[tag.longname] = newFunction
  data.files[tag.memberof].functions.push(newFunction)
    Severity: Major
    Found in src/Plugin.js and 4 other locations - About 1 hr to fix
    src/Plugin.js on lines 147..152
    src/Plugin.js on lines 161..166
    src/Plugin.js on lines 168..173
    src/Plugin.js on lines 175..180

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

    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 5 locations. Consider refactoring.
    Open

    function processVariable(tag) {
  const newVariable = {}
  newVariable.tag = tag
  data.variables[tag.longname] = newVariable
  data.files[tag.memberof].variables.push(newVariable)
    Severity: Major
    Found in src/Plugin.js and 4 other locations - About 1 hr to fix
    src/Plugin.js on lines 147..152
    src/Plugin.js on lines 154..159
    src/Plugin.js on lines 168..173
    src/Plugin.js on lines 175..180

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

    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 5 locations. Consider refactoring.
    Open

    function processGet(tag) {
  const newGet = {}
  newGet.tag = tag
  data.gets[tag.longname] = newGet
  data.classes[tag.memberof].gets.push(newGet)
    Severity: Major
    Found in src/Plugin.js and 4 other locations - About 1 hr to fix
    src/Plugin.js on lines 147..152
    src/Plugin.js on lines 154..159
    src/Plugin.js on lines 161..166
    src/Plugin.js on lines 175..180

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

    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 onHandleTag has 46 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export function onHandleTag(ev) {
  for (let tag of ev.data.tag) {
    switch(tag.kind) {
      case "file":
        processFile(tag)
    Severity: Minor
    Found in src/Plugin.js - About 1 hr to fix

      Function generateClassFile has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

      function generateClassFile(classe) {
  const tag = classe.tag
  let content = (tag.export) ? `import ${tag.importStyle} from "${tag.importPath}"\n` : ""
  content += `${tag.access ? tag.access : "public"} class\n\n`
      Severity: Minor
      Found in src/Plugin.js - About 25 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

      Severity
      Category
      Status
      Source
      Language