Sign upLogin

frontainer/frontnote

View on GitHub
Star

Showing 6 of 6 total issues

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

    parse(file, content) {
        let overview = content.match(PATTERNS.overview);
        if (overview) {
            overview = this.parseComments(overview);
            if (overview) {
Severity: Minor
Found in lib/parser/parser.js - About 1 hr to fix

    Function sanitize has 28 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        sanitize(attrs, code, comment) {
        let result = {
            title: [],
            comment: [],
            attributes: attrs || [],
    Severity: Minor
    Found in lib/parser/parser.js - About 1 hr to fix

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

          copyFile(from,to) {
        const copyFileAsObservable = Rx.Observable.bindNodeCallback(cpx.copy);
        return copyFileAsObservable(from, to).map(() => {
            return to;
        });
      Severity: Major
      Found in lib/generator/generator.js and 1 other location - About 1 hr to fix
      lib/generator/generator.js on lines 42..47

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

      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

          writeFile(filepath,content) {
        const writeFileAsObservable = Rx.Observable.bindNodeCallback(fs.outputFile);
        return writeFileAsObservable(filepath, content).map(() => {
            return filepath;
        });
      Severity: Major
      Found in lib/generator/generator.js and 1 other location - About 1 hr to fix
      lib/generator/generator.js on lines 48..53

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

      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 sanitize has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
      Open

          sanitize(attrs, code, comment) {
        let result = {
            title: [],
            comment: [],
            attributes: attrs || [],
      Severity: Minor
      Found in lib/parser/parser.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 parse has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
      Open

          parse(file, content) {
        let overview = content.match(PATTERNS.overview);
        if (overview) {
            overview = this.parseComments(overview);
            if (overview) {
      Severity: Minor
      Found in lib/parser/parser.js - About 55 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