Sign upLogin

benjamine/jsondiffpatch

View on GitHub
Star

Showing 97 of 97 total issues

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

  format_node(
    context: ConsoleFormatterContext,
    delta: ObjectDelta | ArrayDelta,
    left: unknown,
  ) {
Severity: Minor
Found in packages/jsondiffpatch/src/formatters/console.ts and 1 other location - About 35 mins to fix
packages/jsondiffpatch/src/formatters/annotated.ts on lines 145..152

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

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_node(
    context: AnnotatedFormatterContext,
    delta: ObjectDelta | ArrayDelta,
    left: unknown,
  ) {
Severity: Minor
Found in packages/jsondiffpatch/src/formatters/annotated.ts and 1 other location - About 35 mins to fix
packages/jsondiffpatch/src/formatters/console.ts on lines 189..196

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

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

  prepareContext(context: Partial<AnnotatedFormatterContext>) {
    super.prepareContext(context);
    context.indent = function (levels) {
      this.indentLevel =
        (this.indentLevel || 0) + (typeof levels === 'undefined' ? 1 : levels);
Severity: Minor
Found in packages/jsondiffpatch/src/formatters/annotated.ts - About 35 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 collectChildrenPatchFilter has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

  function collectChildrenPatchFilter(context) {
    if (!context || !context.children) {
      return;
    }
    const deltaWithChildren = context.delta as ObjectDelta | ArrayDelta;
Severity: Minor
Found in packages/jsondiffpatch/src/filters/nested.ts - About 35 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 nodeEnd has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

  nodeEnd(
    context: ConsoleFormatterContext,
    key: string,
    leftKey: string | number,
    type: DeltaType,
Severity: Minor
Found in packages/jsondiffpatch/src/formatters/console.ts - About 35 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

Avoid too many return statements within this function.
Open

      return;
Severity: Major
Found in packages/jsondiffpatch/src/filters/trivial.ts - About 30 mins to fix

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

      append(...args: Filter<TContext>[]) {
    this.filters.push(...args);
    return this;
  }
    Severity: Minor
    Found in packages/jsondiffpatch/src/pipe.ts and 1 other location - About 30 mins to fix
    packages/jsondiffpatch/src/pipe.ts on lines 50..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 45.

    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

    Avoid too many return statements within this function.
    Open

          return;
    Severity: Major
    Found in packages/jsondiffpatch/src/filters/trivial.ts - About 30 mins to fix

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

        prepend(...args: Filter<TContext>[]) {
    this.filters.unshift(...args);
    return this;
  }
      Severity: Minor
      Found in packages/jsondiffpatch/src/pipe.ts and 1 other location - About 30 mins to fix
      packages/jsondiffpatch/src/pipe.ts on lines 45..48

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

      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

      Avoid too many return statements within this function.
      Open

            return;
      Severity: Major
      Found in packages/jsondiffpatch/src/filters/trivial.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return cloneRegExp(arg);
        Severity: Major
        Found in packages/jsondiffpatch/src/clone.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

            return cloned;
          Severity: Major
          Found in packages/jsondiffpatch/src/clone.ts - About 30 mins to fix

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

              text: function (el: HTMLElement, text: string) {
    if (typeof el.textContent !== 'undefined') {
      if (typeof text === 'undefined') {
        return el.textContent;
      }
            Severity: Minor
            Found in demos/html-demo/demo.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 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 collectChildrenReverseFilter has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

            export const collectChildrenReverseFilter: Filter<ReverseContext> = (
  context,
) => {
  if (!context || !context.children) {
    return;
            Severity: Minor
            Found in packages/jsondiffpatch/src/filters/nested.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

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

            export const diffFilter: Filter<DiffContext> = function textsDiffFilter(
  context,
) {
  if (context.leftType !== 'string') {
    return;
            Severity: Minor
            Found in packages/jsondiffpatch/src/filters/texts.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

            Severity
            Category
            Status
            Source
            Language