leonitousconforti/tinyburg

View on GitHub
packages/nucleus/src/parsing-structs/load-from-version.ts

Summary

Maintainability
B
6 hrs
Test Coverage

Function loadFromVersion has 94 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const loadFromVersion = async (version: string, force = false, log: ILogger = debug): Promise<IStructs> => {
    log.debug("Attempting to load structs for version: %s", version);

    // Filter the folders in this directory for ones that match the version
    const folders = await fs.readdir(new URL(".", import.meta.url), { withFileTypes: true });
Severity: Major
Found in packages/nucleus/src/parsing-structs/load-from-version.ts - About 3 hrs to fix

    Function loadFromVersion has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

    export const loadFromVersion = async (version: string, force = false, log: ILogger = debug): Promise<IStructs> => {
        log.debug("Attempting to load structs for version: %s", version);
    
        // Filter the folders in this directory for ones that match the version
        const folders = await fs.readdir(new URL(".", import.meta.url), { withFileTypes: true });
    Severity: Minor
    Found in packages/nucleus/src/parsing-structs/load-from-version.ts - About 2 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

    Avoid too many return statements within this function.
    Open

        return {
            bitbookPostBlocks: bitbookPostBlocks,
            bitizenBlocks: bitizenBlocks,
            blocks: blocks,
            floorBlocks: floorBlocks,
    Severity: Major
    Found in packages/nucleus/src/parsing-structs/load-from-version.ts - About 30 mins to fix

      There are no issues that match your filters.

      Category
      Status