JamieMason/expect-more

View on GitHub
scripts/generate-matchers/jest-matcher-test.ts

Summary

Maintainability
A
2 hrs
Test Coverage

Function generateJestMatcherTest has 29 lines of code (exceeds 25 allowed). Consider refactoring.
Open

export const generateJestMatcherTest = (file: FileMeta): void => {
  const { jestMatcherTestPath, jsDoc } = file;
  const { matcherName, params } = jsDoc;
  let comment = '';
  let valueExample = params.find(({ name }) => name === 'value').exampleValue;
Severity: Minor
Found in scripts/generate-matchers/jest-matcher-test.ts - About 1 hr to fix

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

      if (matcherName === 'toBeAsyncFunction') {
        comment = '// eval is workaround for typescript converting async to non-async';
        valueExample = "eval('(async (_) => _)')";
      } else if (matcherName === 'toBeGeneratorFunction') {
        comment = '// eval is workaround for typescript converting generator fns';
    Severity: Major
    Found in scripts/generate-matchers/jest-matcher-test.ts and 2 other locations - About 50 mins to fix
    scripts/generate-matchers/jasmine-matcher-test.ts on lines 9..15
    scripts/generate-matchers/jasmine-member-matcher-test.ts on lines 9..15

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

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

      const argsExamples = params
        .filter(({ name }) => name !== 'value')
        .map(({ exampleValue }) => exampleValue);
    Severity: Major
    Found in scripts/generate-matchers/jest-matcher-test.ts and 5 other locations - About 35 mins to fix
    scripts/generate-matchers/jasmine-matcher-test.ts on lines 16..18
    scripts/generate-matchers/jasmine-matcher.ts on lines 18..20
    scripts/generate-matchers/jasmine-member-matcher-test.ts on lines 17..19
    scripts/generate-matchers/jasmine-member-matcher.ts on lines 30..32
    scripts/generate-matchers/jest-matcher.ts on lines 18..20

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

    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

    " should be '
    Open

        valueExample = "eval('(function*() {yield 2;})')";

    Rule: quotemark

    Enforces quote character for string literals.

    Notes
    • Has Fix

    Config

    Five arguments may be optionally provided:

    • "single" enforces single quotes.
    • "double" enforces double quotes.
    • "backtick" enforces backticks.
    • "jsx-single" enforces single quotes for JSX attributes.
    • "jsx-double" enforces double quotes for JSX attributes.
    • "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
    • "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.
    Examples
    "quotemark": true,single,avoid-escape,avoid-template
    "quotemark": true,single,jsx-double
    Schema
    {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "single",
          "double",
          "backtick",
          "jsx-single",
          "jsx-double",
          "avoid-escape",
          "avoid-template"
        ]
      },
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    " should be '
    Open

        valueExample = "eval('(async (_) => _)')";

    Rule: quotemark

    Enforces quote character for string literals.

    Notes
    • Has Fix

    Config

    Five arguments may be optionally provided:

    • "single" enforces single quotes.
    • "double" enforces double quotes.
    • "backtick" enforces backticks.
    • "jsx-single" enforces single quotes for JSX attributes.
    • "jsx-double" enforces double quotes for JSX attributes.
    • "avoid-template" forbids single-line untagged template strings that do not contain string interpolations. Note that backticks may still be used if "avoid-escape" is enabled and both single and double quotes are present in the string (the latter option takes precedence).
    • "avoid-escape" allows you to use the "other" quotemark in cases where escaping would normally be required. For example, [true, "double", "avoid-escape"] would not report a failure on the string literal 'Hello "World"'.
    Examples
    "quotemark": true,single,avoid-escape,avoid-template
    "quotemark": true,single,jsx-double
    Schema
    {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "single",
          "double",
          "backtick",
          "jsx-single",
          "jsx-double",
          "avoid-escape",
          "avoid-template"
        ]
      },
      "minLength": 0,
      "maxLength": 5
    }

    For more information see this page.

    There are no issues that match your filters.

    Category
    Status