so5/ssh-client-wrapper

View on GitHub
lib/util.js

Summary

Maintainability
C
1 day
Test Coverage
C
70%

Function sanityCheck has a Cognitive Complexity of 24 (exceeds 5 allowed). Consider refactoring.
Open

const sanityCheck = (hostInfo) => {
  debug("sanityCheck called", hostInfo);

  // keep password, passphrase, and masterPty before validate.
  // these properties can have a iellegal value as JSON data
Severity: Minor
Found in lib/util.js - About 3 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 getSshOption has a Cognitive Complexity of 21 (exceeds 5 allowed). Consider refactoring.
Open

const getSshOption = (hostInfo, withoutDestination) => {
  debug("getSshOption called");
  const args = [];

  if (!withoutDestination) {
Severity: Minor
Found in lib/util.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 getSshOption has 55 lines of code (exceeds 25 allowed). Consider refactoring.
Open

const getSshOption = (hostInfo, withoutDestination) => {
  debug("getSshOption called");
  const args = [];

  if (!withoutDestination) {
Severity: Major
Found in lib/util.js - About 2 hrs to fix

    Function sanityCheck has 51 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

    const sanityCheck = (hostInfo) => {
      debug("sanityCheck called", hostInfo);
    
      // keep password, passphrase, and masterPty before validate.
      // these properties can have a iellegal value as JSON data
    Severity: Major
    Found in lib/util.js - About 2 hrs to fix

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

      function getControlPersistDir (hostInfo) {
        for (const candidate of [hostInfo.ControlPersistDir, process.env.SSH_CONTROL_PERSIST_DIR]) {
          if (typeof candidate === "string") {
            const stat = fs.statSync(candidate, { throwIfNoEntry: false });
            if (stat.isDirectory()) {
      Severity: Minor
      Found in lib/util.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

      There are no issues that match your filters.

      Category
      Status