graycoreio/daffodil

View on GitHub
tools/dgeni/src/processors/breadcrumb.ts

Summary

Maintainability
B
5 hrs
Test Coverage

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

  private getBreadcrumbs(doc: ParentedDocument & KindedDocument): Array<DaffBreadcrumb> {
    const segments = (<string>doc.path).split('/');
    const breadcrumbs = segments
      .map((segment, i) => getStaticBreadcrumb(segment, segments.slice(0, i).join('/')))
      .filter((b, i, ary) => !!b && ary.findIndex((e) => e?.label === b.label) === i);
Severity: Major
Found in tools/dgeni/src/processors/breadcrumb.ts - About 2 hrs to fix

    Function getStaticBreadcrumb has 44 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    const getStaticBreadcrumb = (segment: string, parent: string): DaffBreadcrumb => {
      switch (segment) {
        case DAFF_DOCS_PATH:
          return {
            label: 'Docs',
    Severity: Minor
    Found in tools/dgeni/src/processors/breadcrumb.ts - About 1 hr to fix

      Function getBreadcrumbs has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
      Open

        private getBreadcrumbs(doc: ParentedDocument & KindedDocument): Array<DaffBreadcrumb> {
          const segments = (<string>doc.path).split('/');
          const breadcrumbs = segments
            .map((segment, i) => getStaticBreadcrumb(segment, segments.slice(0, i).join('/')))
            .filter((b, i, ary) => !!b && ary.findIndex((e) => e?.label === b.label) === i);
      Severity: Minor
      Found in tools/dgeni/src/processors/breadcrumb.ts - About 1 hr 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

      There are no issues that match your filters.

      Category
      Status