cltk/annotations

View on GitHub
src/decorators/GreekProsody.js

Summary

Maintainability
D
1 day
Test Coverage

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

// @flow

import React from 'react'
import type { ContentBlock, ContentState } from 'draft-js'

Severity: Minor
Found in src/decorators/GreekProsody.js - About 3 hrs to fix

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

    export const syllablize = (sentence: string): Array<[
      string,
      number,
      number
    ]> => {
    Severity: Minor
    Found in src/decorators/GreekProsody.js - About 1 hr to fix

      Avoid too many return statements within this function.
      Open

          return syllables
      Severity: Major
      Found in src/decorators/GreekProsody.js - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

              return [...syllables, nextEl]
        Severity: Major
        Found in src/decorators/GreekProsody.js - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                return syllables
          Severity: Major
          Found in src/decorators/GreekProsody.js - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

              return false
            Severity: Major
            Found in src/decorators/GreekProsody.js - About 30 mins to fix

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

              export const isLongByPosition = (syllable: string, nextSyllable: string): boolean => {
                if (!nextSyllable) {
                  return false
                }
              
              
              Severity: Minor
              Found in src/decorators/GreekProsody.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

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

              export const scansionStrategy = (
                contentBlock: ContentBlock,
                callback: Function,
                contentState: ContentState
              ) => {
              Severity: Major
              Found in src/decorators/GreekProsody.js and 1 other location - About 3 hrs to fix
              src/decorators/Annotation.js on lines 10..26

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

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

                  if (diphthongs.includes(`${currentLetter}${sentence[index + 1]}`)) {
                    const substr = sentence.substring(lastIndex, index + 2)
                    const nextEl = [substr, lastIndex, index === 0 ? 2 : index + 2]
              
                    lastIndex = index + 2
              Severity: Major
              Found in src/decorators/GreekProsody.js and 2 other locations - About 1 hr to fix
              src/decorators/GreekProsody.js on lines 140..147
              src/decorators/GreekProsody.js on lines 158..165

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

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

                  if (vowels.includes(currentLetter)) {
                    const substr = sentence.substring(lastIndex, index + 1)
                    const nextEl = [substr, lastIndex, index === 0 ? 1 : index + 1]
              
                    lastIndex = index + 1
              Severity: Major
              Found in src/decorators/GreekProsody.js and 2 other locations - About 1 hr to fix
              src/decorators/GreekProsody.js on lines 140..147
              src/decorators/GreekProsody.js on lines 149..156

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

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

                  if (diaresis.includes(currentLetter)) {
                    const substr = sentence.substring(lastIndex, index + 1)
                    const nextEl = [substr, lastIndex, index === 0 ? 1 : index + 1]
              
                    lastIndex = index + 1
              Severity: Major
              Found in src/decorators/GreekProsody.js and 2 other locations - About 1 hr to fix
              src/decorators/GreekProsody.js on lines 149..156
              src/decorators/GreekProsody.js on lines 158..165

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

              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