ElectronicBabylonianLiterature/ebl-frontend

View on GitHub
src/fragmentarium/ui/fragment/WordExport.tsx

Summary

Maintainability
C
1 day
Test Coverage
A
100%

Function getMainTableWithFootnotes has 64 lines of code (exceeds 25 allowed). Consider refactoring.
Open

function getMainTableWithFootnotes(
  table: JQuery,
  footNotesLines: Paragraph[],
  jQueryRef: JQuery
): { table: Array<Table | Paragraph>; footNotes: Paragraph[] } {
Severity: Major
Found in src/fragmentarium/ui/fragment/WordExport.tsx - About 2 hrs to fix

    Function wordExport has 37 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    export async function wordExport(
      fragment: Fragment,
      wordService: WordService,
      jQueryRef: JQuery
    ): Promise<Document> {
    Severity: Minor
    Found in src/fragmentarium/ui/fragment/WordExport.tsx - About 1 hr to fix

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

        const tableHtml: JQuery = $(
          renderToString(
            <MemoryRouter>
              <DictionaryContext.Provider value={wordService}>
                <TransliterationLines text={fragment.text} />
      Severity: Major
      Found in src/fragmentarium/ui/fragment/WordExport.tsx and 1 other location - About 2 hrs to fix
      src/fragmentarium/ui/fragment/PdfExport.tsx on lines 29..37

      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

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

        const notesHtml: JQuery = $(
          renderToString(
            <DictionaryContext.Provider value={wordService}>
              <TransliterationNotes notes={fragment.text.notes} />
            </DictionaryContext.Provider>
      Severity: Major
      Found in src/fragmentarium/ui/fragment/WordExport.tsx and 1 other location - About 1 hr to fix
      src/fragmentarium/ui/fragment/PdfExport.tsx on lines 38..44

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

      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

        const glossaryJsx: JSX.Element = await glossaryFactory
          .createGlossary(fragment.text)
          .then((glossaryData) => {
            return Glossary({ data: glossaryData })
          })
      Severity: Major
      Found in src/fragmentarium/ui/fragment/WordExport.tsx and 1 other location - About 1 hr to fix
      src/fragmentarium/ui/fragment/PdfExport.tsx on lines 104..108

      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

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

        const glossaryHtml: JQuery = $(
          renderToString(
            wrapWithMemoryRouter(
              <DictionaryContext.Provider value={wordService}>
                {glossaryJsx}
      Severity: Major
      Found in src/fragmentarium/ui/fragment/WordExport.tsx and 1 other location - About 1 hr to fix
      src/fragmentarium/ui/fragment/PdfExport.tsx on lines 110..118

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

      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