ErnestMazurin/object-diff-ast

View on GitHub

Showing 9 of 15 total issues

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

    {
      key: 'chdObj',
      type: 'unit',
      unit: 'object',
      level: 1,
Severity: Major
Found in __tests__/getDiff.test.ts and 1 other location - About 4 hrs to fix
__tests__/renderers.test.ts on lines 44..76

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

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

  {
    key: 'chdObj',
    type: 'unit',
    unit: 'object',
    level: 1,
Severity: Major
Found in __tests__/renderers.test.ts and 1 other location - About 4 hrs to fix
__tests__/getDiff.test.ts on lines 93..125

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

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

File getDiff.test.ts has 341 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { getDiff, JSONArray, JSONObject, Node } from '../src';

test('getDiff: common tests', () => {
  const before = {
    unchd: 'val1',
Severity: Minor
Found in __tests__/getDiff.test.ts - About 4 hrs to fix

    File renderers.test.ts has 285 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    import { render, Node } from '../src';
    
    const diffObject: Node[] = [
      {
        key: 'unchd',
    Severity: Minor
    Found in __tests__/renderers.test.ts - About 2 hrs to fix

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

          {
            key: 'chdArr',
            type: 'unit',
            unit: 'array',
            level: 1,
      Severity: Major
      Found in __tests__/getDiff.test.ts and 1 other location - About 2 hrs to fix
      __tests__/renderers.test.ts on lines 23..43

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

      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

        {
          key: 'chdArr',
          type: 'unit',
          unit: 'array',
          level: 1,
      Severity: Major
      Found in __tests__/renderers.test.ts and 1 other location - About 2 hrs to fix
      __tests__/getDiff.test.ts on lines 72..92

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

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

      const toString = (key: string, value: JSONValue, gap: string, prefix: string): string => {
        if (isArray(value) && value.length === 0) {
          return `${gap}${prefix} ${key}: []\n`;
        }
        if (isObject(value) && keys(value).length === 0) {
      Severity: Minor
      Found in src/renderers/complex.ts - About 45 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 { key, level, type: 'unchanged', oldValue: value1 };
      Severity: Major
      Found in src/getDiff.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

          return node.children
            .map((item) => makeText(item, `${parentKey}${node.key}.`))
            .filter((x) => x !== '')
            .join('\n');
        Severity: Major
        Found in src/renderers/plain.ts - About 30 mins to fix
          Severity
          Category
          Status
          Source
          Language