FarmBot/Farmbot-Web-App

View on GitHub
public/app-resources/languages/_helper.ts

Summary

Maintainability
C
1 day
Test Coverage

Function createOrUpdateTranslationFile has 101 lines of code (exceeds 25 allowed). Consider refactoring.
Open

  export function createOrUpdateTranslationFile(
    langInput: string | undefined = "en",
    metricsOnly?: boolean,
  ): SummaryData | undefined {
    const lang = langInput.slice(0, 2);
Severity: Major
Found in public/app-resources/languages/_helper.ts - About 4 hrs to fix

    File _helper.ts has 297 lines of code (exceeds 250 allowed). Consider refactoring.
    Open

    /**
     *
     * Web App translation file helper
     *   This script gathers translatable phrases from the web app and adds them
     *   to translation files. It also organizes and sorts existing translation
    Severity: Minor
    Found in public/app-resources/languages/_helper.ts - About 3 hrs to fix

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

        export function createOrUpdateTranslationFile(
          langInput: string | undefined = "en",
          metricsOnly?: boolean,
        ): SummaryData | undefined {
          const lang = langInput.slice(0, 2);
      Severity: Minor
      Found in public/app-resources/languages/_helper.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 generateMetrics has 52 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      function generateMetrics() {
        const languageCodes = walkSync(__dirname, [], [".json"])
          .filter(s => !s.includes("metrics.json"))
          .filter(s => !s.includes("en.json"))
          .map(s => s.slice(-"en.json".length, -".json".length));
      Severity: Major
      Found in public/app-resources/languages/_helper.ts - About 2 hrs to fix

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

                  Object.entries(jsonParsed.other_translations || [])
                    .map(([other_key, other_value]) => {
                      combinedContent[other_key] = other_value;
                    });
        Severity: Minor
        Found in public/app-resources/languages/_helper.ts and 1 other location - About 40 mins to fix
        public/app-resources/languages/_helper.ts on lines 316..319

        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

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

                  Object.entries(jsonParsed.untranslated || [])
                    .map(([untranslated_key, untranslated_value]) => {
                      combinedContent[untranslated_key] = untranslated_value;
                    });
        Severity: Minor
        Found in public/app-resources/languages/_helper.ts and 1 other location - About 40 mins to fix
        public/app-resources/languages/_helper.ts on lines 320..323

        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