Sign upLogin

jjmschofield/github-codeowners

View on GitHub
Star
src/lib/ownership/validate.ts

Summary

Maintainability
A
2 hrs
Test Coverage
F
0%

Function validate has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

export const validate = async (options: { codeowners: string, dir: string, root?: string }): Promise<ValidationResults> => {
  const engine = OwnershipEngine.FromCodeownersFile(options.codeowners); // Validates code owner file

  const filePaths = await readDir(options.dir, ['.git']);
Severity: Minor
Found in src/lib/ownership/validate.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 validate has 28 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const validate = async (options: { codeowners: string, dir: string, root?: string }): Promise<ValidationResults> => {
  const engine = OwnershipEngine.FromCodeownersFile(options.codeowners); // Validates code owner file

  const filePaths = await readDir(options.dir, ['.git']);
Severity: Minor
Found in src/lib/ownership/validate.ts - About 1 hr to fix

    TODO found
    Open

      for (const rule of unmatched) { // Where we have duplicates we get an edge condition where one version of the matcher doesn't get hit - TODO - there is no doubt a nicer way to express this
    Severity: Minor
    Found in src/lib/ownership/validate.ts by fixme

    There are no issues that match your filters.

    Category
    Status