@khanacademy/perseus-linter 1.0.0 → 1.2.0

package/dist/index.js

@@ -791,12 +791,61 @@ var DoubleSpacingAfterTerminal = Rule.makeRule({
 any other kind of terminal punctuation.`
 });
 
+function buttonNotInButtonSet(name, set) {
+  return `Answer requires a button not found in the button sets: ${name} (in ${set})`;
+}
+const stringToButtonSet = {
+  "\\sqrt": "prealgebra",
+  "\\sin": "trig",
+  "\\cos": "trig",
+  "\\tan": "trig",
+  "\\log": "logarithms",
+  "\\ln": "logarithms"
+};
+
+/**
+ * Rule to make sure that Expression questions that require
+ * a specific math symbol to answer have that math symbol
+ * available in the keypad (desktop learners can use a keyboard,
+ * but mobile learners must use the MathInput keypad)
+ */
+var ExpressionWidget = Rule.makeRule({
+  name: "expression-widget",
+  severity: Rule.Severity.WARNING,
+  selector: "widget",
+  lint: function (state, content, nodes, match, context) {
+    // This rule only looks at image widgets
+    if (state.currentNode().widgetType !== "expression") {
+      return;
+    }
+    const nodeId = state.currentNode().id;
+    if (!nodeId) {
+      return;
+    }
+
+    // If it can't find a definition for the widget it does nothing
+    const widget = context?.widgets?.[nodeId];
+    if (!widget) {
+      return;
+    }
+    const answers = widget.options.answerForms;
+    const buttons = widget.options.buttonSets;
+    for (const answer of answers) {
+      for (const [str, set] of Object.entries(stringToButtonSet)) {
+        if (answer.value.includes(str) && !buttons.includes(set)) {
+          return buttonNotInButtonSet(str, set);
+        }
+      }
+    }
+  }
+});
+
 var ExtraContentSpacing = Rule.makeRule({
   name: "extra-content-spacing",
   selector: "paragraph",
   pattern: /\s+$/,
   applies: function (context) {
-    return context.contentType === "article";
+    return context?.contentType === "article";
   },
   message: `No extra whitespace at the end of content blocks.`
 });
@@ -976,9 +1025,13 @@ var ImageWidget = Rule.makeRule({
     if (state.currentNode().widgetType !== "image") {
       return;
     }
+    const nodeId = state.currentNode().id;
+    if (!nodeId) {
+      return;
+    }
 
     // If it can't find a definition for the widget it does nothing
-    const widget = context && context.widgets && context.widgets[state.currentNode().id];
+    const widget = context && context.widgets && context.widgets[nodeId];
     if (!widget) {
       return;
     }
@@ -1062,7 +1115,7 @@ var MathAlignLinebreaks = Rule.makeRule({
       const index = text.indexOf("\\\\");
       if (index === -1) {
         // No more backslash pairs, so we found no lint
-        return null;
+        return;
       }
       text = text.substring(index + 2);
 
@@ -1158,6 +1211,31 @@ nested lists are hard to read on mobile devices;
 do not use additional indentation.`
 });
 
+var StaticWidgetInQuestionStem = Rule.makeRule({
+  name: "static-widget-in-question-stem",
+  severity: Rule.Severity.WARNING,
+  selector: "widget",
+  lint: (state, content, nodes, match, context) => {
+    if (context?.contentType !== "exercise") {
+      return;
+    }
+    if (context.stack.includes("hint")) {
+      return;
+    }
+    const nodeId = state.currentNode().id;
+    if (!nodeId) {
+      return;
+    }
+    const widget = context?.widgets?.[nodeId];
+    if (!widget) {
+      return;
+    }
+    if (widget.static) {
+      return `Widget in question stem is static (non-interactive).`;
+    }
+  }
+});
+
 var TableMissingCells = Rule.makeRule({
   name: "table-missing-cells",
   severity: Rule.Severity.WARNING,
@@ -1205,7 +1283,7 @@ do not put widgets inside of tables.`
 });
 
 // TODO(davidflanagan):
-var AllRules = [AbsoluteUrl, BlockquotedMath, BlockquotedWidget, DoubleSpacingAfterTerminal, ExtraContentSpacing, HeadingLevel1, HeadingLevelSkip, HeadingSentenceCase, HeadingTitleCase, ImageAltText, ImageInTable, LinkClickHere, LongParagraph, MathAdjacent, MathAlignExtraBreak, MathAlignLinebreaks, MathEmpty, MathFontSize, MathFrac, MathNested, MathStartsWithSpace, MathTextEmpty, NestedLists, TableMissingCells, UnescapedDollar, WidgetInTable, MathWithoutDollars, UnbalancedCodeDelimiters, ImageSpacesAroundUrls, ImageWidget];
+var AllRules = [AbsoluteUrl, BlockquotedMath, BlockquotedWidget, DoubleSpacingAfterTerminal, ExpressionWidget, ExtraContentSpacing, HeadingLevel1, HeadingLevelSkip, HeadingSentenceCase, HeadingTitleCase, ImageAltText, ImageInTable, LinkClickHere, LongParagraph, MathAdjacent, MathAlignExtraBreak, MathAlignLinebreaks, MathEmpty, MathFontSize, MathFrac, MathNested, MathStartsWithSpace, MathTextEmpty, NestedLists, StaticWidgetInQuestionStem, TableMissingCells, UnescapedDollar, WidgetInTable, MathWithoutDollars, UnbalancedCodeDelimiters, ImageSpacesAroundUrls, ImageWidget];
 
 /**
  * TreeTransformer is a class for traversing and transforming trees.  Create a
@@ -1752,7 +1830,7 @@ class Stack {
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/perseus-linter";
-const libVersion = "1.0.0";
+const libVersion = "1.2.0";
 perseusCore.addLibraryVersionToPerseusDebug(libName, libVersion);
 
 // Define the shape of the linter context object that is passed through the