Sign upLogin

synapsecns/sanguine

View on GitHub
Star
packages/explorer-ui/utils/formatAmount.ts

Summary

Maintainability
C
1 day
Test Coverage

Function formatAmount has 53 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const formatAmount = (
  amount: string,
  options?: FormatOptions
): string => {
  if (amount === '') {
Severity: Major
Found in packages/explorer-ui/utils/formatAmount.ts - About 2 hrs to fix

    Function formatAmount has a Cognitive Complexity of 14 (exceeds 5 allowed). Consider refactoring.
    Open

    export const formatAmount = (
  amount: string,
  options?: FormatOptions
): string => {
  if (amount === '') {
    Severity: Minor
    Found in packages/explorer-ui/utils/formatAmount.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

    Avoid too many return statements within this function.
    Open

        return Intl.NumberFormat(locales, {
      minimumFractionDigits: standardDigits,
    }).format(floatAmount)
    Severity: Major
    Found in packages/explorer-ui/utils/formatAmount.ts - About 30 mins to fix

      Avoid too many return statements within this function.
      Open

          return Intl.NumberFormat(locales, {
      minimumSignificantDigits: standardDigits,
      maximumSignificantDigits: standardDigits,
    }).format(floatAmount)
      Severity: Major
      Found in packages/explorer-ui/utils/formatAmount.ts - About 30 mins to fix

        Avoid too many return statements within this function.
        Open

            return `< ${minimumAmount}`
        Severity: Major
        Found in packages/explorer-ui/utils/formatAmount.ts - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

              return Intl.NumberFormat(locales, {
      maximumFractionDigits: 0,
    }).format(floatAmount)
          Severity: Major
          Found in packages/explorer-ui/utils/formatAmount.ts - About 30 mins to fix

            Avoid too many return statements within this function.
            Open

              return Intl.NumberFormat(locales, {
    minimumFractionDigits: compactDigits,
    maximumFractionDigits: compactDigits,
    notation: useCompactNotation ? 'compact' : 'standard',
  }).format(floatAmount)
            Severity: Major
            Found in packages/explorer-ui/utils/formatAmount.ts - About 30 mins to fix

              Avoid too many return statements within this function.
              Open

                  return Intl.NumberFormat(locales, {
      maximumSignificantDigits: 1,
    }).format(floatAmount)
              Severity: Major
              Found in packages/explorer-ui/utils/formatAmount.ts - About 30 mins to fix

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

                  try {
    if (!Number.isFinite(floatAmount)) {
      throw new TypeError(`"${amount}" is not a finite number`)
    }
  } catch ({ name, message }) {
                Severity: Major
                Found in packages/explorer-ui/utils/formatAmount.ts and 1 other location - About 1 hr to fix
                packages/synapse-interface/utils/formatAmount.ts on lines 18..25

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

                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

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

                interface FormatOptions {
  fullAmount?: boolean
  standardDigits?: number
  useCompactNotation?: boolean
  compactDigits?: number
                Severity: Minor
                Found in packages/explorer-ui/utils/formatAmount.ts and 1 other location - About 40 mins to fix
                packages/synapse-interface/utils/formatAmount.ts on lines 1..8

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

                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