emmercm/metalsmith-link-checker

View on GitHub

Showing 12 of 12 total issues

Function exports has 78 lines of code (exceeds 25 allowed). Consider refactoring.
Open

module.exports = (options) => {
  options = deepmerge({
    html: {
      pattern: '**/*.html',
      tags: {
Severity: Major
Found in lib/index.js - About 3 hrs to fix

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

    const test = (dir, config) => {
      describe(dir, () => {
        // Allow src directory to not exist / be empty and not committed
        if (!existsSync(`${dir}/src`)) {
          mkdirSync(`${dir}/src`);
    Severity: Major
    Found in lib/index.test.js - About 2 hrs to fix

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

                  Object.keys(files)
                    .forEach((filename) => {
                      const newFilename = filename.replace(/[/\\]/g, pathSeparator);
                      if (newFilename !== filename) {
                        files[newFilename] = files[filename];
      Severity: Major
      Found in lib/index.test.js and 1 other location - About 2 hrs to fix
      lib/index.test.js on lines 40..47

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

      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.keys(files)
                    .forEach((filename) => {
                      const newFilename = filename.replace(/[/\\]/g, properPathSeparator);
                      if (newFilename !== filename) {
                        files[newFilename] = files[filename];
      Severity: Major
      Found in lib/index.test.js and 1 other location - About 2 hrs to fix
      lib/index.test.js on lines 25..32

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

      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

      const validSms = (link) => {
        // https://developer.apple.com/library/archive/featuredarticles/iPhoneURLScheme_Reference/SMSLinks/SMSLinks.html
        if (!link.replace(/ /g, '').match(/^sms:([0-9.+-]+)?$/)) {
          return 'invalid';
        }
      Severity: Major
      Found in lib/index.js and 1 other location - About 2 hrs to fix
      lib/index.js on lines 225..234

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

      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

      const validTel = (link) => {
        // https://developer.apple.com/library/archive/featuredarticles/iPhoneURLScheme_Reference/PhoneLinks/PhoneLinks.html#//apple_ref/doc/uid/TP40007899-CH6-SW1
        if (!link.replace(/ /g, '').match(/^tel:([0-9.+-]+)?$/)) {
          return 'invalid';
        }
      Severity: Major
      Found in lib/index.js and 1 other location - About 2 hrs to fix
      lib/index.js on lines 210..219

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

      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

      Function validUrl has 46 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

      const validUrl = (link, options, callback, attempt = 1, method = 'HEAD') => {
        const cacheAndCallback = (err, result) => {
          // Retry failures if we haven't reached the retry limit
          if (result && attempt <= options.attempts) {
            setTimeout(() => {
      Severity: Minor
      Found in lib/index.js - About 1 hr to fix

        Function validFacetime has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
        Open

        const validFacetime = (link) => {
          // https://developer.apple.com/library/archive/featuredarticles/iPhoneURLScheme_Reference/FacetimeLinks/FacetimeLinks.html
          if (link === 'facetime:') {
            return null;
          }
        Severity: Minor
        Found in lib/index.js - 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

        Function test has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
        Open

        const test = (dir, config) => {
          describe(dir, () => {
            // Allow src directory to not exist / be empty and not committed
            if (!existsSync(`${dir}/src`)) {
              mkdirSync(`${dir}/src`);
        Severity: Minor
        Found in lib/index.test.js - About 45 mins 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 'invalid phone number';
        Severity: Major
        Found in lib/index.js - About 30 mins to fix

          Avoid too many return statements within this function.
          Open

            return null;
          Severity: Major
          Found in lib/index.js - About 30 mins to fix

            Function validUrl has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
            Open

            const validUrl = (link, options, callback, attempt = 1, method = 'HEAD') => {
              const cacheAndCallback = (err, result) => {
                // Retry failures if we haven't reached the retry limit
                if (result && attempt <= options.attempts) {
                  setTimeout(() => {
            Severity: Minor
            Found in lib/index.js - About 25 mins 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

            Severity
            Category
            Status
            Source
            Language