Sign upLogin

benjamine/jsondiffpatch

View on GitHub
Star
packages/jsondiffpatch/src/formatters/html.ts

Summary

Maintainability
D
2 days
Test Coverage

File html.ts has 315 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import BaseFormatter from './base.js';
import type { BaseFormatterContext, DeltaType, NodeType } from './base.js';
import type {
  AddedDelta,
  ArrayDelta,
Severity: Minor
Found in packages/jsondiffpatch/src/formatters/html.ts - About 3 hrs to fix

    Function jsondiffpatchHtmlFormatterAdjustArrows has 56 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    const adjustArrows = function jsondiffpatchHtmlFormatterAdjustArrows(
  nodeArg?: Element,
) {
  const node = nodeArg || document;
  const getElementText = ({ textContent, innerText }: HTMLDivElement) =>
    Severity: Major
    Found in packages/jsondiffpatch/src/formatters/html.ts - About 2 hrs to fix

      Function showUnchanged has 51 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export const showUnchanged = (
  show?: boolean,
  node?: Element | null,
  delay?: number,
) => {
      Severity: Major
      Found in packages/jsondiffpatch/src/formatters/html.ts - About 2 hrs to fix

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

        export const showUnchanged = (
  show?: boolean,
  node?: Element | null,
  delay?: number,
) => {
        Severity: Minor
        Found in packages/jsondiffpatch/src/formatters/html.ts - 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

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

        const adjustArrows = function jsondiffpatchHtmlFormatterAdjustArrows(
  nodeArg?: Element,
) {
  const node = nodeArg || document;
  const getElementText = ({ textContent, innerText }: HTMLDivElement) =>
        Severity: Minor
        Found in packages/jsondiffpatch/src/formatters/html.ts - 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

          format_movedestination(
    context: HtmlFormatterContext,
    delta: undefined,
    left: unknown,
  ) {
        Severity: Major
        Found in packages/jsondiffpatch/src/formatters/html.ts and 1 other location - About 1 hr to fix
        packages/jsondiffpatch/src/formatters/html.ts on lines 97..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 73.

        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

          format_unchanged(
    context: HtmlFormatterContext,
    delta: undefined,
    left: unknown,
  ) {
        Severity: Major
        Found in packages/jsondiffpatch/src/formatters/html.ts and 1 other location - About 1 hr to fix
        packages/jsondiffpatch/src/formatters/html.ts on lines 110..121

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

        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

          format_added(context: HtmlFormatterContext, delta: AddedDelta) {
    context.out('<div class="jsondiffpatch-value">');
    this.formatValue(context, delta[0]);
    context.out('</div>');
  }
        Severity: Major
        Found in packages/jsondiffpatch/src/formatters/html.ts and 2 other locations - About 1 hr to fix
        packages/jsondiffpatch/src/formatters/html.ts on lines 153..157
        packages/jsondiffpatch/src/formatters/html.ts on lines 190..194

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

        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

          format_deleted(context: HtmlFormatterContext, delta: DeletedDelta) {
    context.out('<div class="jsondiffpatch-value">');
    this.formatValue(context, delta[0]);
    context.out('</div>');
  }
        Severity: Major
        Found in packages/jsondiffpatch/src/formatters/html.ts and 2 other locations - About 1 hr to fix
        packages/jsondiffpatch/src/formatters/html.ts on lines 137..141
        packages/jsondiffpatch/src/formatters/html.ts on lines 190..194

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

        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

          format_textdiff(context: HtmlFormatterContext, delta: TextDiffDelta) {
    context.out('<div class="jsondiffpatch-value">');
    this.formatTextDiffString(context, delta[0]);
    context.out('</div>');
  }
        Severity: Major
        Found in packages/jsondiffpatch/src/formatters/html.ts and 2 other locations - About 1 hr to fix
        packages/jsondiffpatch/src/formatters/html.ts on lines 137..141
        packages/jsondiffpatch/src/formatters/html.ts on lines 153..157

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

        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

        export function format(delta: Delta, left?: unknown) {
  if (!defaultInstance) {
    defaultInstance = new HtmlFormatter();
  }
  return defaultInstance.format(delta, left);
        Severity: Minor
        Found in packages/jsondiffpatch/src/formatters/html.ts and 1 other location - About 55 mins to fix
        packages/jsondiffpatch/src/formatters/annotated.ts on lines 302..307

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

        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