katex 0.10.1 → 0.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "katex",
-  "version": "0.10.1",
+  "version": "0.12.0",
   "description": "Fast math typesetting for the web.",
   "main": "dist/katex.js",
   "homepage": "https://katex.org",
@@ -28,19 +28,20 @@
     "babel-jest": "^24.1.0",
     "babel-loader": "^8.0.5",
     "babel-plugin-istanbul": "^5.1.1",
+    "babel-plugin-preval": "^3.0.1",
     "babel-plugin-version-inline": "^1.0.0",
     "benchmark": "^2.1.4",
-    "browserslist": "^4.4.1",
-    "caniuse-lite": "^1.0.30000938",
+    "browserslist": "^4.7.1",
+    "caniuse-lite": "^1.0.30001002",
     "codecov": "^3.2.0",
-    "css-loader": "^2.1.0",
+    "css-loader": "^3.0.0",
     "cssnano": "^4.1.10",
     "eslint": "^5.14.1",
     "eslint-plugin-flowtype": "^3.4.2",
     "eslint-plugin-react": "^7.12.4",
     "eslint-plugin-transform-runtime-aliasing": "^2.0.0",
     "file-loader": "^3.0.1",
-    "flow-bin": "^0.93.0",
+    "flow-bin": "^0.102.0",
     "fs-extra": "^7.0.1",
     "husky": "^1.3.1",
     "istanbul-api": "^2.1.1",
@@ -56,6 +57,7 @@
     "mkdirp": "^0.5.1",
     "pako": "^1.0.8",
     "postcss-loader": "^3.0.0",
+    "prettier": "^1.18.2",
     "query-string": "^6.2.0",
     "rimraf": "^2.6.3",
     "rollup": "^1.2.2",
