shellcheck.js

/* I don't actually know Javascript :( */

var lastChange = 0;
var lastCheck = 0;
var lastCode = "";
var lastErrors = [];

function shellcheckCode(code, callback) {
  lastChange = lastCheck;
  if (lastChange == 0 && code == "") {
    return;
  }

  if (window.jQuery) {
    $.post("shellcheck.php",
        { "script": code },
        function (data) {
          callback(data);
        }, 'json');
  } else {
    // JQuery is not loaded. Try again soon.
    setTimeout(function() {
      shellcheckCode(code, callback);
    }, 1000);
  }
}

function getLink(code) {
  return $("<a />")
    .attr("href", "https://github.com/koalaman/shellcheck/wiki/SC" + code)
    .attr("target", "_blank")
    .attr("class", "wikilink")
    .text("SC" + code);
}
function getLineLink(line, column) {
    return $("<a />")
        .attr("href", "javascript:setPosition(" + line + ", " + column + ")")
        .attr("class", "linelink")
        .text("Line " + line + ":");
}

function formatError(err) {
  var nodes = [];
  var header="";

  var i=1;
  if (err.column >= 60) {
    header += ">>";
    i += header.length;
  }
  for(; i<err.column; i++) {
    header += "&nbsp;"
  }
  header += "^-- ";

  nodes.push($("<span />").html(header));
  if (err.code > 0) {
    nodes.push(getLink(err.code));
    nodes.push(document.createTextNode(" (" + err.level + "): "));
  }
  nodes.push($("<span />").text(err.message));
  return $("<span />")
      .addClass(err.level)
      .addClass("pointer")
      .append(nodes);
}

// Get only unique elements from a list.
function nubList(list) {
  var set = {};
  for(var item of list) {
    set[item] = true;
  }
  var result = [];
  for(var key in set) {
    result.push(key);
  }
  result.sort();
  return result;
}

function formatFix(fixer, errors, applicableIndices) {
  var result = $("<span />");

  var codes = [];
  for(var index of applicableIndices) {
    codes.push(errors[index].code);
  }
  codes = nubList(codes);

  result.append($("<span />")
    .attr("class", "didyoumean")
    .append($("<br />"))
    .append($("<span />").text("Did you mean: ")));

  var nodes = [];
  nodes.push($("<span />").text("("));
  nodes.push($("<a />")
    .attr("href", "javascript:applyFixIndex(" + JSON.stringify(applicableIndices) + ")")
    .attr("class", "linelink")
    .text("apply this"));

  for (var code of codes) {
    nodes.push($("<span />").text(", apply "));
    nodes.push($("<a />")
      .attr("href", "javascript:applyFixCode(" + code + ")")
      .attr("class", "linelink")
      .text("all SC" + code));
  }
  nodes.push($("<span />").text(")"));
  nodes.push($("<br />"));
  result.append($("<span />")
    .attr("class", "applyline")
    .append(nodes));


  nodes = []
  for(var line of fixer.getSnippet().split("\n")) {
    nodes.push($("<span />")
      .addClass("sourceline")
      .append(document.createTextNode(formatLine(line))));
  }
  nodes.push($("<br />"));
  result.append(nodes);

  return result;
}

function applyAllFixes() {
  if(!applyFixes(lastErrors)) {
    alert("Sorry! There are no relevant autofixes available at this time.");
  }
}

function applyFixIndex(indices) {
  var fixes = [];
  for (var i of indices) {
    fixes.push(lastErrors[i]);
  }
  applyFixes(fixes);
}

function applyFixCode(code) {
  var fixes = [];
  for (var err of lastErrors) {
    if (err.code == code) {
      fixes.push(err);
    }
  }
  applyFixes(fixes);
}

function applyFixes(fixes) {
  if (lastChange != lastCheck) {
    return;
  }

  var zoomTo = undefined;
  var fixer = new AutoFixer(lastCode);
  for (var err of fixes) {
    if (!zoomTo) {
      zoomTo = err.line;
    }
    fixer.applyFix(err);
  }
  editor.setValue(fixer.getResult());
  if (zoomTo) {
    setPosition(zoomTo, 1);
  }
  return fixer.hasModifications();
}

function sortKey() {
  for(var i in arguments) {
    if (arguments[i] != 0)
      return arguments[i];
  }
  return 0;
}

function formatLine(line) {
  if (!line) {
    line = "";
  }
  line = line.replace(/\t/g, "        ");
  line = line.replace(/^ /, "\u00A0");
  line = line.replace(/  /g, " \u00A0");
  return line;
}

function createTerminal(code, errors) {
  var node = $("<div />");
  errors.sort(function(a,b) {
    return sortKey(a.line - b.line, a.column - b.column)
  });

  var lines = code.split("\n");
  node.append(document.createTextNode("$ shellcheck myscript")).append("<br />");
  if(errors.length == 0) {
    node.append(document.createTextNode("No issues detected!")).append("<br />");
  } else {
    var fixer = new AutoFixer(code);
    var currentFixes = [];

    var last = -1;
    for (var i=0; i < errors.length; i++) {
      if (errors[i].line != last) {
        // After a set of errors, show autofix suggestions
        if (fixer.hasModifications()) {
          node.append(formatFix(fixer, errors, currentFixes));
        }
        fixer.reset();
        currentFixes = [];

        // For the first message of the line, print the line number and line
        last = errors[i].line;
        node.append("&nbsp;<br />");
        node.append(getLineLink(errors[i].line, errors[i].column));
        node.append("<br />");
        var line = formatLine(lines[errors[i].line - 1]);
        var lineElem = $("<span />")
            .addClass("sourceline")
            .append(document.createTextNode(line));
        node.append(lineElem).append("<br />");
      }
      // Then 1+ errors
      node.append(formatError(errors[i])).append("<br />");
      if(errors[i].fix) {
        fixer.applyFix(errors[i]);
        currentFixes.push(i);
      }
    }
    if (fixer.hasModifications()) {
      node.append(formatFix(fixer, errors, currentFixes));
    }
  }

  node
    .append("<br />")
    .append(document.createTextNode("$ ")).append("<br />");
  return node;
}

function hasAutoFix(errors) {
  for(var err of errors) {
    if (err.fix && err.fix.replacements && err.fix.replacements.length > 0) {
      return true;
    }
  }
  return false;
}

function setTerminal(code, errors) {
  $("#terminal").html("").append(createTerminal(code, errors));

  if (hasAutoFix(errors)) {
    $("#autofix").removeClass("disabledLink");
  } else {
    $("#autofix").addClass("disabledLink");
  }

  if (lastChange == lastCheck) {
    lastCode = code;
    lastErrors = errors;
    $("#processingindicator").text("");
  }
}

function setPosition(line, column) {
  var min = 40;
  editor.gotoLine(line, column - 1);
  var position = editor.renderer.textToScreenCoordinates(line, column - 1).pageY;
  if ( position < min) {
    document.body.scrollTop += position - min;
  }
  editor.focus();
  editor.clearSelection();
}
function maximize() {
  var selector = "#editorwindow";
  $(selector).css( { "max-width": "100%" });
  $(selector).height($(selector).height() * 1.5);
  $("#terminalwindow").css( { "max-width": "100%" });
  editor.resize();
}
function minimize() {
  var selector = "#editorwindow";
  if ($(selector).height() > 50) {
    $(selector).height($(selector).height() * 0.5);
  }
  editor.resize();
}

function editorChangeHandler(obj) {
  lastChange++;
  $("#processingindicator").text(" (updating)");
}

function reportBug() {
  window.open(makeReportUrl(lastCode, lastErrors));
}