Sign upLogin

j3lte/pastebin-ts

View on GitHub
Star

Showing 15 of 15 total issues

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

export const postRequest = (path: string = '', params?: {}) => new Promise<string>(async (resolve: Function, reject: Function) => {
    const options: RequestPromiseOptions = getOptions('POST', params);

    if (path === '') {
        return reject(new Error('No path provided!'));
Severity: Major
Found in src/methods/post.ts and 1 other location - About 1 day to fix
src/methods/get.ts on lines 9..30

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

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

export const getRequest = (path: string = '', params?: {}) => new Promise<string>(async (resolve: Function, reject: Function) => {
    const options: RequestPromiseOptions = getOptions('GET', params);

    if (path === '') {
        return reject(new Error('No path provided!'));
Severity: Major
Found in src/methods/get.ts and 1 other location - About 1 day to fix
src/methods/post.ts on lines 9..30

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

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

File api.ts has 300 lines of code (exceeds 250 allowed). Consider refactoring.
Open

import {
    ICreatePasteFileOptions,
    ICreatePasteTextOptions,
    IPasteAPIOptions,
    IPastebinOptions,
Severity: Minor
Found in src/api.ts - About 3 hrs to fix

    Function createPaste has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring.
    Open

        public async createPaste(options: ICreatePasteTextOptions): Promise<{}> {
        if (!this.hasDevKey()) {
            return Promise.reject(new Error('Dev key needed!'));
        }
        if (typeof options === 'undefined') {
    Severity: Minor
    Found in src/api.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

    File config.ts has 275 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    import { IPastebinOptions } from './interfaces';

export const defaultOptions: IPastebinOptions = {
    api_dev_key: null,
    api_user_key: null,
    Severity: Minor
    Found in src/config.ts - About 2 hrs to fix

      Function createPaste has 61 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          public async createPaste(options: ICreatePasteTextOptions): Promise<{}> {
        if (!this.hasDevKey()) {
            return Promise.reject(new Error('Dev key needed!'));
        }
        if (typeof options === 'undefined') {
      Severity: Major
      Found in src/api.ts - About 2 hrs to fix

        Function handleResponse has a Cognitive Complexity of 12 (exceeds 5 allowed). Consider refactoring.
        Open

        const handleResponse = (response: Response, resolve: Function, reject: Function): void => {
    if (response === null || response === undefined) {
        reject(new Error('No response!'));
    } else {
        const {statusCode, body} = response;
        Severity: Minor
        Found in src/methods/lib.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 createAPIuserKey has 30 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private createAPIuserKey(): Promise<void> {
        const inValid = this.validateConfig(
            'api_dev_key',
            'api_user_name',
            'api_user_password',
        Severity: Minor
        Found in src/api.ts - About 1 hr to fix

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

          export const getRequest = (path: string = '', params?: {}) => new Promise<string>(async (resolve: Function, reject: Function) => {
    const options: RequestPromiseOptions = getOptions('GET', params);

    if (path === '') {
        return reject(new Error('No path provided!'));
          Severity: Minor
          Found in src/methods/get.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

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

          export const postRequest = (path: string = '', params?: {}) => new Promise<string>(async (resolve: Function, reject: Function) => {
    const options: RequestPromiseOptions = getOptions('POST', params);

    if (path === '') {
        return reject(new Error('No path provided!'));
          Severity: Minor
          Found in src/methods/post.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

          Avoid too many return statements within this function.
          Open

                      return Promise.reject(new Error('Paste cannot have empty content'));
          Severity: Major
          Found in src/api.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                            return Promise.reject(error);
            Severity: Major
            Found in src/api.ts - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                              return Promise.reject(
                    new Error(`Expiration format '${expiration}' is unknown!`),
                );
              Severity: Major
              Found in src/api.ts - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                                return Promise.reject(
                    new Error(`Paste format ${options.format} is unknown!`),
                );
                Severity: Major
                Found in src/api.ts - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                          return this.postApi(ENDPOINTS.POST, params);
                  Severity: Major
                  Found in src/api.ts - About 30 mins to fix
                    Severity
                    Category
                    Status
                    Source
                    Language