Sign upLogin

npm/marky-markdown

View on GitHub
Star
lib/plugin/github.js

Summary

Maintainability
C
1 day
Test Coverage

Function exports has a Cognitive Complexity of 18 (exceeds 5 allowed). Consider refactoring.
Open

module.exports = function (md, opts) {
  if (!opts) return
  if (!opts.package) return
  if (!opts.package.repository) return
Severity: Minor
Found in lib/plugin/github.js - 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 exports has 42 lines of code (exceeds 25 allowed). Consider refactoring.
Open

module.exports = function (md, opts) {
  if (!opts) return
  if (!opts.package) return
  if (!opts.package.repository) return
Severity: Minor
Found in lib/plugin/github.js - About 1 hr to fix

    Function image has 5 arguments (exceeds 4 allowed). Consider refactoring.
    Open

      md.renderer.rules.image = function (tokens, idx, options, env, self) {
    Severity: Minor
    Found in lib/plugin/github.js - About 35 mins to fix

      Function replaceTagAttribute has 5 arguments (exceeds 4 allowed). Consider refactoring.
      Open

      function replaceTagAttribute (html, tag, attribute, buildUrl, repository) {
      Severity: Minor
      Found in lib/plugin/github.js - About 35 mins to fix

        Function link_open has 5 arguments (exceeds 4 allowed). Consider refactoring.
        Open

          md.renderer.rules.link_open = function (tokens, idx, options, env, self) {
        Severity: Minor
        Found in lib/plugin/github.js - About 35 mins to fix

          Function replaceTagAttribute has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
          Open

          function replaceTagAttribute (html, tag, attribute, buildUrl, repository) {
  // look for the attribute's value
  var regex = new RegExp('<\\s*' + tag + '[^>]*\\b' + attribute + '\\s*=\\s*', 'i')
  var attr = html.match(regex)
  if (attr) {
          Severity: Minor
          Found in lib/plugin/github.js - About 35 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

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

              if (src && src.length) {
      var url = URL.parse(src)

      // Skip fully-qualified URLs, #hash fragments, and protocol-relative URLs
      if (!url.host && url.path && !url.path.match(/^\/\//)) {
          Severity: Major
          Found in lib/plugin/github.js and 1 other location - About 2 hrs to fix
          lib/plugin/github.js on lines 77..84

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

          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

              if (href && href.length) {
      var url = URL.parse(href)

      // Skip fully-qualified URLs, #hash fragments, and protocol-relative URLs
      if (!url.host && url.path && !url.path.match(/^\/\//)) {
          Severity: Major
          Found in lib/plugin/github.js and 1 other location - About 2 hrs to fix
          lib/plugin/github.js on lines 61..68

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

          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