ActivityWatch/aw-client-js

View on GitHub

Showing 5 of 7 total issues

File aw-client.ts has 449 lines of code (exceeds 250 allowed). Consider refactoring.
Open

export class FetchError extends Error {
    response: Response;
    constructor(res: Response) {
        super(`Failed fetch with status code ${res.status}`);
        this.response = res;
Severity: Minor
Found in src/aw-client.ts - About 6 hrs to fix

    Function query has a Cognitive Complexity of 28 (exceeds 5 allowed). Consider refactoring.
    Open

        public async query(
            timeperiods: (string | { start: Date; end: Date })[],
            query: string[],
            params: {
                cache?: boolean;
    Severity: Minor
    Found in src/aw-client.ts - About 4 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

    AWClient has 28 functions (exceeds 20 allowed). Consider refactoring.
    Open

    export class AWClient {
        public clientname: string;
        public baseURL: string;
        public apiURL: string;
        public timeout: number;
    Severity: Minor
    Found in src/aw-client.ts - About 3 hrs to fix

      Function query has 81 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public async query(
              timeperiods: (string | { start: Date; end: Date })[],
              query: string[],
              params: {
                  cache?: boolean;
      Severity: Major
      Found in src/aw-client.ts - About 3 hrs to fix

        Function constructor has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
        Open

            constructor(clientname: string, options: AWReqOptions = {}) {
                this.clientname = clientname;
                this.testing = options.testing ?? false;
                this.timeout = options.timeout ?? 30000;
                if (typeof options.baseURL === "undefined") {
        Severity: Minor
        Found in src/aw-client.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