@khanacademy/perseus-linter 0.3.8 → 0.3.10

package/dist/index.js

@@ -10,35 +10,7 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
 
-function _defineProperty(obj, key, value) {
-  key = _toPropertyKey(key);
-  if (key in obj) {
-    Object.defineProperty(obj, key, {
-      value: value,
-      enumerable: true,
-      configurable: true,
-      writable: true
-    });
-  } else {
-    obj[key] = value;
-  }
-  return obj;
-}
-function _toPrimitive(input, hint) {
-  if (typeof input !== "object" || input === null) return input;
-  var prim = input[Symbol.toPrimitive];
-  if (prim !== undefined) {
-    var res = prim.call(input, hint || "default");
-    if (typeof res !== "object") return res;
-    throw new TypeError("@@toPrimitive must return a primitive value.");
-  }
-  return (hint === "string" ? String : Number)(input);
-}
-function _toPropertyKey(arg) {
-  var key = _toPrimitive(arg, "string");
-  return typeof key === "symbol" ? key : String(key);
-}
-
+/* eslint-disable no-useless-escape */
 /**
  * This is the base class for all Selector types. The key method that all
  * selector subclasses must implement is match(). It takes a TraversalState
@@ -84,8 +56,6 @@ class Parser {
   // Which token in the array we're looking at now
 
   constructor(s) {
-    _defineProperty(this, "tokens", void 0);
-    _defineProperty(this, "tokenIndex", void 0);
     // Normalize whitespace:
     // - remove leading and trailing whitespace
     // - replace runs of whitespace with single space characters
@@ -224,7 +194,6 @@ class Parser {
 // are identifiers, integers, punctuation and spaces. Note that spaces
 // tokens are only returned when they appear before an identifier or
 // wildcard token and are otherwise omitted.
-_defineProperty(Parser, "TOKENS", void 0);
 Parser.TOKENS = /([a-zA-Z][\w-]*)|(\d+)|[^\s]|(\s(?=[a-zA-Z\*]))/g;
 
 /**
@@ -245,7 +214,6 @@ class ParseError extends Error {
 class SelectorList extends Selector {
   constructor(selectors) {
     super();
-    _defineProperty(this, "selectors", void 0);
     this.selectors = selectors;
   }
   match(state) {
@@ -288,7 +256,6 @@ class AnyNode extends Selector {
 class TypeSelector extends Selector {
   constructor(type) {
     super();
-    _defineProperty(this, "type", void 0);
     this.type = type;
   }
   match(state) {
@@ -312,8 +279,6 @@ class TypeSelector extends Selector {
 class SelectorCombinator extends Selector {
   constructor(left, right) {
     super();
-    _defineProperty(this, "left", void 0);
-    _defineProperty(this, "right", void 0);
     this.left = left;
     this.right = right;
   }
@@ -431,6 +396,148 @@ class SiblingCombinator extends SelectorCombinator {
   }
 }
 
+/**
+ * The Rule class represents a Perseus lint rule. A Rule instance has a check()
+ * method that takes the same (node, state, content) arguments that a
+ * TreeTransformer traversal callback function does. Call the check() method
+ * during a tree traversal to determine whether the current node of the tree
+ * violates the rule. If there is no violation, then check() returns
+ * null. Otherwise, it returns an object that includes the name of the rule,
+ * an error message, and the start and end positions within the node's content
+ * string of the lint.
+ *
+ * A Perseus lint rule consists of a name, a severity, a selector, a pattern
+ * (RegExp) and two functions. The check() method uses the selector, pattern,
+ * and functions as follows:
+ *
+ * - First, when determining which rules to apply to a particular piece of
+ *   content, each rule can specify an optional function provided in the fifth
+ *   parameter to evaluate whether or not we should be applying this rule.
+ *   If the function returns false, we don't use the rule on this content.
+ *
+ * - Next, check() tests whether the node currently being traversed matches
+ *   the selector. If it does not, then the rule does not apply at this node
+ *   and there is no lint and check() returns null.
+ *
+ * - If the selector matched, then check() tests the text content of the node
+ *   (and its children) against the pattern. If the pattern does not match,
+ *   then there is no lint, and check() returns null.
+ *
+ * - If both the selector and pattern match, then check() calls the function
+ *   passing the TraversalState object, the content string for the node, the
+ *   array of nodes returned by the selector match, and the array of strings
+ *   returned by the pattern match. This function can use these arguments to
+ *   implement any kind of lint detection logic it wants. If it determines
+ *   that there is no lint, then it should return null. Otherwise, it should
+ *   return an error message as a string, or an object with `message`, `start`
+ *   and `end` properties. The start and end properties are numbers that mark
+ *   the beginning and end of the problematic content. Note that these numbers
+ *   are relative to the content string passed to the traversal callback, not
+ *   to the entire string that was used to generate the parse tree in the
+ *   first place. TODO(davidflanagan): modify the simple-markdown library to
+ *   have an option to add the text offset of each node to the parse
+ *   tree. This will allows us to pinpoint lint errors within a long string
+ *   of markdown text.
+ *
+ * - If the function returns null, then check() returns null. Otherwise,
+ *   check() returns an object with `rule`, `message`, `start` and `end`
+ *   properties. The value of the `rule` property is the name of the rule,
+ *   which is useful for error reporting purposes.
+ *
+ * The name, severity, selector, pattern and function arguments to the Rule()
+ * constructor are optional, but you may not omit both the selector and the
+ * pattern. If you do not specify a selector, a default selector that matches
+ * any node of type "text" will be used. If you do not specify a pattern, then
+ * any node that matches the selector will be assumed to match the pattern as
+ * well. If you don't pass a function as the fourth argument to the Rule()
+ * constructor, then you must pass an error message string instead. If you do
+ * this, you'll get a default function that unconditionally returns an object
+ * that includes the error message and the start and end indexes of the
+ * portion of the content string that matched the pattern. If you don't pass a
+ * function in the fifth parameter, the rule will be applied in any context.
+ *
+ * One of the design goals of this Rule class is to allow simple lint rules to
+ * be described in JSON files without any JavaScript code. So in addition to
+ * the Rule() constructor, the class also defines a Rule.makeRule() factory
+ * method. This method takes a single object as its argument and expects the
+ * object to have four string properties. The `name` property is passed as the
+ * first argument to the Rule() construtctor.  The optional `selector`
+ * property, if specified, is passed to Selector.parse() and the resulting
+ * Selector object is used as the second argument to Rule().  The optional
+ * `pattern` property is converted to a RegExp before being passed as the
+ * third argument to Rule(). (See Rule.makePattern() for details on the string
+ * to RegExp conversion). Finally, the `message` property specifies an error
+ * message that is passed as the final argument to Rule(). You can also use a
+ * real RegExp as the value of the `pattern` property or define a custom lint
+ * function on the `lint` property instead of setting the `message`
+ * property. Doing either of these things means that your rule description can
+ * no longer be saved in a JSON file, however.
+ *
+ * For example, here are two lint rules defined with Rule.makeRule():
+ *
+ *    let nestedLists = Rule.makeRule({
+ *        name: "nested-lists",
+ *        selector: "list list",
+ *        message: `Nested lists:
+ *    nested lists are hard to read on mobile devices;
+ *    do not use additional indentation.`,
+ *    });
+ *
+ *    let longParagraph = Rule.makeRule({
+ *        name: "long-paragraph",
+ *        selector: "paragraph",
+ *        pattern: /^.{501,}/,
+ *        lint: function(state, content, nodes, match) {
+ *            return `Paragraph too long:
+ *    This paragraph is ${content.length} characters long.
+ *    Shorten it to 500 characters or fewer.`;
+ *        },
+ *    });
+ *
+ * Certain advanced lint rules need additional information about the content
+ * being linted in order to detect lint. For example, a rule to check for
+ * whitespace at the start and end of the URL for an image can't use the
+ * information in the node or content arguments because the markdown parser
+ * strips leading and trailing whitespace when parsing. (Nevertheless, these
+ * spaces have been a practical problem for our content translation process so
+ * in order to check for them, a lint rule needs access to the original
+ * unparsed source text. Similarly, there are various lint rules that check
+ * widget usage. For example, it is easy to write a lint rule to ensure that
+ * images have alt text for images encoded in markdown. But when images are
+ * added to our content via an image widget we also want to be able to check
+ * for alt text. In order to do this, the lint rule needs to be able to look
+ * widgets up by name in the widgets object associated with the parse tree.
+ *
+ * In order to support advanced linting rules like these, the check() method
+ * takes a context object as its optional fourth argument, and passes this
+ * object on to the lint function of each rule. Rules that require extra
+ * context should not assume that they will always get it, and should verify
+ * that the necessary context has been supplied before using it. Currently the
+ * "content" property of the context object is the unparsed source text if
+ * available, and the "widgets" property of the context object is the widget
+ * object associated with that content string in the JSON object that defines
+ * the Perseus article or exercise that is being linted.
+ */
+
+// 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.
@@ -448,13 +555,6 @@ class Rule {
   // this constructor and its arguments
   constructor(name, severity, selector, pattern, lint, applies) {
     var _this = this;
-    _defineProperty(this, "name", void 0);
-    _defineProperty(this, "severity", void 0);
-    _defineProperty(this, "selector", void 0);
-    _defineProperty(this, "pattern", void 0);
-    _defineProperty(this, "lint", void 0);
-    _defineProperty(this, "applies", void 0);
-    _defineProperty(this, "message", void 0);
     if (!selector && !pattern) {
       throw new perseusError.PerseusError("Lint rules must have a selector or pattern", perseusError.Errors.InvalidInput, {
         metadata: {
@@ -553,7 +653,9 @@ class Rule {
       // a rule was failing.
       return {
         rule: "lint-rule-failure",
-        message: "Exception in rule ".concat(this.name, ": ").concat(e.message, "\nStack trace:\n").concat(e.stack),
+        message: `Exception in rule ${this.name}: ${e.message}
+Stack trace:
+${e.stack}`,
         start: 0,
         end: content.length
       };
@@ -617,14 +719,13 @@ class Rule {
     result.input = input;
     return result;
   }
+  static Severity = {
+    ERROR: 1,
+    WARNING: 2,
+    GUIDELINE: 3,
+    BULK_WARNING: 4
+  };
 }
-_defineProperty(Rule, "DEFAULT_SELECTOR", void 0);
-_defineProperty(Rule, "Severity", {
-  ERROR: 1,
-  WARNING: 2,
-  GUIDELINE: 3,
-  BULK_WARNING: 4
-});
 Rule.DEFAULT_SELECTOR = Selector.parse("text");
 
 /* eslint-disable no-useless-escape */
@@ -652,7 +753,10 @@ var AbsoluteUrl = Rule.makeRule({
     const url = nodes[0].target;
     const hostname = getHostname(url);
     if (hostname === "khanacademy.org" || hostname.endsWith(".khanacademy.org")) {
-      return "Don't use absolute URLs:\nWhen linking to KA content or images, omit the\nhttps://www.khanacademy.org URL prefix.\nUse a relative URL beginning with / instead.";
+      return `Don't use absolute URLs:
+When linking to KA content or images, omit the
+https://www.khanacademy.org URL prefix.
+Use a relative URL beginning with / instead.`;
     }
   }
 });
@@ -661,14 +765,16 @@ var BlockquotedMath = Rule.makeRule({
   name: "blockquoted-math",
   severity: Rule.Severity.WARNING,
   selector: "blockQuote math, blockQuote blockMath",
-  message: "Blockquoted math:\nmath should not be indented."
+  message: `Blockquoted math:
+math should not be indented.`
 });
 
 var BlockquotedWidget = Rule.makeRule({
   name: "blockquoted-widget",
   severity: Rule.Severity.WARNING,
   selector: "blockQuote widget",
-  message: "Blockquoted widget:\nwidgets should not be indented."
+  message: `Blockquoted widget:
+widgets should not be indented.`
 });
 
 /* eslint-disable no-useless-escape */
@@ -677,7 +783,8 @@ var DoubleSpacingAfterTerminal = Rule.makeRule({
   severity: Rule.Severity.BULK_WARNING,
   selector: "paragraph",
   pattern: /[.!\?] {2}/i,
-  message: "Use a single space after a sentence-ending period, or\nany other kind of terminal punctuation."
+  message: `Use a single space after a sentence-ending period, or
+any other kind of terminal punctuation.`
 });
 
 var ExtraContentSpacing = Rule.makeRule({
@@ -687,7 +794,7 @@ var ExtraContentSpacing = Rule.makeRule({
   applies: function (context) {
     return context.contentType === "article";
   },
-  message: "No extra whitespace at the end of content blocks."
+  message: `No extra whitespace at the end of content blocks.`
 });
 
 var HeadingLevel1 = Rule.makeRule({
@@ -696,7 +803,8 @@ var HeadingLevel1 = Rule.makeRule({
   selector: "heading",
   lint: function (state, content, nodes, match) {
     if (nodes[0].level === 1) {
-      return "Don't use level-1 headings:\nBegin headings with two or more # characters.";
+      return `Don't use level-1 headings:
+Begin headings with two or more # characters.`;
     }
   }
 });
@@ -712,7 +820,9 @@ var HeadingLevelSkip = Rule.makeRule({
     // or one more than the previous heading. But going up
     // by 2 or more levels is not right
     if (currentHeading.level > previousHeading.level + 1) {
-      return "Skipped heading level:\nthis heading is level ".concat(currentHeading.level, " but\nthe previous heading was level ").concat(previousHeading.level);
+      return `Skipped heading level:
+this heading is level ${currentHeading.level} but
+the previous heading was level ${previousHeading.level}`;
     }
   }
 });
@@ -723,7 +833,8 @@ var HeadingSentenceCase = Rule.makeRule({
   selector: "heading",
   pattern: /^\W*[a-z]/,
   // first letter is lowercase
-  message: "First letter is lowercase:\nthe first letter of a heading should be capitalized."
+  message: `First letter is lowercase:
+the first letter of a heading should be capitalized.`
 });
 
 // These are 3-letter and longer words that we would not expect to be
@@ -783,7 +894,9 @@ var HeadingTitleCase = Rule.makeRule({
     // If there are at least 3 remaining words and all
     // are capitalized, then the heading is in title case.
     if (words.length >= 3 && words.every(w => isCapitalized(w))) {
-      return "Title-case heading:\nThis heading appears to be in title-case, but should be sentence-case.\nOnly capitalize the first letter and proper nouns.";
+      return `Title-case heading:
+This heading appears to be in title-case, but should be sentence-case.
+Only capitalize the first letter and proper nouns.`;
     }
   }
 });
@@ -795,10 +908,14 @@ var ImageAltText = Rule.makeRule({
   lint: function (state, content, nodes, match) {
     const image = nodes[0];
     if (!image.alt || !image.alt.trim()) {
-      return "Images should have alt text:\nfor accessibility, all images should have alt text.\nSpecify alt text inside square brackets after the !.";
+      return `Images should have alt text:
+for accessibility, all images should have alt text.
+Specify alt text inside square brackets after the !.`;
     }
     if (image.alt.length < 8) {
-      return "Images should have alt text:\nfor accessibility, all images should have descriptive alt text.\nThis image's alt text is only ".concat(image.alt.length, " characters long.");
+      return `Images should have alt text:
+for accessibility, all images should have descriptive alt text.
+This image's alt text is only ${image.alt.length} characters long.`;
     }
   }
 });
@@ -807,7 +924,8 @@ var ImageInTable = Rule.makeRule({
   name: "image-in-table",
   severity: Rule.Severity.BULK_WARNING,
   selector: "table image",
-  message: "Image in table:\ndo not put images inside of tables."
+  message: `Image in table:
+do not put images inside of tables.`
 });
 
 var ImageSpacesAroundUrls = Rule.makeRule({
@@ -831,7 +949,9 @@ var ImageSpacesAroundUrls = Rule.makeRule({
         return;
       }
       if (context.content[index - 1] !== "(" || context.content[index + url.length] !== ")") {
-        return "Whitespace before or after image url:\nFor images, don't include any space or newlines after '(' or before ')'.\nWhitespace in image URLs causes translation difficulties.";
+        return `Whitespace before or after image url:
+For images, don't include any space or newlines after '(' or before ')'.
+Whitespace in image URLs causes translation difficulties.`;
       }
     }
   }
@@ -862,17 +982,22 @@ var ImageWidget = Rule.makeRule({
     // Make sure there is alt text
     const alt = widget.options.alt;
     if (!alt) {
-      return "Images should have alt text:\nfor accessibility, all images should have a text description.\nAdd a description in the \"Alt Text\" box of the image widget.";
+      return `Images should have alt text:
+for accessibility, all images should have a text description.
+Add a description in the "Alt Text" box of the image widget.`;
     }
 
     // Make sure the alt text it is not trivial
     if (alt.trim().length < 8) {
-      return "Images should have alt text:\nfor accessibility, all images should have descriptive alt text.\nThis image's alt text is only ".concat(alt.trim().length, " characters long.");
+      return `Images should have alt text:
+for accessibility, all images should have descriptive alt text.
+This image's alt text is only ${alt.trim().length} characters long.`;
     }
 
     // Make sure there is no math in the caption
     if (widget.options.caption && widget.options.caption.match(/[^\\]\$/)) {
-      return "No math in image captions:\nDon't include math expressions in image captions.";
+      return `No math in image captions:
+Don't include math expressions in image captions.`;
     }
   }
 });
@@ -882,7 +1007,8 @@ var LinkClickHere = Rule.makeRule({
   severity: Rule.Severity.WARNING,
   selector: "link",
   pattern: /click here/i,
-  message: "Inappropriate link text:\nDo not use the words \"click here\" in links."
+  message: `Inappropriate link text:
+Do not use the words "click here" in links.`
 });
 
 var LongParagraph = Rule.makeRule({
@@ -891,7 +1017,9 @@ var LongParagraph = Rule.makeRule({
   selector: "paragraph",
   pattern: /^.{501,}/,
   lint: function (state, content, nodes, match) {
-    return "Paragraph too long:\nThis paragraph is ".concat(content.length, " characters long.\nShorten it to 500 characters or fewer.");
+    return `Paragraph too long:
+This paragraph is ${content.length} characters long.
+Shorten it to 500 characters or fewer.`;
   }
 });
 
@@ -899,7 +1027,8 @@ var MathAdjacent = Rule.makeRule({
   name: "math-adjacent",
   severity: Rule.Severity.WARNING,
   selector: "blockMath+blockMath",
-  message: "Adjacent math blocks:\ncombine the blocks between \\begin{align} and \\end{align}"
+  message: `Adjacent math blocks:
+combine the blocks between \\begin{align} and \\end{align}`
 });
 
 var MathAlignExtraBreak = Rule.makeRule({
@@ -907,7 +1036,8 @@ var MathAlignExtraBreak = Rule.makeRule({
   severity: Rule.Severity.WARNING,
   selector: "blockMath",
   pattern: /(\\{2,})\s*\\end{align}/,
-  message: "Extra space at end of block:\nDon't end an align block with backslashes"
+  message: `Extra space at end of block:
+Don't end an align block with backslashes`
 });
 
 var MathAlignLinebreaks = Rule.makeRule({
@@ -964,7 +1094,8 @@ var MathFontSize = Rule.makeRule({
   severity: Rule.Severity.GUIDELINE,
   selector: "math, blockMath",
   pattern: /\\(tiny|Tiny|small|large|Large|LARGE|huge|Huge|scriptsize|normalsize)\s*{/,
-  message: "Math font size:\nDon't change the default font size with \\Large{} or similar commands"
+  message: `Math font size:
+Don't change the default font size with \\Large{} or similar commands`
 });
 
 var MathFrac = Rule.makeRule({
@@ -980,7 +1111,8 @@ var MathNested = Rule.makeRule({
   severity: Rule.Severity.ERROR,
   selector: "math, blockMath",
   pattern: /\\text{[^$}]*\$[^$}]*\$[^}]*}/,
-  message: "Nested math:\nDon't nest math expressions inside \\text{} blocks"
+  message: `Nested math:
+Don't nest math expressions inside \\text{} blocks`
 });
 
 var MathStartsWithSpace = Rule.makeRule({
@@ -988,7 +1120,9 @@ var MathStartsWithSpace = Rule.makeRule({
   severity: Rule.Severity.GUIDELINE,
   selector: "math, blockMath",
   pattern: /^\s*(~|\\qquad|\\quad|\\,|\\;|\\:|\\ |\\!|\\enspace|\\phantom)/,
-  message: "Math starts with space:\nmath should not be indented. Do not begin math expressions with\nLaTeX space commands like ~, \\;, \\quad, or \\phantom"
+  message: `Math starts with space:
+math should not be indented. Do not begin math expressions with
+LaTeX space commands like ~, \\;, \\quad, or \\phantom`
 });
 
 var MathTextEmpty = Rule.makeRule({
@@ -1007,14 +1141,17 @@ var MathWithoutDollars = Rule.makeRule({
   name: "math-without-dollars",
   severity: Rule.Severity.GUIDELINE,
   pattern: /\\\w+{[^}]*}|{|}/,
-  message: "This looks like LaTeX:\ndid you mean to put it inside dollar signs?"
+  message: `This looks like LaTeX:
+did you mean to put it inside dollar signs?`
 });
 
 var NestedLists = Rule.makeRule({
   name: "nested-lists",
   severity: Rule.Severity.WARNING,
   selector: "list list",
-  message: "Nested lists:\nnested lists are hard to read on mobile devices;\ndo not use additional indentation."
+  message: `Nested lists:
+nested lists are hard to read on mobile devices;
+do not use additional indentation.`
 });
 
 var Profanity = Rule.makeRule({
@@ -1035,7 +1172,9 @@ var TableMissingCells = Rule.makeRule({
     const rowLengths = table.cells.map(r => r.length);
     for (let r = 0; r < rowLengths.length; r++) {
       if (rowLengths[r] !== headerLength) {
-        return "Table rows don't match header:\nThe table header has ".concat(headerLength, " cells, but\nRow ").concat(r + 1, " has ").concat(rowLengths[r], " cells.");
+        return `Table rows don't match header:
+The table header has ${headerLength} cells, but
+Row ${r + 1} has ${rowLengths[r]} cells.`;
       }
     }
   }
@@ -1049,35 +1188,97 @@ var UnbalancedCodeDelimiters = Rule.makeRule({
   name: "unbalanced-code-delimiters",
   severity: Rule.Severity.ERROR,
   pattern: /[`~]+/,
-  message: "Unbalanced code delimiters:\ncode blocks should begin and end with the same type and number of delimiters"
+  message: `Unbalanced code delimiters:
+code blocks should begin and end with the same type and number of delimiters`
 });
 
 var UnescapedDollar = Rule.makeRule({
   name: "unescaped-dollar",
   severity: Rule.Severity.ERROR,
   selector: "unescapedDollar",
-  message: "Unescaped dollar sign:\nDollar signs must appear in pairs or be escaped as \\$"
+  message: `Unescaped dollar sign:
+Dollar signs must appear in pairs or be escaped as \\$`
 });
 
 var WidgetInTable = Rule.makeRule({
   name: "widget-in-table",
   severity: Rule.Severity.BULK_WARNING,
   selector: "table widget",
-  message: "Widget in table:\ndo not put widgets inside of tables."
+  message: `Widget in table:
+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];
 
+/**
+ * TreeTransformer is a class for traversing and transforming trees.  Create a
+ * TreeTransformer by passing the root node of the tree to the
+ * constructor. Then traverse that tree by calling the traverse() method. The
+ * argument to traverse() is a callback function that will be called once for
+ * each node in the tree. This is a post-order depth-first traversal: the
+ * callback is not called on the a way down, but on the way back up. That is,
+ * the children of a node are traversed before the node itself is.
+ *
+ * The traversal callback function is passed three arguments, the node being
+ * traversed, a TraversalState object, and the concatentated text content of
+ * the node and all of its descendants. The TraversalState object is the most
+ * most interesting argument: it has methods for querying the ancestors and
+ * siblings of the node, and for deleting or replacing the node. These
+ * transformation methods are why this class is a tree transformer and not
+ * just a tree traverser.
+ *
+ * A typical tree traversal looks like this:
+ *
+ *   new TreeTransformer(root).traverse((node, state, content) => {
+ *       let parent = state.parent();
+ *       let previous = state.previousSibling();
+ *       // etc.
+ *   });
+ *
+ * The traverse() method descends through nodes and arrays of nodes and calls
+ * the traverse callback on each node on the way back up to the root of the
+ * tree. (Note that it only calls the callback on the nodes themselves, not
+ * any arrays that contain nodes.) A node is loosely defined as any object
+ * with a string-valued `type` property. Objects that do not have a type
+ * property are assumed to not be part of the tree and are not traversed. When
+ * traversing an array, all elements of the array are examined, and any that
+ * are nodes or arrays are recursively traversed. When traversing a node, all
+ * properties of the object are examined and any node or array values are
+ * recursively traversed.  In typical parse trees, the children of a node are
+ * in a `children` or `content` array, but this class is designed to handle
+ * more general trees.  The Perseus markdown parser, for example, produces
+ * nodes of type "table" that have children in the `header` and `cells`
+ * properties.
+ *
+ * CAUTION: the traverse() method does not make any attempt to detect
+ * cycles. If you call it on a cyclic graph instead of a tree, it will cause
+ * infinite recursion (or, more likely, a stack overflow).
+ *
+ * TODO(davidflanagan): it probably wouldn't be hard to detect cycles: when
+ * pushing a new node onto the containers stack we could just check that it
+ * isn't already there.
+ *
+ * If a node has a text-valued `content` property, it is taken to be the
+ * plain-text content of the node. The traverse() method concatenates these
+ * content strings and passes them to the traversal callback for each
+ * node. This means that the callback has access the full text content of its
+ * node and all of the nodes descendants.
+ *
+ * See the TraversalState class for more information on what information and
+ * methods are available to the traversal callback.
+ **/
+
 // 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 {
   // To create a tree transformer, just pass the root node of the tree
   constructor(root) {
-    _defineProperty(this, "root", void 0);
     this.root = root;
   }
 
@@ -1230,14 +1431,8 @@ 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.
-
   // The constructor just stores the root node and creates empty stacks.
   constructor(root) {
-    _defineProperty(this, "root", void 0);
-    _defineProperty(this, "_currentNode", void 0);
-    _defineProperty(this, "_containers", void 0);
-    _defineProperty(this, "_indexes", void 0);
-    _defineProperty(this, "_ancestors", void 0);
     this.root = root;
 
     // When the callback is called, this property will hold the
@@ -1494,7 +1689,6 @@ class TraversalState {
  */
 class Stack {
   constructor(array) {
-    _defineProperty(this, "stack", void 0);
     this.stack = array ? array.slice(0) : [];
   }
 
@@ -1553,7 +1747,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.8";
+const libVersion = "0.3.10";
 perseusCore.addLibraryVersionToPerseusDebug(libName, libVersion);
 
 // Define the shape of the linter context object that is passed through the