bowtie-co/ts-github

View on GitHub
src/Github/Client.ts

Summary

Maintainability
D
1 day
Test Coverage

GithubClient has 21 functions (exceeds 20 allowed). Consider refactoring.
Open

export class GithubClient implements IGithubClient {
  public octokit: Octokit;

  constructor(props: IGithubProps) {
    this.auth(props.token);
Severity: Minor
Found in src/Github/Client.ts - About 2 hrs to fix

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

      public async sumStatuses(params?: IGithubStatusSummaryParams): Promise<IGithubCommitStatusSummary> {
        const result: IGithubCommitStatusSummary = {};
        const statuses: IGithubCommitStatus[] = await this.statuses(params);
    
        for (const group in GithubCommitStatusGroup) {
    Severity: Minor
    Found in src/Github/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

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

      public async pull(params?: IGithubRepoPullParams): Promise<IGithubPull> {
        return await (await this.octokit.pulls.get(params)).data;
      }
    Severity: Major
    Found in src/Github/Client.ts and 5 other locations - About 55 mins to fix
    src/Github/Client.ts on lines 146..148
    src/Github/Client.ts on lines 153..155
    src/Github/Client.ts on lines 157..159
    src/Github/Client.ts on lines 169..171
    src/Github/Client.ts on lines 173..175

    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 54.

    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 6 locations. Consider refactoring.
    Open

      public async createOrUpdateFile(params?: IGithubCreateOrUpdateFileParams): Promise<IGithubCommitResponse> {
        return await (await this.octokit.repos.createOrUpdateFile(params)).data;
      }
    Severity: Major
    Found in src/Github/Client.ts and 5 other locations - About 55 mins to fix
    src/Github/Client.ts on lines 146..148
    src/Github/Client.ts on lines 150..152
    src/Github/Client.ts on lines 153..155
    src/Github/Client.ts on lines 157..159
    src/Github/Client.ts on lines 173..175

    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 54.

    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 6 locations. Consider refactoring.
    Open

      public async deleteFile(params?: IGithubDeleteFileParams): Promise<IGithubCommitResponse> {
        return await (await this.octokit.repos.deleteFile(params)).data;
      }
    Severity: Major
    Found in src/Github/Client.ts and 5 other locations - About 55 mins to fix
    src/Github/Client.ts on lines 146..148
    src/Github/Client.ts on lines 150..152
    src/Github/Client.ts on lines 153..155
    src/Github/Client.ts on lines 157..159
    src/Github/Client.ts on lines 169..171

    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 54.

    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 6 locations. Consider refactoring.
    Open

      public async issue(params?: IGithubRepoIssueParams): Promise<IGithubIssue> {
        return await (await this.octokit.issues.get(params)).data;
      }
    Severity: Major
    Found in src/Github/Client.ts and 5 other locations - About 55 mins to fix
    src/Github/Client.ts on lines 146..148
    src/Github/Client.ts on lines 150..152
    src/Github/Client.ts on lines 157..159
    src/Github/Client.ts on lines 169..171
    src/Github/Client.ts on lines 173..175

    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 54.

    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 6 locations. Consider refactoring.
    Open

      public async branch(params?: IGithubRepoBranchParams): Promise<IGithubBranch> {
        return await (await this.octokit.repos.getBranch(params)).data;
      }
    Severity: Major
    Found in src/Github/Client.ts and 5 other locations - About 55 mins to fix
    src/Github/Client.ts on lines 146..148
    src/Github/Client.ts on lines 150..152
    src/Github/Client.ts on lines 153..155
    src/Github/Client.ts on lines 169..171
    src/Github/Client.ts on lines 173..175

    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 54.

    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 6 locations. Consider refactoring.
    Open

      public async repo(params?: IGithubRepoParams): Promise<IGithubRepo> {
        return await (await this.octokit.repos.get(params)).data;
      }
    Severity: Major
    Found in src/Github/Client.ts and 5 other locations - About 55 mins to fix
    src/Github/Client.ts on lines 150..152
    src/Github/Client.ts on lines 153..155
    src/Github/Client.ts on lines 157..159
    src/Github/Client.ts on lines 169..171
    src/Github/Client.ts on lines 173..175

    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 54.

    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 7 locations. Consider refactoring.
    Open

      public async pulls(params?: IGithubRepoParams): Promise<IGithubPull[]> {
        return await this.octokit.paginate('GET /repos/:owner/:repo/pulls', params || {});
      }
    Severity: Major
    Found in src/Github/Client.ts and 6 other locations - About 50 mins to fix
    src/Github/Client.ts on lines 122..124
    src/Github/Client.ts on lines 126..128
    src/Github/Client.ts on lines 130..132
    src/Github/Client.ts on lines 134..136
    src/Github/Client.ts on lines 138..140
    src/Github/Client.ts on lines 142..144

    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 52.

    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 7 locations. Consider refactoring.
    Open

      public async contributors(params?: IGithubRepoParams): Promise<IGithubUser[]> {
        return await this.octokit.paginate('GET /repos/:owner/:repo/contributors', params || {});
      }
    Severity: Major
    Found in src/Github/Client.ts and 6 other locations - About 50 mins to fix
    src/Github/Client.ts on lines 118..120
    src/Github/Client.ts on lines 122..124
    src/Github/Client.ts on lines 126..128
    src/Github/Client.ts on lines 130..132
    src/Github/Client.ts on lines 138..140
    src/Github/Client.ts on lines 142..144

    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 52.

    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 7 locations. Consider refactoring.
    Open

      public async branches(params?: IGithubRepoParams): Promise<IGithubBranch[]> {
        return await this.octokit.paginate('GET /repos/:owner/:repo/branches', params || {});
      }
    Severity: Major
    Found in src/Github/Client.ts and 6 other locations - About 50 mins to fix
    src/Github/Client.ts on lines 118..120
    src/Github/Client.ts on lines 122..124
    src/Github/Client.ts on lines 130..132
    src/Github/Client.ts on lines 134..136
    src/Github/Client.ts on lines 138..140
    src/Github/Client.ts on lines 142..144

    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 52.

    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 7 locations. Consider refactoring.
    Open

      public async collaborators(params?: IGithubRepoParams): Promise<IGithubUser[]> {
        return await this.octokit.paginate('GET /repos/:owner/:repo/collaborators', params || {});
      }
    Severity: Major
    Found in src/Github/Client.ts and 6 other locations - About 50 mins to fix
    src/Github/Client.ts on lines 118..120
    src/Github/Client.ts on lines 122..124
    src/Github/Client.ts on lines 126..128
    src/Github/Client.ts on lines 134..136
    src/Github/Client.ts on lines 138..140
    src/Github/Client.ts on lines 142..144

    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 52.

    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 7 locations. Consider refactoring.
    Open

      public async blockedUsers(params?: IGithubOrgParams): Promise<IGithubUser[]> {
        return await this.octokit.paginate('GET /orgs/:org/blocks', params || {});
      }
    Severity: Major
    Found in src/Github/Client.ts and 6 other locations - About 50 mins to fix
    src/Github/Client.ts on lines 118..120
    src/Github/Client.ts on lines 122..124
    src/Github/Client.ts on lines 126..128
    src/Github/Client.ts on lines 130..132
    src/Github/Client.ts on lines 134..136
    src/Github/Client.ts on lines 142..144

    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 52.

    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 7 locations. Consider refactoring.
    Open

      public async orgMembers(params?: IGithubOrgParams): Promise<IGithubUser[]> {
        return await this.octokit.paginate('GET /orgs/:org/members', params || {});
      }
    Severity: Major
    Found in src/Github/Client.ts and 6 other locations - About 50 mins to fix
    src/Github/Client.ts on lines 118..120
    src/Github/Client.ts on lines 122..124
    src/Github/Client.ts on lines 126..128
    src/Github/Client.ts on lines 130..132
    src/Github/Client.ts on lines 134..136
    src/Github/Client.ts on lines 138..140

    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 52.

    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 7 locations. Consider refactoring.
    Open

      public async issues(params?: IGithubRepoParams): Promise<IGithubIssue[]> {
        return await this.octokit.paginate('GET /repos/:owner/:repo/issues', params || {});
      }
    Severity: Major
    Found in src/Github/Client.ts and 6 other locations - About 50 mins to fix
    src/Github/Client.ts on lines 118..120
    src/Github/Client.ts on lines 126..128
    src/Github/Client.ts on lines 130..132
    src/Github/Client.ts on lines 134..136
    src/Github/Client.ts on lines 138..140
    src/Github/Client.ts on lines 142..144

    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 52.

    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

    There are no issues that match your filters.

    Category
    Status