patrick/KaTeX
1
0
Fork 0
mirror of https://github.com/Smaug123/KaTeX synced 2025-10-05 03:08:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Stop throwing ParseError when throwOnError is false (#1169)

Browse Source 
* Stop throwing ParseError when throwOnError is false

`render`, `renderToString`, etc. now catch ParseError and render it to the
raw LaTeX (with proper escaping) and a hover title with the error.

Along the way:
* Use new `katex.__renderToDomTree` in katex-spec's `_getBuilt`.
  (This was necessary to get the new error handling in `_getBuilt`.)
* Fix jest results which must always be functions, not strings.

* fix lint

* Fix flow error

Leave error type unspecified, as we check it with instanceof.

* Update katex-spec.js
This commit is contained in:
Erik Demaine
2018-05-09 09:18:50 -04:00
committed by ylemkimon
parent 3e529dd5a0
commit 49e673a59c
4 changed files with 94 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
test/__snapshots__/katex-spec.js.snap
View File

@@ -1,5 +1,39 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`A parser that does not throw on unsupported commands should build katex-error span for other type of KaTeX error 1`] = `
{
"attributes": {
"style": "color:#933",
"title": "ParseError: KaTeX parse error: Double superscript at position 4: 2^2^̲2"
},
"children": [
{
"classes": [
],
"depth": 0,
"height": 0,
"italic": 0,
"maxFontSize": 0,
"skew": 0,
"style": {
},
"value": "2^2^2",
"width": 0
}
],
"classes": [
"katex-error"
],
"depth": 0,
"height": 0,
"maxFontSize": 0,
"style": {
}
}
`;
exports[`A parser that does not throw on unsupported commands should properly escape LaTeX in errors 1`] = `"<span class=\\"katex-error\\" title=\\"ParseError: KaTeX parse error: Expected group after &#x27;^&#x27; at position 2: 2^̲&amp;&quot;&lt;&gt;\\" style=\\"color:#933\\">2^&amp;&quot;&lt;&gt;</span>"`;
exports[`An implicit group parser within optional groups should work style commands \\sqrt[\\textstyle 3]{x} 1`] = `
[
{

35
test/katex-spec.js
View File

@@ -44,8 +44,11 @@ const defaultOptions = new Options({
const _getBuilt = function(expr, settings) {
const usedSettings = settings ? settings : defaultSettings;
const parsedTree = parseTree(expr, usedSettings);
const rootNode = buildTree(parsedTree, expr, usedSettings);
const rootNode = katex.__renderToDomTree(expr, usedSettings);
if (rootNode.classes.indexOf('katex-error') >= 0) {
return rootNode;
}
// grab the root node of the HTML rendering
const builtHTML = rootNode.children[1];
@@ -98,10 +101,10 @@ const parseAndSetResult = function(expr, result, settings) {
} catch (e) {
result.pass = false;
if (e instanceof ParseError) {
result.message = "'" + expr + "' failed " +
result.message = () => "'" + expr + "' failed " +
"parsing with error: " + e.message;
} else {
result.message = "'" + expr + "' failed " +
result.message = () => "'" + expr + "' failed " +
"parsing with unknown error: " + e.message;
}
}
@@ -113,10 +116,10 @@ const buildAndSetResult = function(expr, result, settings) {
} catch (e) {
result.pass = false;
if (e instanceof ParseError) {
result.message = "'" + expr + "' failed " +
result.message = () => "'" + expr + "' failed " +
"parsing with error: " + e.message;
} else {
result.message = "'" + expr + "' failed " +
result.message = () => "'" + expr + "' failed " +
"parsing with unknown error: " + e.message;
}
}
@@ -149,10 +152,10 @@ beforeEach(function() {
} catch (e) {
if (e instanceof ParseError) {
result.pass = true;
result.message = "'" + actual + "' correctly " +
result.message = () => "'" + actual + "' correctly " +
"didn't parse with error: " + e.message;
} else {
result.message = "'" + actual + "' failed " +
result.message = () => "'" + actual + "' failed " +
"parsing with unknown error: " + e.message;
}
}
@@ -175,10 +178,10 @@ beforeEach(function() {
} catch (e) {
result.pass = false;
if (e instanceof ParseError) {
result.message = "'" + actual + "' failed to " +
result.message = () => "'" + actual + "' failed to " +
"build with error: " + e.message;
} else {
result.message = "'" + actual + "' failed " +
result.message = () => "'" + actual + "' failed " +
"building with unknown error: " + e.message;
}
}
@@ -2638,6 +2641,18 @@ describe("A parser that does not throw on unsupported commands", function() {
expect(parsedInput[0].type).toBe("color");
expect(parsedInput[0].value.color).toBe(errorColor);
});
it("should build katex-error span for other type of KaTeX error", function() {
// Use _getBuilt instead of getBuilt to avoid calling expect...toParse
// and thus throwing parse error
const built = _getBuilt("2^2^2", noThrowSettings);
expect(built).toMatchSnapshot();
});
it("should properly escape LaTeX in errors", function() {
const html = katex.renderToString("2^&\"<>", noThrowSettings);
expect(html).toMatchSnapshot();
});
});
describe("The symbol table integrity", function() {