knsv/mermaid

View on GitHub
packages/mermaid/src/mermaidAPI.spec.ts

Summary

Maintainability
D
1 day
Test Coverage

File mermaidAPI.spec.ts has 633 lines of code (exceeds 250 allowed). Consider refactoring.
Open

'use strict';
import { vi } from 'vitest';

// -------------------------------------
//  Mocks and mocking
Severity: Major
Found in packages/mermaid/src/mermaidAPI.spec.ts - About 1 day to fix

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

        it('returns false for invalid definition with silent option', async () => {
          await expect(
            mermaidAPI.parse('this is not a mermaid diagram definition', { suppressErrors: true })
          ).resolves.toBe(false);
        });
    Severity: Minor
    Found in packages/mermaid/src/mermaidAPI.spec.ts and 1 other location - About 40 mins to fix
    packages/mermaid/src/mermaidAPI.spec.ts on lines 695..699

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

    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

        it('returns true for valid definition with silent option', async () => {
          await expect(
            mermaidAPI.parse('graph TD;A--x|text including URL space|B;', { suppressErrors: true })
          ).resolves.toBe(true);
        });
    Severity: Minor
    Found in packages/mermaid/src/mermaidAPI.spec.ts and 1 other location - About 40 mins to fix
    packages/mermaid/src/mermaidAPI.spec.ts on lines 685..689

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

    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

        it('does not throw for a valid definition', async () => {
          await expect(
            mermaidAPI.parse('graph TD;A--x|text including URL space|B;')
          ).resolves.not.toThrow();
        });
    Severity: Minor
    Found in packages/mermaid/src/mermaidAPI.spec.ts and 1 other location - About 30 mins to fix
    packages/mermaid/src/mermaid.spec.ts on lines 168..172

    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

    There are no issues that match your filters.

    Category
    Status