katex 0.16.4 → 0.16.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "katex",
-  "version": "0.16.4",
+  "version": "0.16.6",
   "description": "Fast math typesetting for the web.",
   "main": "dist/katex.js",
   "exports": {
@@ -49,78 +49,79 @@
   "license": "MIT",
   "packageManager": "yarn@3.2.2",
   "devDependencies": {
-    "@babel/core": "^7.10.4",
-    "@babel/eslint-parser": "^7.15.0",
-    "@babel/plugin-proposal-class-properties": "^7.10.4",
-    "@babel/plugin-syntax-flow": "^7.14.5",
-    "@babel/plugin-transform-react-jsx": "^7.14.9",
-    "@babel/plugin-transform-runtime": "^7.10.4",
-    "@babel/preset-env": "^7.10.4",
-    "@babel/preset-flow": "^7.10.4",
-    "@babel/preset-react": "^7.14.5",
-    "@babel/register": "^7.10.4",
-    "@babel/runtime": "^7.10.4",
-    "@rollup/plugin-alias": "^3.1.1",
-    "@rollup/plugin-babel": "^5.0.4",
-    "@semantic-release/changelog": "^6.0.0",
-    "@semantic-release/git": "^10.0.0",
-    "babel-jest": "^27.0.0",
-    "babel-loader": "^8.0.5",
-    "babel-plugin-istanbul": "^6.0.0",
-    "babel-plugin-preval": "^5.0.0",
+    "@babel/core": "^7.18.13",
+    "@babel/eslint-parser": "^7.18.9",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-syntax-flow": "^7.18.6",
+    "@babel/plugin-transform-react-jsx": "^7.18.10",
+    "@babel/plugin-transform-runtime": "^7.18.10",
+    "@babel/preset-env": "^7.18.10",
+    "@babel/preset-flow": "^7.18.6",
+    "@babel/preset-react": "^7.18.6",
+    "@babel/register": "^7.18.9",
+    "@babel/runtime": "^7.18.9",
+    "@rollup/plugin-alias": "^3.1.9",
+    "@rollup/plugin-babel": "^5.3.1",
+    "@semantic-release/changelog": "^6.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "babel-jest": "^29.0.1",
+    "babel-loader": "^8.2.5",
+    "babel-plugin-istanbul": "^6.1.1",
+    "babel-plugin-preval": "^5.1.0",
     "babel-plugin-version-inline": "^1.0.0",
     "benchmark": "^2.1.4",
-    "browserslist": "^4.13.0",
-    "browserstack-local": "^1.4.5",
-    "caniuse-lite": "^1.0.30001102",
-    "css-loader": "^6.0.0",
-    "cssnano": "^5.0.0-rc.1",
-    "eslint": "^8.0.0",
+    "browserslist": "^4.21.3",
+    "browserstack-local": "^1.5.1",
+    "caniuse-lite": "^1.0.30001384",
+    "css-loader": "^6.7.1",
+    "cssnano": "^5.1.13",
+    "eslint": "^8.23.0",
     "eslint-import-resolver-webpack": "^0.13.2",
     "eslint-plugin-actions": "^2.0.0",
-    "eslint-plugin-flowtype": "^8.0.0",
-    "eslint-plugin-import": "^2.25.2",
-    "eslint-plugin-react": "^7.20.3",
+    "eslint-plugin-flowtype": "^8.0.3",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-react": "^7.31.1",
     "flow-bin": "^0.135.0",
-    "fs-extra": "^10.0.0",
-    "got": "^11.8.0",
-    "husky": "^4.2.5",
-    "istanbul-lib-coverage": "^3.0.0",
+    "fs-extra": "^10.1.0",
+    "got": "^11.8.5",
+    "husky": "^4.3.8",
+    "istanbul-lib-coverage": "^3.2.0",
     "istanbul-lib-report": "^3.0.0",
-    "istanbul-reports": "^3.0.2",
-    "jest": "^27.0.0",
-    "jest-diff": "^27.0.0",
-    "jest-matcher-utils": "^27.0.0",
-    "jest-message-util": "^27.0.0",
-    "jest-serializer-html": "^7.0.0",
-    "js-yaml": "^4.0.0",
+    "istanbul-reports": "^3.1.5",
+    "jest": "^29.0.1",
+    "jest-diff": "^29.0.1",
+    "jest-environment-jsdom": "^29.0.1",
+    "jest-matcher-utils": "^29.0.1",
+    "jest-message-util": "^29.0.1",
+    "jest-serializer-html": "^7.1.0",
+    "js-yaml": "^4.1.0",
     "json-stable-stringify": "^1.0.1",
     "jspngopt": "^0.2.0",
-    "less": "^4.0.0",
-    "less-loader": "^10.0.0",
-    "mini-css-extract-plugin": "^2.0.0",
+    "less": "^4.1.3",
+    "less-loader": "^11.0.0",
+    "mini-css-extract-plugin": "^2.6.1",
     "mkdirp": "^1.0.4",
-    "p-retry": "^4.6.1",
-    "pako": "^2.0.0",
-    "postcss": "^8.0.0",
+    "p-retry": "^4.6.2",
+    "pako": "^2.0.4",
+    "postcss": "^8.4.16",
     "postcss-less": "^6.0.0",
-    "postcss-loader": "^6.0.0",
-    "postcss-preset-env": "^7.0.0",
-    "prettier": "^2.0.5",
-    "query-string": "^7.0.0",
+    "postcss-loader": "^7.0.1",
+    "postcss-preset-env": "^7.8.0",
+    "prettier": "^2.7.1",
+    "query-string": "^7.1.1",
     "rimraf": "^3.0.2",
-    "rollup": "^2.21.0",
-    "selenium-webdriver": "^4.0.0-beta.4",
-    "semantic-release": "^18.0.0",
+    "rollup": "^2.78.1",
+    "selenium-webdriver": "^4.4.0",
+    "semantic-release": "^19.0.5",
     "sri-toolbox": "^0.2.0",
-    "style-loader": "^3.0.0",
-    "stylelint": "^14.0.0",
-    "stylelint-config-standard": "^24.0.0",
-    "terser-webpack-plugin": "^5.0.3",
-    "webpack": "^5.51.1",
-    "webpack-bundle-analyzer": "^4.0.0",
-    "webpack-cli": "^4.8.0",
-    "webpack-dev-server": "^4.0.0"
+    "style-loader": "^3.3.1",
+    "stylelint": "^14.11.0",
+    "stylelint-config-standard": "^28.0.0",
+    "terser-webpack-plugin": "^5.3.6",
+    "webpack": "^5.74.0",
+    "webpack-bundle-analyzer": "^4.6.1",
+    "webpack-cli": "^4.10.0",
+    "webpack-dev-server": "^4.10.1"
   },
   "bin": "cli.js",
   "scripts": {
@@ -150,7 +151,7 @@
     "dist:zip": "rimraf katex/ katex.tar.gz katex.zip && cp -R dist katex && tar czf katex.tar.gz katex && zip -rq katex.zip katex && rimraf katex/"
   },
   "dependencies": {
-    "commander": "^8.0.0"
+    "commander": "^8.3.0"
   },
   "husky": {
     "hooks": {
@@ -173,7 +174,9 @@
     "testMatch": [
       "**/test/*-spec.js"
     ],
-    "testURL": "http://localhost/",
+    "testEnvironmentOptions": {
+      "url": "http://localhost/"
+    },
     "transform": {
       "^.+\\.js$": "babel-jest"
     },

package/src/MacroExpander.js

@@ -249,22 +249,22 @@ export default class MacroExpander implements MacroContextInterface {
      * Expand the next token only once if possible.
      *
      * If the token is expanded, the resulting tokens will be pushed onto
-     * the stack in reverse order and will be returned as an array,
-     * also in reverse order.
+     * the stack in reverse order, and the number of such tokens will be
+     * returned.  This number might be zero or positive.
      *
-     * If not, the next token will be returned without removing it
-     * from the stack.  This case can be detected by a `Token` return value
-     * instead of an `Array` return value.
+     * If not, the return value is `false`, and the next token remains at the
+     * top of the stack.
      *
      * In either case, the next token will be on the top of the stack,
-     * or the stack will be empty.
+     * or the stack will be empty (in case of empty expansion
+     * and no other tokens).
      *
      * Used to implement `expandAfterFuture` and `expandNextToken`.
      *
      * If expandableOnly, only expandable tokens are expanded and
      * an undefined control sequence results in an error.
      */
-    expandOnce(expandableOnly?: boolean): Token | Token[] {
+    expandOnce(expandableOnly?: boolean): number | boolean {
         const topToken = this.popToken();
         const name = topToken.text;
         const expansion = !topToken.noexpand ? this._getExpansion(name) : null;
@@ -274,7 +274,7 @@ export default class MacroExpander implements MacroContextInterface {
                 throw new ParseError("Undefined control sequence: " + name);
             }
             this.pushToken(topToken);
-            return topToken;
+            return false;
         }
         this.expansionCount++;
         if (this.expansionCount > this.settings.maxExpand) {
@@ -310,7 +310,7 @@ export default class MacroExpander implements MacroContextInterface {
         }
         // Concatenate expansion onto top of stack.
         this.pushTokens(tokens);
-        return tokens;
+        return tokens.length;
     }
 
     /**
@@ -329,15 +329,14 @@ export default class MacroExpander implements MacroContextInterface {
      */
     expandNextToken(): Token {
         for (;;) {
-            const expanded = this.expandOnce();
-            // expandOnce returns Token if and only if it's fully expanded.
-            if (expanded instanceof Token) {
+            if (this.expandOnce() === false) {  // fully expanded
+                const token = this.stack.pop();
                 // the token after \noexpand is interpreted as if its meaning
                 // were ‘\relax’
-                if (expanded.treatAsRelax) {
-                    expanded.text = "\\relax";
+                if (token.treatAsRelax) {
+                    token.text = "\\relax";
                 }
-                return this.stack.pop();  // === expanded
+                return token;
             }
         }
 
@@ -365,15 +364,15 @@ export default class MacroExpander implements MacroContextInterface {
         const oldStackLength = this.stack.length;
         this.pushTokens(tokens);
         while (this.stack.length > oldStackLength) {
-            const expanded = this.expandOnce(true); // expand only expandable tokens
-            // expandOnce returns Token if and only if it's fully expanded.
-            if (expanded instanceof Token) {
-                if (expanded.treatAsRelax) {
+            // Expand only expandable tokens
+            if (this.expandOnce(true) === false) {  // fully expanded
+                const token = this.stack.pop();
+                if (token.treatAsRelax) {
                     // the expansion of \noexpand is the token itself
-                    expanded.noexpand = false;
-                    expanded.treatAsRelax = false;
+                    token.noexpand = false;
+                    token.treatAsRelax = false;
                 }
-                output.push(this.stack.pop());
+                output.push(token);
             }
         }
         return output;

package/src/Parser.js

@@ -178,7 +178,7 @@ export default class Parser {
      * Parses an "expression", which is a list of atoms.
      *
      * `breakOnInfix`: Should the parsing stop when we hit infix nodes? This
-     *                 happens when functions have higher precendence han infix
+     *                 happens when functions have higher precedence han infix
      *                 nodes in implicit parses.
      *
      * `breakOnTokenText`: The text of the token that the expression should end

package/src/buildMathML.js

@@ -1,6 +1,6 @@
 // @flow
 /**
- * This file converts a parse tree into a cooresponding MathML tree. The main
+ * This file converts a parse tree into a corresponding MathML tree. The main
  * entry point is the `buildMathML` function, which takes a parse tree from the
  * parser.
  */
@@ -101,7 +101,7 @@ export const getVariant = function(
     } else if (font === "mathfrak") {
         return "fraktur";
     } else if (font === "mathscr" || font === "mathcal") {
-        // MathML makes no distinction between script and caligrahpic
+        // MathML makes no distinction between script and calligraphic
         return "script";
     } else if (font === "mathsf") {
         return "sans-serif";

package/src/defineEnvironment.js

@@ -42,7 +42,7 @@ type EnvProps = {
 };
 
 /**
- * Final enviornment spec for use at parse time.
+ * Final environment spec for use at parse time.
  * This is almost identical to `EnvDefSpec`, except it
  * 1. includes the function handler
  * 2. requires all arguments except argType

package/src/defineMacro.js

@@ -35,7 +35,7 @@ export interface MacroContextInterface {
     /**
      * Expand the next token only once if possible.
      */
-    expandOnce(expandableOnly?: boolean): Token | Token[];
+    expandOnce(expandableOnly?: boolean): number | boolean;
 
     /**
      * Expand the next token only once (if possible), and return the resulting

package/src/delimiter.js

@@ -364,7 +364,7 @@ const makeStackedDelim = function(
         middleFactor = 2; // repeat symmetrically above and below middle
     }
 
-    // Calcuate the minimal height that the delimiter can have.
+    // Calculate the minimal height that the delimiter can have.
     // It is at least the size of the top, bottom, and optional middle combined.
     const minHeight = topHeightTotal + bottomHeightTotal + middleHeightTotal;
 
@@ -453,7 +453,7 @@ const makeStackedDelim = function(
         Style.TEXT, options, classes);
 };
 
-// All surds have 0.08em padding above the viniculum inside the SVG.
+// All surds have 0.08em padding above the vinculum inside the SVG.
 // That keeps browser span height rounding error from pinching the line.
 const vbPad = 80;   // padding above the surd, measured inside the viewBox.
 const emPad = 0.08; // padding, in ems, measured in the document.
@@ -462,10 +462,10 @@ const sqrtSvg = function(
     sqrtName: string,
     height: number,
     viewBoxHeight: number,
-    extraViniculum: number,
+    extraVinculum: number,
     options: Options,
 ): SvgSpan {
-    const path = sqrtPath(sqrtName, extraViniculum, viewBoxHeight);
+    const path = sqrtPath(sqrtName, extraVinculum, viewBoxHeight);
     const pathNode = new PathNode(sqrtName, path);
 
     const svg =  new SvgNode([pathNode], {
@@ -500,9 +500,9 @@ const makeSqrtImage = function(
 
     let sizeMultiplier = newOptions.sizeMultiplier;  // default
 
-    // The standard sqrt SVGs each have a 0.04em thick viniculum.
-    // If Settings.minRuleThickness is larger than that, we add extraViniculum.
-    const extraViniculum = Math.max(0,
+    // The standard sqrt SVGs each have a 0.04em thick vinculum.
+    // If Settings.minRuleThickness is larger than that, we add extraVinculum.
+    const extraVinculum = Math.max(0,
         options.minRuleThickness - options.fontMetrics().sqrtRuleThickness);
 
     // Create a span containing an SVG image of a sqrt symbol.
@@ -514,22 +514,22 @@ const makeSqrtImage = function(
 
     // We create viewBoxes with 80 units of "padding" above each surd.
     // Then browser rounding error on the parent span height will not
-    // encroach on the ink of the viniculum. But that padding is not
+    // encroach on the ink of the vinculum. But that padding is not
     // included in the TeX-like `height` used for calculation of
     // vertical alignment. So texHeight = span.height < span.style.height.
 
     if (delim.type === "small") {
         // Get an SVG that is derived from glyph U+221A in font KaTeX-Main.
         // 1000 unit normal glyph height.
-        viewBoxHeight = 1000 + 1000 * extraViniculum + vbPad;
+        viewBoxHeight = 1000 + 1000 * extraVinculum + vbPad;
         if (height < 1.0) {
             sizeMultiplier = 1.0;   // mimic a \textfont radical
         } else if (height < 1.4) {
             sizeMultiplier = 0.7;   // mimic a \scriptfont radical
         }
-        spanHeight = (1.0 + extraViniculum + emPad) / sizeMultiplier;
-        texHeight = (1.00 + extraViniculum) / sizeMultiplier;
-        span = sqrtSvg("sqrtMain", spanHeight, viewBoxHeight, extraViniculum,
+        spanHeight = (1.0 + extraVinculum + emPad) / sizeMultiplier;
+        texHeight = (1.00 + extraVinculum) / sizeMultiplier;
+        span = sqrtSvg("sqrtMain", spanHeight, viewBoxHeight, extraVinculum,
             options);
         span.style.minWidth = "0.853em";
         advanceWidth = 0.833 / sizeMultiplier;  // from the font.
@@ -537,21 +537,21 @@ const makeSqrtImage = function(
     } else if (delim.type === "large") {
         // These SVGs come from fonts: KaTeX_Size1, _Size2, etc.
         viewBoxHeight = (1000 + vbPad) * sizeToMaxHeight[delim.size];
-        texHeight = (sizeToMaxHeight[delim.size] + extraViniculum) / sizeMultiplier;
-        spanHeight = (sizeToMaxHeight[delim.size] + extraViniculum + emPad)
+        texHeight = (sizeToMaxHeight[delim.size] + extraVinculum) / sizeMultiplier;
+        spanHeight = (sizeToMaxHeight[delim.size] + extraVinculum + emPad)
             / sizeMultiplier;
         span = sqrtSvg("sqrtSize" + delim.size, spanHeight, viewBoxHeight,
-            extraViniculum, options);
+            extraVinculum, options);
         span.style.minWidth = "1.02em";
         advanceWidth = 1.0 / sizeMultiplier; // 1.0 from the font.
 
     } else {
         // Tall sqrt. In TeX, this would be stacked using multiple glyphs.
         // We'll use a single SVG to accomplish the same thing.
-        spanHeight = height + extraViniculum + emPad;
-        texHeight = height + extraViniculum;
-        viewBoxHeight = Math.floor(1000 * height + extraViniculum) + vbPad;
-        span = sqrtSvg("sqrtTall", spanHeight, viewBoxHeight, extraViniculum,
+        spanHeight = height + extraVinculum + emPad;
+        texHeight = height + extraVinculum;
+        viewBoxHeight = Math.floor(1000 * height + extraVinculum) + vbPad;
+        span = sqrtSvg("sqrtTall", spanHeight, viewBoxHeight, extraVinculum,
             options);
         span.style.minWidth = "0.742em";
         advanceWidth = 1.056;
@@ -567,7 +567,7 @@ const makeSqrtImage = function(
         // This actually should depend on the chosen font -- e.g. \boldmath
         // should use the thicker surd symbols from e.g. KaTeX_Main-Bold, and
         // have thicker rules.
-        ruleWidth: (options.fontMetrics().sqrtRuleThickness + extraViniculum)
+        ruleWidth: (options.fontMetrics().sqrtRuleThickness + extraVinculum)
             * sizeMultiplier,
     };
 };

package/src/environments/array.js

@@ -573,8 +573,8 @@ const mathmlBuilder: MathMLBuilder<"array"> = function(group, options) {
     // We simulate this by adding (arraystretch - 1)em to the gap. This
     // does a reasonable job of adjusting arrays containing 1 em tall content.
 
-    // The 0.16 and 0.09 values are found emprically. They produce an array
-    // similar to LaTeX and in which content does not interfere with \hines.
+    // The 0.16 and 0.09 values are found empirically. They produce an array
+    // similar to LaTeX and in which content does not interfere with \hlines.
     const gap = (group.arraystretch === 0.5)
         ? 0.1  // {smallmatrix}, {subarray}
         : 0.16 + group.arraystretch - 1 + (group.addJot ? 0.09 : 0);

package/src/fontMetrics.js

@@ -13,9 +13,9 @@ import type {Mode} from "./types";
 // In TeX, there are actually three sets of dimensions, one for each of
 // textstyle (size index 5 and higher: >=9pt), scriptstyle (size index 3 and 4:
 // 7-8pt), and scriptscriptstyle (size index 1 and 2: 5-6pt).  These are
-// provided in the the arrays below, in that order.
+// provided in the arrays below, in that order.
 //
-// The font metrics are stored in fonts cmsy10, cmsy7, and cmsy5 respsectively.
+// The font metrics are stored in fonts cmsy10, cmsy7, and cmsy5 respectively.
 // This was determined by running the following script:
 //
 //     latex -interaction=nonstopmode \
@@ -25,7 +25,7 @@ import type {Mode} from "./types";
 //     '\expandafter\show\the\scriptscriptfont2' \
 //     '\stop'
 //
-// The metrics themselves were retreived using the following commands:
+// The metrics themselves were retrieved using the following commands:
 //
 //     tftopl cmsy10
 //     tftopl cmsy7
@@ -230,7 +230,7 @@ export function getCharacterMetrics(
         // So if the character is in a script we support but we
         // don't have metrics for it, just use the metrics for
         // the Latin capital letter M. This is close enough because
-        // we (currently) only care about the height of the glpyh
+        // we (currently) only care about the height of the glyph
         // not its width.
         if (supportedCodepoint(ch)) {
             metrics = metricMap[font][77]; // 77 is the charcode for 'M'

package/src/functions/arrow.js

@@ -47,7 +47,7 @@ defineFunction({
         };
     },
     // Flow is unable to correctly infer the type of `group`, even though it's
-    // unamibiguously determined from the passed-in `type` above.
+    // unambiguously determined from the passed-in `type` above.
     htmlBuilder(group: ParseNode<"xArrow">, options) {
         const style = options.style;
 

package/src/functions/delimsizing.js

@@ -342,7 +342,7 @@ defineFunction({
         return middleDelim;
     },
     mathmlBuilder: (group, options) => {
-        // A Firefox \middle will strech a character vertically only if it
+        // A Firefox \middle will stretch a character vertically only if it
         // is in the fence part of the operator dictionary at:
         // https://www.w3.org/TR/MathML3/appendixc.html.
         // So we need to avoid U+2223 and use plain "|" instead.

package/src/katex.less

@@ -432,7 +432,7 @@
     .mtable {
         .vertical-separator {
             display: inline-block;
-            // margin and border-right are set in Javascript
+            // margin and border-right are set in JavaScript
             min-width: 1px;  // Prevent Chrome from omitting a line.
         }
 

package/src/mathMLTree.js

@@ -5,7 +5,7 @@
  * since we're mainly using MathML to improve accessibility, we don't manage
  * any of the styling state that the plain DOM nodes do.
  *
- * The `toNode` and `toMarkup` functions work simlarly to how they do in
+ * The `toNode` and `toMarkup` functions work similarly to how they do in
  * domTree.js, creating namespaced DOM nodes and HTML text markup respectively.
  */
 
@@ -166,7 +166,7 @@ export class TextNode implements MathDomNode {
 
     /**
      * Converts the text node into a string
-     * (representing the text iteself).
+     * (representing the text itself).
      */
     toText(): string {
         return this.text;

package/src/parseNode.js

@@ -72,7 +72,7 @@ type ParseNodeTypes = {
     |},
     // To avoid requiring run-time type assertions, this more carefully captures
     // the requirements on the fields per the op.js htmlBuilder logic:
-    // - `body` and `value` are NEVER set simultanouesly.
+    // - `body` and `value` are NEVER set simultaneously.
     // - When `symbol` is true, `body` is set.
     "op": {|
         type: "op",