Owen Leonard
08900d5653
system preferences
This patch adds CodeMirror plugins for linting JS, CSS, HTML, and YAML.
When invalid data is entered in a linted CodeMirror editor an icon is
displayed in the editor's "gutter." Hovering over the icon displays the
error message.
This patch renames the minified CodeMirror JS file to match convention
but the version is unchanged.
To test, apply the patch and go to Administration -> System preferences.
Test preferences of each type and confirm that each type of CodeMirror
editor shows an error indicator if you entry invalid data. Valid data
should trigger no error indicator.
- HTML: e.g. OpacMainUserBlock, opacheader. Enter invalid HTML, for
example "<h1>Hello <h2>World</h2>."
Example valid HTML: "<h1>Hello world</h1>"
- JavaScript: e.g. OpacUserJS, IntranetUserJS. Example bad JS,
"alert("Success!');"
Example valid JS: "alert("Success!");"
- CSS: e.g. IntranetUserCSS, SCOUserCSS. Example bad CSS,
"p { color blue }"
Example valid CSS, "p { color: blue; }"
- YAML: e.g. OpacHiddenItems. Example bad YAML:
"one: two, three: four"
Example valid YAML:
"one: two
three: four"
Also test that other CodeMirror instances still work correctly without
linting: The advanced MARC editor, SQL reports editing.
Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
63 lines
2 KiB
JavaScript
63 lines
2 KiB
JavaScript
// CodeMirror, copyright (c) by Marijn Haverbeke and others
|
|
// Distributed under an MIT license: https://codemirror.net/LICENSE
|
|
|
|
(function(mod) {
|
|
if (typeof exports == "object" && typeof module == "object") // CommonJS
|
|
mod(require("../../lib/codemirror"));
|
|
else if (typeof define == "function" && define.amd) // AMD
|
|
define(["../../lib/codemirror"], mod);
|
|
else // Plain browser env
|
|
mod(CodeMirror);
|
|
})(function(CodeMirror) {
|
|
"use strict";
|
|
// declare global: JSHINT
|
|
|
|
function validator(text, options) {
|
|
if (!window.JSHINT) {
|
|
if (window.console) {
|
|
window.console.error("Error: window.JSHINT not defined, CodeMirror JavaScript linting cannot run.");
|
|
}
|
|
return [];
|
|
}
|
|
if (!options.indent) // JSHint error.character actually is a column index, this fixes underlining on lines using tabs for indentation
|
|
options.indent = 1; // JSHint default value is 4
|
|
JSHINT(text, options, options.globals);
|
|
var errors = JSHINT.data().errors, result = [];
|
|
if (errors) parseErrors(errors, result);
|
|
return result;
|
|
}
|
|
|
|
CodeMirror.registerHelper("lint", "javascript", validator);
|
|
|
|
function parseErrors(errors, output) {
|
|
for ( var i = 0; i < errors.length; i++) {
|
|
var error = errors[i];
|
|
if (error) {
|
|
if (error.line <= 0) {
|
|
if (window.console) {
|
|
window.console.warn("Cannot display JSHint error (invalid line " + error.line + ")", error);
|
|
}
|
|
continue;
|
|
}
|
|
|
|
var start = error.character - 1, end = start + 1;
|
|
if (error.evidence) {
|
|
var index = error.evidence.substring(start).search(/.\b/);
|
|
if (index > -1) {
|
|
end += index;
|
|
}
|
|
}
|
|
|
|
// Convert to format expected by validation service
|
|
var hint = {
|
|
message: error.reason,
|
|
severity: error.code ? (error.code.startsWith('W') ? "warning" : "error") : "error",
|
|
from: CodeMirror.Pos(error.line - 1, start),
|
|
to: CodeMirror.Pos(error.line - 1, end)
|
|
};
|
|
|
|
output.push(hint);
|
|
}
|
|
}
|
|
}
|
|
});
|