Sign upLogin

TryGhost/Ghost

View on GitHub
Star
apps/comments-ui/src/utils/helpers.ts

Summary

Maintainability
D
2 days
Test Coverage

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

export function formatRelativeTime(dateString: string, t: TranslationFunction): string {
    const date = new Date(dateString);
    const now = new Date();

    // Diff is in seconds
Severity: Minor
Found in apps/comments-ui/src/utils/helpers.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 formatRelativeTime has 53 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export function formatRelativeTime(dateString: string, t: TranslationFunction): string {
    const date = new Date(dateString);
    const now = new Date();

    // Diff is in seconds
Severity: Major
Found in apps/comments-ui/src/utils/helpers.ts - About 2 hrs to fix

    Function getScrollToPosition has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
    Open

    export const getScrollToPosition = (element: HTMLElement) => {
    let yOffset = 0;

    // Because we are working in an iframe, we need to resolve the position inside this iframe to the position in the top window
    // Get the window of the element, not the window (which is the top window)
    Severity: Minor
    Found in apps/comments-ui/src/utils/helpers.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

    Avoid deeply nested control flow statements.
    Open

                        if (frameElement.contentWindow === currentWindow) {
                        const rect = frameElement.getBoundingClientRect();
                        yOffset += rect.top + currentWindow.pageYOffset;
                    }
    Severity: Major
    Found in apps/comments-ui/src/utils/helpers.ts - About 45 mins to fix

      Avoid too many return statements within this function.
      Open

              return t('{{amount}} weeks ago', {amount: Math.floor(diff)});
      Severity: Major
      Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

                    return t(`One hour ago`);
        Severity: Major
        Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

                      return t(`One month ago`);
          Severity: Major
          Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

                    return t('{{amount}} months ago', {amount: Math.floor(diff)});
            Severity: Major
            Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                      return t('{{amount}} hours ago', {amount: Math.floor(diff)});
              Severity: Major
              Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

                Avoid too many return statements within this function.
                Open

                    return t('{{amount}} years ago', {amount: Math.floor(diff)});
                Severity: Major
                Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

                  Avoid too many return statements within this function.
                  Open

                              return t(`One week ago`);
                  Severity: Major
                  Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

                    Avoid too many return statements within this function.
                    Open

                            return t('{{amount}} days ago', {amount: Math.floor(diff)});
                    Severity: Major
                    Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

                      Avoid too many return statements within this function.
                      Open

                              return t(`One year ago`);
                      Severity: Major
                      Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

                        Avoid too many return statements within this function.
                        Open

                                return t('Yesterday');
                        Severity: Major
                        Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

                          Avoid too many return statements within this function.
                          Open

                                      return t(`One day ago`);
                          Severity: Major
                          Found in apps/comments-ui/src/utils/helpers.ts - About 30 mins to fix

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

                                if (diff < 7) {
        if (Math.floor(diff) === 1) {
            // Special case, we should compare based on dates in the future instead
            return t(`One day ago`);
        }
                            Severity: Major
                            Found in apps/comments-ui/src/utils/helpers.ts and 2 other locations - About 1 hr to fix
                            apps/comments-ui/src/utils/helpers.ts on lines 63..69
                            apps/comments-ui/src/utils/helpers.ts on lines 73..79

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

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

                                if (diff < 12) {
        if (Math.floor(diff) === 1) {
            // Special case, we should compare based on dates in the future instead
            return t(`One month ago`);
        }
                            Severity: Major
                            Found in apps/comments-ui/src/utils/helpers.ts and 2 other locations - About 1 hr to fix
                            apps/comments-ui/src/utils/helpers.ts on lines 53..59
                            apps/comments-ui/src/utils/helpers.ts on lines 63..69

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

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

                                if (diff < 4) {
        if (Math.floor(diff) === 1) {
            // Special case, we should compare based on dates in the future instead
            return t(`One week ago`);
        }
                            Severity: Major
                            Found in apps/comments-ui/src/utils/helpers.ts and 2 other locations - About 1 hr to fix
                            apps/comments-ui/src/utils/helpers.ts on lines 53..59
                            apps/comments-ui/src/utils/helpers.ts on lines 73..79

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

                            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

                                if (diff < 60) {
        if (Math.floor(diff) === 1) {
            return t(`One minute ago`);
        }
        return t('{{amount}} minutes ago', {amount: Math.floor(diff)});
                            Severity: Major
                            Found in apps/comments-ui/src/utils/helpers.ts and 1 other location - About 1 hr to fix
                            apps/comments-ui/src/utils/helpers.ts on lines 44..49

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

                            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

                                if (diff < 24) {
        if (Math.floor(diff) === 1) {
            return t(`One hour ago`);
        }
        return t('{{amount}} hours ago', {amount: Math.floor(diff)});
                            Severity: Major
                            Found in apps/comments-ui/src/utils/helpers.ts and 1 other location - About 1 hr to fix
                            apps/comments-ui/src/utils/helpers.ts on lines 28..33

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

                            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