aurelia/aurelia

View on GitHub
packages/template-compiler/src/errors.ts

Summary

Maintainability
F
3 days
Test Coverage

Function getMessageByCode has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

const getMessageByCode = (name: ErrorNames, ...details: unknown[]) => {
  let cooked: string = errorsMap[name];
  for (let i = 0; i < details.length; ++i) {
    const regex = new RegExp(`{{${i}(:.*)?}}`, 'g');
    let matches = regex.exec(cooked);
Severity: Minor
Found in packages/template-compiler/src/errors.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 getMessageByCode has 33 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const getMessageByCode = (name: ErrorNames, ...details: unknown[]) => {
  let cooked: string = errorsMap[name];
  for (let i = 0; i < details.length; ++i) {
    const regex = new RegExp(`{{${i}(:.*)?}}`, 'g');
    let matches = regex.exec(cooked);
Severity: Minor
Found in packages/template-compiler/src/errors.ts - About 1 hr to fix

    Avoid deeply nested control flow statements.
    Open

                if (method?.startsWith('.')) {
                  value = String(value[method.slice(1)]);
                } else {
                  value = String(value);
                }
    Severity: Major
    Found in packages/template-compiler/src/errors.ts - About 45 mins to fix

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

            if (value != null) {
              switch (method) {
                case 'nodeName': value = (value as Node).nodeName.toLowerCase(); break;
                case 'name': value = (value as { name: string }).name; break;
                case 'typeof': value = typeof value; break;
      Severity: Major
      Found in packages/template-compiler/src/errors.ts and 1 other location - About 1 day to fix
      packages/runtime-html/src/errors.ts on lines 262..283

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

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

      export const createMappedError: CreateError = __DEV__
        ? (code: ErrorNames, ...details: unknown[]) => new Error(`AUR${String(code).padStart(4, '0')}: ${getMessageByCode(code, ...details)}`)
        : (code: ErrorNames, ...details: unknown[]) => new Error(`AUR${String(code).padStart(4, '0')}:${details.map(String)}`);
      Severity: Major
      Found in packages/template-compiler/src/errors.ts and 6 other locations - About 5 hrs to fix
      packages/dialog/src/errors.ts on lines 5..7
      packages/fetch-client/src/errors.ts on lines 5..7
      packages/i18n/src/errors.ts on lines 5..7
      packages/router/src/errors.ts on lines 5..7
      packages/validation-html/src/errors.ts on lines 5..7
      packages/validation/src/errors.ts on lines 5..7

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

      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

      function getBindingCommandHelp(name: string) {
        switch (name) {
          case 'delegate':
            return `\nThe ".delegate" binding command has been removed in v2.`
            + ` Binding command ".trigger" should be used instead.`
      Severity: Major
      Found in packages/template-compiler/src/errors.ts and 1 other location - About 2 hrs to fix
      packages/runtime-html/src/errors.ts on lines 300..314

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

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

      function pleaseHelpCreateAnIssue(title: string, body?: string) {
        return `\nThis is likely an issue with Aurelia.\n Please help create an issue by clicking the following link\n`
          + `https://github.com/aurelia/aurelia/issues/new?title=${encodeURIComponent(title)}`
          + (body != null ? `&body=${encodeURIComponent(body)}` : '&template=bug_report.md');
      }
      Severity: Major
      Found in packages/template-compiler/src/errors.ts and 9 other locations - About 1 hr to fix
      packages/dialog/src/errors.ts on lines 71..75
      packages/expression-parser/src/errors.ts on lines 136..140
      packages/fetch-client/src/errors.ts on lines 77..81
      packages/i18n/src/errors.ts on lines 61..65
      packages/router/src/errors.ts on lines 95..99
      packages/runtime-html/src/errors.ts on lines 294..298
      packages/runtime/src/errors.ts on lines 174..178
      packages/validation-html/src/errors.ts on lines 70..74
      packages/validation/src/errors.ts on lines 70..74

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

      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