Sign upLogin

jjmschofield/github-codeowners

View on GitHub
Star

Showing 13 of 36 total issues

Similar blocks of code found in 2 locations. Consider refactoring.
Open

commander.command('audit')
  .description('list the owners for all files')
  .option('-d, --dir <dirPath>', 'path to VCS directory', process.cwd())
  .option('-c, --codeowners <filePath>', 'path to codeowners file (default: "<dir>/.github/CODEOWNERS")')
  .option('-o, --output <outputFormat>', `how to output format eg: ${Object.values(OUTPUT_FORMAT).join(', ')}`, OUTPUT_FORMAT.SIMPLE)
Severity: Major
Found in src/cli.ts and 1 other location - About 4 hrs to fix
src/cli.ts on lines 44..64

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 129.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

commander.command('validate')
  .description('Validates a CODOWNER file and files in dir')
  .option('-d, --dir <dirPath>', 'path to VCS directory', process.cwd())
  .option('-c, --codeowners <filePath>', 'path to codeowners file (default: "<dir>/.github/CODEOWNERS")')
  .option('-r, --root <rootPath>', 'the root path to filter files by', '')
Severity: Major
Found in src/cli.ts and 1 other location - About 4 hrs to fix
src/cli.ts on lines 18..42

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 129.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

commander.command('git [shaA] [shaB]')
  .description('lists owners of files changed between commits, a commit against head or staged against head')
  .option('-d, --dir <dirPath>', 'path to VCS directory', process.cwd())
  .option('-c, --codeowners <filePath>', 'path to codeowners file (default: "<dir>/.github/CODEOWNERS")')
  .option('-o, --output <outputFormat>', `how to output format eg: ${Object.values(OUTPUT_FORMAT).join(', ')}`, OUTPUT_FORMAT.SIMPLE)
Severity: Major
Found in src/cli.ts and 1 other location - About 3 hrs to fix
src/cli.ts on lines 18..24

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 97.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Function calcFileStats has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

export const calcFileStats = (files: File[]): Stats => {
  const total: Counters = {
    files: 0,
    lines: 0,
  };
Severity: Minor
Found in src/lib/stats/stats.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

Function calcFileStats has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Confirmed

export const calcFileStats = (files: File[]): Stats => {
  const total: Counters = {
    files: 0,
    lines: 0,
  };
Severity: Minor
Found in src/lib/stats/stats.ts - About 1 hr to fix

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

    const walkDir = (root: string, dir: string, ignores: Ignore, files: string[] = []): string[] => {
  const newFiles = fs.readdirSync(path.resolve(root, dir));

  const newGitIgnore = newFiles.find(file => file === '.gitignore');
    Severity: Minor
    Found in src/lib/file/readDir.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 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

      Function writer has 28 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      export const writer = (stats: Stats, options: { output: OUTPUT_FORMAT }, stream: any) => {
  const orderedOwners = [...stats.owners].sort((a, b) => {
    if (a.owner < b.owner) return -1;
    if (a.owner > b.owner) return 1;
    return 0;
      Severity: Minor
      Found in src/lib/stats/writer.ts - About 1 hr to fix

        Function audit has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
        Open

        export const audit = async (options: AuditOptions) => {
  const strategy = options.onlyGit ? FILE_DISCOVERY_STRATEGY.GIT_LS : FILE_DISCOVERY_STRATEGY.FILE_SYSTEM;
  const filePaths = await getFilePaths(options.dir, strategy, options.root);

  const files = await getOwnership(options.codeowners, filePaths);
        Severity: Minor
        Found in src/commands/audit.ts - About 55 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

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

        const createMatcherCodeownersRule = (rule: string): FileOwnershipMatcher => {
  // Split apart on spaces
  const parts = rule.split(/\s+/);

  // The first part is expected to be the path
        Severity: Minor
        Found in src/lib/ownership/OwnershipEngine.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

        TODO found
        Open

          test_int: #TODO - multiple node envs
        Severity: Minor
        Found in .circleci/config.yml by fixme

        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
        Severity
        Category
        Status
        Source
        Language