polkadot-js/api

View on GitHub
packages/typegen/src/util/derived.ts

Summary

Maintainability
C
1 day
Test Coverage

Function getSimilarTypes has a Cognitive Complexity of 42 (exceeds 5 allowed). Consider refactoring.
Open

export function getSimilarTypes (registry: Registry, definitions: Record<string, ModuleTypes>, _type: string, imports: TypeImports): string[] {
  const typeParts = _type.split('::');
  const type = typeParts[typeParts.length - 1];
  const possibleTypes = [formatType(registry, definitions, type, imports)];

Severity: Minor
Found in packages/typegen/src/util/derived.ts - About 6 hrs 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 getSimilarTypes has 82 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function getSimilarTypes (registry: Registry, definitions: Record<string, ModuleTypes>, _type: string, imports: TypeImports): string[] {
  const typeParts = _type.split('::');
  const type = typeParts[typeParts.length - 1];
  const possibleTypes = [formatType(registry, definitions, type, imports)];

Severity: Major
Found in packages/typegen/src/util/derived.ts - About 3 hrs to fix

    Avoid deeply nested control flow statements.
    Open

        if (Array.isArray(subDef)) {
          const subs = subDef.map(({ type }) => getSimilarTypes(registry, definitions, type, imports).join(' | '));
    
          possibleTypes.push(`[${subs.join(', ')}]`);
        }
    Severity: Major
    Found in packages/typegen/src/util/derived.ts - About 45 mins to fix

      Avoid too many return statements within this function.
      Open

        return [...new Set(possibleTypes)];
      Severity: Major
      Found in packages/typegen/src/util/derived.ts - About 30 mins to fix

        There are no issues that match your filters.

        Category
        Status