@khanacademy/perseus-linter 0.0.0-PR875-20240813215114 → 0.0.0-PR875-20250222011102

package/LICENSE

@@ -0,0 +1,18 @@
+Copyright 2022 Khan Academy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
+Software, and to permit persons to whom the Software is furnished to do so, subject
+to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
+AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/es/index.js

@@ -1,21 +1,7 @@
-import { PerseusError, Errors, addLibraryVersionToPerseusDebug } from '@khanacademy/perseus-core';
+import _extends from '@babel/runtime/helpers/extends';
+import { PerseusError, Errors } from '@khanacademy/perseus-core';
 import PropTypes from 'prop-types';
 
-function _extends() {
-  _extends = Object.assign ? Object.assign.bind() : function (target) {
-    for (var i = 1; i < arguments.length; i++) {
-      var source = arguments[i];
-      for (var key in source) {
-        if (Object.prototype.hasOwnProperty.call(source, key)) {
-          target[key] = source[key];
-        }
-      }
-    }
-    return target;
-  };
-  return _extends.apply(this, arguments);
-}
-
 /* eslint-disable no-useless-escape */
 /**
  * This is the base class for all Selector types. The key method that all
@@ -535,22 +521,27 @@ class SiblingCombinator extends SelectorCombinator {
 // This represents the type returned by String.match(). It is an
 // array of strings, but also has index:number and input:string properties.
 // TypeScript doesn't handle it well, so we punt and just use any.
+
 // This is the return type of the check() method of a Rule object
+
 // This is the return type of the lint detection function passed as the 4th
 // argument to the Rule() constructor. It can return null or a string or an
 // object containing a string and two numbers.
 // prettier-ignore
 // (prettier formats this in a way that ka-lint does not like)
+
 // This is the type of the lint detection function that the Rule() constructor
 // expects as its fourth argument. It is passed the TraversalState object and
 // content string that were passed to check(), and is also passed the array of
 // nodes returned by the selector match and the array of strings returned by
 // the pattern match. It should return null if no lint is detected or an
 // error message or an object contining an error message.
+
 // An optional check to verify whether or not a particular rule should
 // be checked by context. For example, some rules only apply in exercises,
 // and should never be applied to articles. Defaults to true, so if we
 // omit the applies function in a rule, it'll be tested everywhere.
+
 /**
  * A Rule object describes a Perseus lint rule. See the comment at the top of
  * this file for detailed description.
@@ -639,7 +630,6 @@ class Rule {
       if (!error) {
         return null; // No lint; we're done
       }
-
       if (typeof error === "string") {
         // If the lint function returned a string we assume it
         // applies to the entire content of the node and return it.
@@ -804,12 +794,62 @@ 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) {
+    var _context$widgets;
+    // 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 == null || (_context$widgets = context.widgets) == null ? void 0 : _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 == null ? void 0 : context.contentType) === "article";
   },
   message: `No extra whitespace at the end of content blocks.`
 });
@@ -974,6 +1014,28 @@ Whitespace in image URLs causes translation difficulties.`;
   }
 });
 
+var ImageUrlEmpty = Rule.makeRule({
+  name: "image-url-empty",
+  severity: Rule.Severity.ERROR,
+  selector: "image",
+  lint: function (state, content, nodes) {
+    const image = nodes[0];
+    const url = image.target;
+
+    // If no URL is provided, an infinite spinner will be shown in articles
+    // overlaying the page where the image should be. This prevents the page
+    // from fully loading. As a result, we check for URLS with all images.
+    if (!url || !url.trim()) {
+      return "Images should have a URL";
+    }
+
+    // NOTE(TB): Ideally there would be a check to confirm the URL works
+    // and leads to a valid resource, but fetching the URL would require
+    // linting to be able to handle async functions, which it currently
+    // cannot do.
+  }
+});
+
 // Normally we have one rule per file. But since our selector class
 // can't match specific widget types directly, this rule implements
 // a number of image widget related rules in one place. This should
@@ -989,9 +1051,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;
     }
@@ -1075,7 +1141,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);
 
@@ -1106,15 +1172,6 @@ var MathEmpty = Rule.makeRule({
   message: "Empty math: don't use $$ in your markdown."
 });
 
-var MathFontSize = Rule.makeRule({
-  name: "math-font-size",
-  severity: Rule.Severity.GUIDELINE,
-  selector: "math, blockMath",
-  pattern: /\\(tiny|Tiny|small|large|Large|LARGE|huge|Huge|scriptsize|normalsize)\s*{/,
-  message: `Math font size:
-Don't change the default font size with \\Large{} or similar commands`
-});
-
 var MathFrac = Rule.makeRule({
   name: "math-frac",
   severity: Rule.Severity.GUIDELINE,
@@ -1177,13 +1234,17 @@ var StaticWidgetInQuestionStem = Rule.makeRule({
   selector: "widget",
   lint: (state, content, nodes, match, context) => {
     var _context$widgets;
-    if (context.contentType !== "exercise") {
+    if ((context == null ? void 0 : context.contentType) !== "exercise") {
       return;
     }
     if (context.stack.includes("hint")) {
       return;
     }
-    const widget = context == null || (_context$widgets = context.widgets) == null ? void 0 : _context$widgets[state.currentNode().id];
+    const nodeId = state.currentNode().id;
+    if (!nodeId) {
+      return;
+    }
+    const widget = context == null || (_context$widgets = context.widgets) == null ? void 0 : _context$widgets[nodeId];
     if (!widget) {
       return;
     }
@@ -1240,7 +1301,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, StaticWidgetInQuestionStem, TableMissingCells, UnescapedDollar, WidgetInTable, MathWithoutDollars, UnbalancedCodeDelimiters, ImageSpacesAroundUrls, ImageWidget];
+var AllRules = [AbsoluteUrl, BlockquotedMath, BlockquotedWidget, DoubleSpacingAfterTerminal, ImageUrlEmpty, ExpressionWidget, ExtraContentSpacing, HeadingLevel1, HeadingLevelSkip, HeadingSentenceCase, HeadingTitleCase, ImageAltText, ImageInTable, LinkClickHere, LongParagraph, MathAdjacent, MathAlignExtraBreak, MathAlignLinebreaks, MathEmpty, MathFrac, MathNested, MathStartsWithSpace, MathTextEmpty, NestedLists, StaticWidgetInQuestionStem, TableMissingCells, UnescapedDollar, WidgetInTable, MathWithoutDollars, UnbalancedCodeDelimiters, ImageSpacesAroundUrls, ImageWidget];
 
 /**
  * TreeTransformer is a class for traversing and transforming trees.  Create a
@@ -1302,9 +1363,11 @@ var AllRules = [AbsoluteUrl, BlockquotedMath, BlockquotedWidget, DoubleSpacingAf
 
 // TreeNode is the type of a node in a parse tree. The only real requirement is
 // that every node has a string-valued `type` property
+
 // TraversalCallback is the type of the callback function passed to the
 // traverse() method. It is invoked with node, state, and content arguments
 // and is expected to return nothing.
+
 // This is the TreeTransformer class described in detail at the
 // top of this file.
 class TreeTransformer {
@@ -1779,9 +1842,51 @@ class Stack {
   }
 }
 
+/**
+ * Adds the given perseus library version information to the __perseus_debug__
+ * object and ensures that the object is attached to `globalThis` (`window` in
+ * browser environments).
+ *
+ * This allows each library to provide runtime version information to assist in
+ * debugging in production environments.
+ */
+const addLibraryVersionToPerseusDebug = (libraryName, libraryVersion) => {
+  // If the library version is the default value, then we don't want to
+  // prefix it with a "v" to indicate that it is a version number.
+  let prefix = "v";
+  if (libraryVersion === "__lib_version__") {
+    prefix = "";
+  }
+  const formattedVersion = `${prefix}${libraryVersion}`;
+  if (typeof globalThis !== "undefined") {
+    var _globalThis$__perseus;
+    globalThis.__perseus_debug__ = (_globalThis$__perseus = globalThis.__perseus_debug__) != null ? _globalThis$__perseus : {};
+    const existingVersionEntry = globalThis.__perseus_debug__[libraryName];
+    if (existingVersionEntry) {
+      // If we already have an entry and it doesn't match the registered
+      // version, we morph the entry into an array and log a warning.
+      if (existingVersionEntry !== formattedVersion) {
+        // Existing entry might be an array already (oops, at least 2
+        // versions of the library already loaded!).
+        const allVersions = Array.isArray(existingVersionEntry) ? existingVersionEntry : [existingVersionEntry];
+        allVersions.push(formattedVersion);
+        globalThis.__perseus_debug__[libraryName] = allVersions;
+
+        // eslint-disable-next-line no-console
+        console.warn(`Multiple versions of ${libraryName} loaded on this page: ${allVersions.sort().join(", ")}`);
+      }
+    } else {
+      globalThis.__perseus_debug__[libraryName] = formattedVersion;
+    }
+  } else {
+    // eslint-disable-next-line no-console
+    console.warn(`globalThis not found found (${formattedVersion})`);
+  }
+};
+
 // 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.18";
 addLibraryVersionToPerseusDebug(libName, libVersion);
 
 // Define the shape of the linter context object that is passed through the