open-learning-exchange/planet

View on GitHub
chatapi/src/services/chat.service.ts

Summary

Maintainability
A
2 hrs
Test Coverage

Function chat has 34 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export async function chat(data: any, stream?: boolean, callback?: (response: string) => void): Promise<{
  completionText: string;
  couchSaveResponse: DocumentInsertResponse;
} | undefined> {
  const { content, ...dbData } = data;
Severity: Minor
Found in chatapi/src/services/chat.service.ts - About 1 hr to fix

    Function chat has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

    export async function chat(data: any, stream?: boolean, callback?: (response: string) => void): Promise<{
      completionText: string;
      couchSaveResponse: DocumentInsertResponse;
    } | undefined> {
      const { content, ...dbData } = data;
    Severity: Minor
    Found in chatapi/src/services/chat.service.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

    missing whitespace
    Open

      if(stream && aiProvider.name === 'gemini') {
    Severity: Minor
    Found in chatapi/src/services/chat.service.ts by tslint

    Rule: whitespace

    Enforces whitespace style conventions.

    Rationale

    Helps maintain a readable, consistent style in your codebase.

    Notes
    • Has Fix

    Config

    Several arguments may be optionally provided:

    • "check-branch" checks branching statements (if/else/for/while) are followed by whitespace.
    • "check-decl"checks that variable declarations have whitespace around the equals token.
    • "check-operator" checks for whitespace around operator tokens.
    • "check-module" checks for whitespace in import & export statements.
    • "check-separator" checks for whitespace after separator tokens (,/;).
    • "check-rest-spread" checks that there is no whitespace after rest/spread operator (...).
    • "check-type" checks for whitespace before a variable type specification.
    • "check-typecast" checks for whitespace between a typecast and its target.
    • "check-type-operator" checks for whitespace between type operators | and &.
    • "check-preblock" checks for whitespace before the opening brace of a block.
    • "check-postbrace" checks for whitespace after an opening brace.
    Examples
    "whitespace": true,check-branch,check-operator,check-typecast
    Schema
    {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "check-branch",
          "check-decl",
          "check-operator",
          "check-module",
          "check-separator",
          "check-rest-spread",
          "check-type",
          "check-typecast",
          "check-type-operator",
          "check-preblock",
          "check-postbrace"
        ]
      },
      "minLength": 0,
      "maxLength": 11
    }

    For more information see this page.

    There are no issues that match your filters.

    Category
    Status