@khanacademy/perseus-linter 0.0.0-PR862-20231207182234 → 0.0.0-PR875-20240813215114

package/dist/index.js

@@ -2,7 +2,6 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var perseusError = require('@khanacademy/perseus-error');
 var perseusCore = require('@khanacademy/perseus-core');
 var PropTypes = require('prop-types');
 
@@ -29,7 +28,7 @@ class Selector {
    * subclasses must provide an implementation of this method.
    */
   match(state) {
-    throw new perseusError.PerseusError("Selector subclasses must implement match()", perseusError.Errors.NotAllowed);
+    throw new perseusCore.PerseusError("Selector subclasses must implement match()", perseusCore.Errors.NotAllowed);
   }
 
   /**
@@ -51,9 +50,9 @@ class Selector {
  * Instead call the static Selector.parse() method.
  */
 class Parser {
-  // We do lexing with a simple regular expression
-  // The array of tokens
-  // Which token in the array we're looking at now
+  static TOKENS; // We do lexing with a simple regular expression
+  tokens; // The array of tokens
+  tokenIndex; // Which token in the array we're looking at now
 
   constructor(s) {
     // Normalize whitespace:
@@ -212,6 +211,7 @@ class ParseError extends Error {
  * first.
  */
 class SelectorList extends Selector {
+  selectors;
   constructor(selectors) {
     super();
     this.selectors = selectors;
@@ -254,6 +254,7 @@ class AnyNode extends Selector {
  * it matches any node whose `type` property is a specified string
  */
 class TypeSelector extends Selector {
+  type;
   constructor(type) {
     super();
     this.type = type;
@@ -277,6 +278,8 @@ class TypeSelector extends Selector {
  * method.
  */
 class SelectorCombinator extends Selector {
+  left;
+  right;
   constructor(left, right) {
     super();
     this.left = left;
@@ -543,20 +546,21 @@ class SiblingCombinator extends SelectorCombinator {
  * this file for detailed description.
  */
 class Rule {
-  // The name of the rule
-  // The severity of the rule
-  // The specified selector or the DEFAULT_SELECTOR
-  // A regular expression if one was specified
-  // The lint-testing function or a default
-  // Checks to see if we should apply a rule or not
-  // The error message for use with the default function
+  name; // The name of the rule
+  severity; // The severity of the rule
+  selector; // The specified selector or the DEFAULT_SELECTOR
+  pattern; // A regular expression if one was specified
+  lint; // The lint-testing function or a default
+  applies; // Checks to see if we should apply a rule or not
+  message; // The error message for use with the default function
+  static DEFAULT_SELECTOR;
 
   // The comment at the top of this file has detailed docs for
   // this constructor and its arguments
   constructor(name, severity, selector, pattern, lint, applies) {
     var _this = this;
     if (!selector && !pattern) {
-      throw new perseusError.PerseusError("Lint rules must have a selector or pattern", perseusError.Errors.InvalidInput, {
+      throw new perseusCore.PerseusError("Lint rules must have a selector or pattern", perseusCore.Errors.InvalidInput, {
         metadata: {
           name
         }
@@ -1154,12 +1158,25 @@ nested lists are hard to read on mobile devices;
 do not use additional indentation.`
 });
 
-var Profanity = Rule.makeRule({
-  name: "profanity",
-  // This list could obviously be expanded a lot, but I figured we
-  // could start with https://en.wikipedia.org/wiki/Seven_dirty_words
-  pattern: /\b(shit|piss|fuck|cunt|cocksucker|motherfucker|tits)\b/i,
-  message: "Avoid profanity"
+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 widget = context?.widgets?.[state.currentNode().id];
+    if (!widget) {
+      return;
+    }
+    if (widget.static) {
+      return `Widget in question stem is static (non-interactive).`;
+    }
+  }
 });
 
 var TableMissingCells = Rule.makeRule({
@@ -1209,7 +1226,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, Profanity, MathWithoutDollars, UnbalancedCodeDelimiters, ImageSpacesAroundUrls, ImageWidget];
+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];
 
 /**
  * TreeTransformer is a class for traversing and transforming trees.  Create a
@@ -1277,6 +1294,8 @@ var AllRules = [AbsoluteUrl, BlockquotedMath, BlockquotedWidget, DoubleSpacingAf
 // This is the TreeTransformer class described in detail at the
 // top of this file.
 class TreeTransformer {
+  root;
+
   // To create a tree transformer, just pass the root node of the tree
   constructor(root) {
     this.root = root;
@@ -1424,6 +1443,7 @@ class TreeTransformer {
  **/
 class TraversalState {
   // The root node of the tree being traversed
+  root;
 
   // These are internal state properties. Use the accessor methods defined
   // below instead of using these properties directly. Note that the
@@ -1431,6 +1451,11 @@ class TraversalState {
   // elements, depending on whether we just recursed on an array or on a
   // node. This is hard for TypeScript to deal with, so you'll see a number of
   // type casts through the any type when working with these two properties.
+  _currentNode;
+  _containers;
+  _indexes;
+  _ancestors;
+
   // The constructor just stores the root node and creates empty stacks.
   constructor(root) {
     this.root = root;
@@ -1558,7 +1583,7 @@ class TraversalState {
   replace() {
     const parent = this._containers.top();
     if (!parent) {
-      throw new perseusError.PerseusError("Can't replace the root of the tree", perseusError.Errors.Internal);
+      throw new perseusCore.PerseusError("Can't replace the root of the tree", perseusCore.Errors.Internal);
     }
 
     // The top of the container stack is either an array or an object
@@ -1611,7 +1636,7 @@ class TraversalState {
    */
   goToPreviousSibling() {
     if (!this.hasPreviousSibling()) {
-      throw new perseusError.PerseusError("goToPreviousSibling(): node has no previous sibling", perseusError.Errors.Internal);
+      throw new perseusCore.PerseusError("goToPreviousSibling(): node has no previous sibling", perseusCore.Errors.Internal);
     }
     this._currentNode = this.previousSibling();
     // Since we know that we have a previous sibling, we know that
@@ -1641,7 +1666,7 @@ class TraversalState {
    */
   goToParent() {
     if (!this.hasParent()) {
-      throw new perseusError.PerseusError("goToParent(): node has no ancestor", perseusError.Errors.NotAllowed);
+      throw new perseusCore.PerseusError("goToParent(): node has no ancestor", perseusCore.Errors.NotAllowed);
     }
     this._currentNode = this._ancestors.pop();
 
@@ -1688,6 +1713,7 @@ class TraversalState {
  * the TraversalState class simpler in a number of places.
  */
 class Stack {
+  stack;
   constructor(array) {
     this.stack = array ? array.slice(0) : [];
   }
@@ -1747,7 +1773,7 @@ class Stack {
 
 // This file is processed by a Rollup plugin (replace) to inject the production
 const libName = "@khanacademy/perseus-linter";
-const libVersion = "0.3.9";
+const libVersion = "1.0.0";
 perseusCore.addLibraryVersionToPerseusDebug(libName, libVersion);
 
 // Define the shape of the linter context object that is passed through the