ChFlick/firecode

View on GitHub

Showing 6 of 10 total issues

File typeDocumentation.ts has 311 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import { CompletionItemKind, MarkdownString } from "vscode";
import { Documentation } from "./types";

// Mostly extracted from https://firebase.google.com/docs/reference/rules/index-all
export const typeDoc: Readonly<Documentation> = {
Severity: Minor
Found in src/documentation/typeDocumentation.ts - About 3 hrs to fix

    Function provideDocumentFormattingEdits has 43 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        async provideDocumentFormattingEdits(document: TextDocument, options: FormattingOptions): Promise<TextEdit[]> {
            if (workspace.getConfiguration("firestorerules").get("usePrettierFormatter") || false) {
                const text = document.getText();
    
                const formattedText = prettier.format(text, {
    Severity: Minor
    Found in src/providers/FirestoreFormattingProvider.ts - About 1 hr to fix

      Function getDocForToken has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

      export const getDocForToken = (token: string, markedWord: string): string | MarkdownString => {
          if (isInvalidToken(token)) {
              return '';
          }
      
      
      Severity: Minor
      Found in src/Documentation.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 flatten has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
      Open

      const flatten = (documentation: Documentation, staticValue = false): FlatDoc => {
          let flatDoc: FlatDoc = {};
          for (const key of Object.keys(documentation)) {
              // With duplicate keys append content
              if (flatDoc[key]) {
      Severity: Minor
      Found in src/Documentation.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 positionRangeDeltaTranslate has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

      function positionRangeDeltaTranslate(pos: vscode.Position, delta: RangeDelta): vscode.Position {
        if (delta.end.line === pos.line) {
          let x = pos.character + delta.endCharactersDelta;
          if (delta.linesDelta > 0) {
            x = x - delta.end.character;
      Severity: Minor
      Found in src/utils/textmate/text-util.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 positionAt has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
      Open

      function positionAt(text: string, offset: number): vscode.Position {
        if (offset > text.length) { offset = text.length; }
        let line = 0;
        let lastIndex = 0;
        // eslint-disable-next-line no-constant-condition
      Severity: Minor
      Found in src/utils/textmate/text-util.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