AugurProject/augur-core

View on GitHub
source/libraries/ContractCompiler.ts

Summary

Maintainability
B
6 hrs
Test Coverage

Function filterCompilerOutput has a Cognitive Complexity of 22 (exceeds 5 allowed). Consider refactoring.
Open

    private filterCompilerOutput(compilerOutput: CompilerOutput): CompilerOutput {
        const result: CompilerOutput = { contracts: {} };
        for (let relativeFilePath in compilerOutput.contracts) {
            for (let contractName in compilerOutput.contracts[relativeFilePath]) {
                // don't include libraries
Severity: Minor
Found in source/libraries/ContractCompiler.ts - About 3 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

Function compileContracts has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring.
Open

    public async compileContracts(): Promise<CompilerOutput> {
        // Check if all contracts are cached (and thus do not need to be compiled)
        try {
            const stats = await fs.stat(this.configuration.contractOutputPath);
            const lastCompiledTimestamp = stats.mtime;
Severity: Minor
Found in source/libraries/ContractCompiler.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

Function compileContracts has 31 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public async compileContracts(): Promise<CompilerOutput> {
        // Check if all contracts are cached (and thus do not need to be compiled)
        try {
            const stats = await fs.stat(this.configuration.contractOutputPath);
            const lastCompiledTimestamp = stats.mtime;
Severity: Minor
Found in source/libraries/ContractCompiler.ts - About 1 hr to fix

    Function generateCompilerInput has 26 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

        public async generateCompilerInput(): Promise<CompilerInput> {
            const ignoreFile = function(file: string, stats: fs.Stats): boolean {
                return file.indexOf("legacy_reputation") > -1 || (stats.isFile() && path.extname(file) !== ".sol");
            }
            const filePaths = await recursiveReadDir(this.configuration.contractSourceRoot, [ignoreFile]);
    Severity: Minor
    Found in source/libraries/ContractCompiler.ts - About 1 hr to fix

      There are no issues that match your filters.

      Category
      Status