@@ -74,7 +76,7 @@
   },
   "bin": "cli.js",
   "scripts": {
-    "test": "yarn prestart && yarn test:lint && yarn test:flow && yarn test:jest",
+    "test": "yarn test:lint && yarn test:flow && yarn test:jest",
     "test:lint": "yarn test:lint:js && yarn test:lint:css",
     "test:lint:js": "eslint *.js src static test contrib dockers website",
     "test:lint:css": "stylelint src/katex.less static/main.css contrib/**/*.css website/static/**/*.css",
@@ -84,14 +86,13 @@
     "test:jest:update": "jest --updateSnapshot",
     "test:jest:coverage": "jest --coverage",
     "test:screenshots": "yarn test:screenshots:update --verify",
-    "test:screenshots:update": "yarn prestart && dockers/screenshotter/screenshotter.sh",
-    "test:perf": "yarn prestart && NODE_ENV=test node test/perf-test.js",
+    "test:screenshots:update": "dockers/screenshotter/screenshotter.sh",
+    "test:perf": "NODE_ENV=test node test/perf-test.js",
     "clean": "rm -rf dist/ node_modules/",
     "clean-install": "yarn clean && yarn",
-    "prestart": "node src/unicodeMake.js",
     "start": "webpack-dev-server --hot --config webpack.dev.js",
     "analyze": "webpack --config webpack.analyze.js",
-    "build": "yarn prestart && rimraf dist/ && mkdirp dist && cp README.md dist && rollup -c && webpack",
+    "build": "rimraf dist/ && mkdirp dist && cp README.md dist && rollup -c && webpack",
     "watch": "yarn build --watch",
     "dist": "yarn test && yarn build && yarn dist:zip",
     "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/"
@@ -110,7 +111,7 @@
     "collectCoverageFrom": [
       "src/**/*.js",
       "contrib/**/*.js",
-      "!src/unicodeMake.js",
+      "!src/unicodeSymbols.js",
       "!contrib/mhchem/**"
     ],
     "setupFilesAfterEnv": [

package/src/Lexer.js

@@ -51,6 +51,7 @@ const tokenRegexString = `(${spaceRegexString}+)|` +  // whitespace
     `${combiningDiacriticalMarkString}*` +            // ...plus accents
     "|\\\\verb\\*([^]).*?\\3" +                       // \verb*
     "|\\\\verb([^*a-zA-Z]).*?\\4" +                   // \verb unstarred
+    "|\\\\operatorname\\*" +                          // \operatorname*
     `|${controlWordWhitespaceRegexString}` +          // \macroName + spaces
     `|${controlSymbolRegexString})`;                  // \\, \', etc.
 

package/src/MacroExpander.js

@@ -180,13 +180,19 @@ export default class MacroExpander implements MacroContextInterface {
      * At the moment, macro expansion doesn't handle delimited macros,
      * i.e. things like those defined by \def\foo#1\end{…}.
      * See the TeX book page 202ff. for details on how those should behave.
+     *
+     * If expandableOnly, only expandable tokens are expanded and
+     * an undefined control sequence results in an error.
      */
-    expandOnce(): Token | Token[] {
+    expandOnce(expandableOnly?: boolean): Token | Token[] {
         const topToken = this.popToken();
         const name = topToken.text;
-        const expansion = this._getExpansion(name);
-        if (expansion == null) { // mainly checking for undefined here
-            // Fully expanded
+        const expansion = !topToken.noexpand ? this._getExpansion(name) : null;
+        if (expansion == null || (expandableOnly && expansion.unexpandable)) {
+            if (expandableOnly && expansion == null &&
+                    name[0] === "\\" && !this.isDefined(name)) {
+                throw new ParseError("Undefined control sequence: " + name);
+            }
             this.pushToken(topToken);
             return topToken;
         }
@@ -248,7 +254,9 @@ export default class MacroExpander implements MacroContextInterface {
             if (expanded instanceof Token) {
                 // \relax stops the expansion, but shouldn't get returned (a
                 // null return value couldn't get implemented as a function).
-                if (expanded.text === "\\relax") {
+                // the token after \noexpand is interpreted as if its meaning
+                // were ‘\relax’
+                if (expanded.text === "\\relax" || expanded.treatAsRelax) {
                     this.stack.pop();
                 } else {
                     return this.stack.pop();  // === expanded
@@ -266,16 +274,26 @@ export default class MacroExpander implements MacroContextInterface {
      * tokens, or return `undefined` if no such macro is defined.
      */
     expandMacro(name: string): Token[] | void {
-        if (!this.macros.get(name)) {
-            return undefined;
-        }
+        return this.macros.has(name)
+            ? this.expandTokens([new Token(name)]) : undefined;
+    }
+
+    /**
+     * Fully expand the given token stream and return the resulting list of tokens
+     */
+    expandTokens(tokens: Token[]): Token[] {
         const output = [];
         const oldStackLength = this.stack.length;
-        this.pushToken(new Token(name));
+        this.pushTokens(tokens);
         while (this.stack.length > oldStackLength) {
-            const expanded = this.expandOnce();
+            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) {
+                    // the expansion of \noexpand is the token itself
+                    expanded.noexpand = false;
+                    expanded.treatAsRelax = false;
+                }
                 output.push(this.stack.pop());
             }
         }
@@ -342,4 +360,15 @@ export default class MacroExpander implements MacroContextInterface {
             symbols.text.hasOwnProperty(name) ||
             implicitCommands.hasOwnProperty(name);
     }
+
+    /**
+     * Determine whether a command is expandable.
+     */
+    isExpandable(name: string): boolean {
+        const macro = this.macros.get(name);
+        return macro != null ? typeof macro === "string"
+                || typeof macro === "function" || !macro.unexpandable
+            // TODO(ylem): #2085
+            : functions.hasOwnProperty(name)/* && !functions[name].primitive*/;
+    }
 }

package/src/Options.js

@@ -36,6 +36,10 @@ const sizeAtStyle = function(size: number, style: StyleInterface): number {
     return style.size < 2 ? size : sizeStyleMap[size - 1][style.size - 1];
 };
 
+// In these types, "" (empty string) means "no change".
+export type FontWeight = "textbf" | "textmd" | "";
+export type FontShape = "textit" | "textup" | "";
+
 export type OptionsData = {
     style: StyleInterface;
     color?: string | void;
@@ -44,10 +48,11 @@ export type OptionsData = {
     phantom?: boolean;
     font?: string;
     fontFamily?: string;
-    fontWeight?: string;
-    fontShape?: string;
+    fontWeight?: FontWeight;
+    fontShape?: FontShape;
     sizeMultiplier?: number;
     maxSize: number;
+    minRuleThickness: number;
 };
 
 /**
@@ -68,10 +73,11 @@ class Options {
     // See: https://tex.stackexchange.com/questions/22350/difference-between-textrm-and-mathrm
     font: string;
     fontFamily: string;
-    fontWeight: string;
-    fontShape: string;
+    fontWeight: FontWeight;
+    fontShape: FontShape;
     sizeMultiplier: number;
     maxSize: number;
+    minRuleThickness: number;
     _fontMetrics: FontMetrics | void;
 
     /**
@@ -91,6 +97,7 @@ class Options {
         this.fontShape = data.fontShape || '';
         this.sizeMultiplier = sizeMultipliers[this.size - 1];
         this.maxSize = data.maxSize;
+        this.minRuleThickness = data.minRuleThickness;
         this._fontMetrics = undefined;
     }
 
@@ -110,6 +117,7 @@ class Options {
             fontWeight: this.fontWeight,
             fontShape: this.fontShape,
             maxSize: this.maxSize,
+            minRuleThickness: this.minRuleThickness,
         };
 
         for (const key in extension) {
@@ -244,7 +252,7 @@ class Options {
     /**
      * Creates a new options object with the given font weight
      */
-    withTextFontWeight(fontWeight: string): Options {
+    withTextFontWeight(fontWeight: FontWeight): Options {
         return this.extend({
             fontWeight,
             font: "",
@@ -254,7 +262,7 @@ class Options {
     /**
      * Creates a new options object with the given font weight
      */
-    withTextFontShape(fontShape: string): Options {
+    withTextFontShape(fontShape: FontShape): Options {
         return this.extend({
             fontShape,
             font: "",
@@ -295,81 +303,13 @@ class Options {
         return this._fontMetrics;
     }
 
-    /**
-     * A map of color names to CSS colors.
-     * TODO(emily): Remove this when we have real macros
-     */
-    static colorMap = {
-        "katex-blue": "#6495ed",
-        "katex-orange": "#ffa500",
-        "katex-pink": "#ff00af",
-        "katex-red": "#df0030",
-        "katex-green": "#28ae7b",
-        "katex-gray": "gray",
-        "katex-purple": "#9d38bd",
-        "katex-blueA": "#ccfaff",
-        "katex-blueB": "#80f6ff",
-        "katex-blueC": "#63d9ea",
-        "katex-blueD": "#11accd",
-        "katex-blueE": "#0c7f99",
-        "katex-tealA": "#94fff5",
-        "katex-tealB": "#26edd5",
-        "katex-tealC": "#01d1c1",
-        "katex-tealD": "#01a995",
-        "katex-tealE": "#208170",
-        "katex-greenA": "#b6ffb0",
-        "katex-greenB": "#8af281",
-        "katex-greenC": "#74cf70",
-        "katex-greenD": "#1fab54",
-        "katex-greenE": "#0d923f",
-        "katex-goldA": "#ffd0a9",
-        "katex-goldB": "#ffbb71",
-        "katex-goldC": "#ff9c39",
-        "katex-goldD": "#e07d10",
-        "katex-goldE": "#a75a05",
-        "katex-redA": "#fca9a9",
-        "katex-redB": "#ff8482",
-        "katex-redC": "#f9685d",
-        "katex-redD": "#e84d39",
-        "katex-redE": "#bc2612",
-        "katex-maroonA": "#ffbde0",
-        "katex-maroonB": "#ff92c6",
-        "katex-maroonC": "#ed5fa6",
-        "katex-maroonD": "#ca337c",
-        "katex-maroonE": "#9e034e",
-        "katex-purpleA": "#ddd7ff",
-        "katex-purpleB": "#c6b9fc",
-        "katex-purpleC": "#aa87ff",
-        "katex-purpleD": "#7854ab",
-        "katex-purpleE": "#543b78",
-        "katex-mintA": "#f5f9e8",
-        "katex-mintB": "#edf2df",
-        "katex-mintC": "#e0e5cc",
-        "katex-grayA": "#f6f7f7",
-        "katex-grayB": "#f0f1f2",
-        "katex-grayC": "#e3e5e6",
-        "katex-grayD": "#d6d8da",
-        "katex-grayE": "#babec2",
-        "katex-grayF": "#888d93",
-        "katex-grayG": "#626569",
-        "katex-grayH": "#3b3e40",
-        "katex-grayI": "#21242c",
-        "katex-kaBlue": "#314453",
-        "katex-kaGreen": "#71B307",
-    };
 
     /**
-     * Gets the CSS color of the current options object, accounting for the
-     * `colorMap`.
+     * Gets the CSS color of the current options object
      */
     getColor(): string | void {
         if (this.phantom) {
             return "transparent";
-        } else if (
-            this.color != null &&
-            Options.colorMap.hasOwnProperty(this.color)
-        ) {
-            return Options.colorMap[this.color];
         } else {
             return this.color;
         }