@khanacademy/perseus-linter 0.2.4 → 0.3.0

package/src/rules/{lint-utils.js → lint-utils.ts}

@@ -1,5 +1,4 @@
 /* eslint-disable no-useless-escape */
-// @flow
 // Return the portion of a URL between // and /. This is the authority
 // portion which is usually just the hostname, but may also include
 // a username, password or port. We don't strip those things out because
@@ -37,7 +36,7 @@ const internalDomains = {
     "ka-mobile.s3.amazonaws.com": true,
     "ka-perseus-graphie.s3.amazonaws.com": true,
     "ka-perseus-images.s3.amazonaws.com": true,
-};
+} as const;
 
 // Returns true if this URL is relative, or if it is an absolute
 // URL with one of the domains listed above as its hostname.

package/src/rules/{long-paragraph.js → long-paragraph.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "long-paragraph",
     severity: Rule.Severity.GUIDELINE,
     selector: "paragraph",
@@ -11,4 +10,4 @@ export default (Rule.makeRule({
 This paragraph is ${content.length} characters long.
 Shorten it to 500 characters or fewer.`;
     },
-}): Rule);
+}) as Rule;

package/src/rules/{math-adjacent.js → math-adjacent.ts}

@@ -1,10 +1,9 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-adjacent",
     severity: Rule.Severity.WARNING,
     selector: "blockMath+blockMath",
     message: `Adjacent math blocks:
 combine the blocks between \\begin{align} and \\end{align}`,
-}): Rule);
+}) as Rule;

package/src/rules/{math-align-extra-break.js → math-align-extra-break.ts}

@@ -1,11 +1,10 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-align-extra-break",
     severity: Rule.Severity.WARNING,
     selector: "blockMath",
     pattern: /(\\{2,})\s*\\end{align}/,
     message: `Extra space at end of block:
 Don't end an align block with backslashes`,
-}): Rule);
+}) as Rule;

package/src/rules/{math-align-linebreaks.js → math-align-linebreaks.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-align-linebreaks",
     severity: Rule.Severity.WARNING,
     selector: "blockMath",
@@ -40,4 +39,4 @@ export default (Rule.makeRule({
             text = text.substring(nextpair[0].length);
         }
     },
-}): Rule);
+}) as Rule;

package/src/rules/{math-empty.js → math-empty.ts}

@@ -1,10 +1,9 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-empty",
     severity: Rule.Severity.WARNING,
     selector: "math, blockMath",
     pattern: /^$/,
     message: "Empty math: don't use $$ in your markdown.",
-}): Rule);
+}) as Rule;

package/src/rules/{math-font-size.js → math-font-size.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-font-size",
     severity: Rule.Severity.GUIDELINE,
     selector: "math, blockMath",
@@ -9,4 +8,4 @@ export default (Rule.makeRule({
         /\\(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`,
-}): Rule);
+}) as Rule;

package/src/rules/{math-frac.js → math-frac.ts}

@@ -1,10 +1,9 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-frac",
     severity: Rule.Severity.GUIDELINE,
     selector: "math, blockMath",
     pattern: /\\frac[ {]/,
     message: "Use \\dfrac instead of \\frac in your math expressions.",
-}): Rule);
+}) as Rule;

package/src/rules/{math-nested.js → math-nested.ts}

@@ -1,11 +1,10 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-nested",
     severity: Rule.Severity.ERROR,
     selector: "math, blockMath",
     pattern: /\\text{[^$}]*\$[^$}]*\$[^}]*}/,
     message: `Nested math:
 Don't nest math expressions inside \\text{} blocks`,
-}): Rule);
+}) as Rule;

package/src/rules/{math-starts-with-space.js → math-starts-with-space.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-starts-with-space",
     severity: Rule.Severity.GUIDELINE,
     selector: "math, blockMath",
@@ -9,4 +8,4 @@ export default (Rule.makeRule({
     message: `Math starts with space:
 math should not be indented. Do not begin math expressions with
 LaTeX space commands like ~, \\;, \\quad, or \\phantom`,
-}): Rule);
+}) as Rule;

package/src/rules/{math-text-empty.js → math-text-empty.ts}

@@ -1,10 +1,9 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-text-empty",
     severity: Rule.Severity.WARNING,
     selector: "math, blockMath",
     pattern: /\\text{\s*}/,
     message: "Empty \\text{} block in math expression",
-}): Rule);
+}) as Rule;

package/src/rules/{math-without-dollars.js → math-without-dollars.ts}

@@ -1,14 +1,13 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
 // Because no selector is specified, this rule only applies to text nodes.
 // Math and code hold their content directly and do not have text nodes
 // beneath them (unlike the HTML DOM) so this rule automatically does not
 // apply inside $$ or ``.
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "math-without-dollars",
     severity: Rule.Severity.GUIDELINE,
     pattern: /\\\w+{[^}]*}|{|}/,
     message: `This looks like LaTeX:
 did you mean to put it inside dollar signs?`,
-}): Rule);
+}) as Rule;

package/src/rules/{nested-lists.js → nested-lists.ts}

@@ -1,11 +1,10 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "nested-lists",
     severity: Rule.Severity.WARNING,
     selector: "list list",
     message: `Nested lists:
 nested lists are hard to read on mobile devices;
 do not use additional indentation.`,
-}): Rule);
+}) as Rule;

package/src/rules/{profanity.js → profanity.ts}

@@ -1,10 +1,9 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default 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",
-}): Rule);
+}) as Rule;

package/src/rules/{table-missing-cells.js → table-missing-cells.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "table-missing-cells",
     severity: Rule.Severity.WARNING,
     selector: "table",
@@ -17,4 +16,4 @@ Row ${r + 1} has ${rowLengths[r]} cells.`;
             }
         }
     },
-}): Rule);
+}) as Rule;

package/src/rules/{unbalanced-code-delimiters.js → unbalanced-code-delimiters.ts}

@@ -1,14 +1,13 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
 // Because no selector is specified, this rule only applies to text nodes.
 // Math and code hold their content directly and do not have text nodes
 // beneath them (unlike the HTML DOM) so this rule automatically does not
 // apply inside $$ or ``.
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "unbalanced-code-delimiters",
     severity: Rule.Severity.ERROR,
     pattern: /[`~]+/,
     message: `Unbalanced code delimiters:
 code blocks should begin and end with the same type and number of delimiters`,
-}): Rule);
+}) as Rule;

package/src/rules/{unescaped-dollar.js → unescaped-dollar.ts}

@@ -1,10 +1,9 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "unescaped-dollar",
     severity: Rule.Severity.ERROR,
     selector: "unescapedDollar",
     message: `Unescaped dollar sign:
 Dollar signs must appear in pairs or be escaped as \\$`,
-}): Rule);
+}) as Rule;

package/src/rules/{widget-in-table.js → widget-in-table.ts}

@@ -1,10 +1,9 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "widget-in-table",
     severity: Rule.Severity.BULK_WARNING,
     selector: "table widget",
     message: `Widget in table:
 do not put widgets inside of tables.`,
-}): Rule);
+}) as Rule;

package/src/{selector.js → selector.ts}

@@ -1,5 +1,4 @@
 /* eslint-disable no-useless-escape */
-// @flow
 /**
  * The Selector class implements a CSS-like system for matching nodes in a
  * parse tree based on the structure of the tree. Create a Selector object by
@@ -89,7 +88,7 @@
 
 import {Errors, PerseusError} from "@khanacademy/perseus-error";
 
-import type {TreeNode, TraversalState} from "./tree-transformer.js";
+import type {TreeNode, TraversalState} from "./tree-transformer";
 
 /**
  * This is the base class for all Selector types. The key method that all
@@ -108,7 +107,7 @@ export default class Selector {
      * This is the base class so we just throw an exception. All Selector
      * subclasses must provide an implementation of this method.
      */
-    match(state: TraversalState): ?$ReadOnlyArray<TreeNode> {
+    match(state: TraversalState): ReadonlyArray<TreeNode> | null | undefined {
         throw new PerseusError(
             "Selector subclasses must implement match()",
             Errors.NotAllowed,
@@ -135,7 +134,7 @@ export default class Selector {
  */
 class Parser {
     static TOKENS: RegExp; // We do lexing with a simple regular expression
-    tokens: $ReadOnlyArray<string>; // The array of tokens
+    tokens: ReadonlyArray<string>; // The array of tokens
     tokenIndex: number; // Which token in the array we're looking at now
 
     constructor(s: string) {
@@ -300,14 +299,14 @@ class ParseError extends Error {
  * first.
  */
 class SelectorList extends Selector {
-    selectors: $ReadOnlyArray<Selector>;
+    selectors: ReadonlyArray<Selector>;
 
-    constructor(selectors: $ReadOnlyArray<Selector>) {
+    constructor(selectors: ReadonlyArray<Selector>) {
         super();
         this.selectors = selectors;
     }
 
-    match(state: TraversalState): ?$ReadOnlyArray<TreeNode> {
+    match(state: TraversalState): ReadonlyArray<TreeNode> | null | undefined {
         for (let i = 0; i < this.selectors.length; i++) {
             const s = this.selectors[i];
             const result = s.match(state);
@@ -333,7 +332,7 @@ class SelectorList extends Selector {
  * matches any node.
  */
 class AnyNode extends Selector {
-    match(state: TraversalState): ?$ReadOnlyArray<TreeNode> {
+    match(state: TraversalState): ReadonlyArray<TreeNode> | null | undefined {
         return [state.currentNode()];
     }
 
@@ -354,7 +353,7 @@ class TypeSelector extends Selector {
         this.type = type;
     }
 
-    match(state: TraversalState): ?$ReadOnlyArray<TreeNode> {
+    match(state: TraversalState): ReadonlyArray<TreeNode> | null | undefined {
         const node = state.currentNode();
         if (node.type === this.type) {
             return [node];
@@ -394,7 +393,7 @@ class AncestorCombinator extends SelectorCombinator {
         super(left, right);
     }
 
-    match(state: TraversalState): ?$ReadOnlyArray<TreeNode> {
+    match(state: TraversalState): ReadonlyArray<TreeNode> | null | undefined {
         const rightResult = this.right.match(state);
         if (rightResult) {
             state = state.clone();
@@ -424,7 +423,7 @@ class ParentCombinator extends SelectorCombinator {
         super(left, right);
     }
 
-    match(state: TraversalState): ?$ReadOnlyArray<TreeNode> {
+    match(state: TraversalState): ReadonlyArray<TreeNode> | null | undefined {
         const rightResult = this.right.match(state);
         if (rightResult) {
             if (state.hasParent()) {
@@ -454,7 +453,7 @@ class PreviousCombinator extends SelectorCombinator {
         super(left, right);
     }
 
-    match(state: TraversalState): ?$ReadOnlyArray<TreeNode> {
+    match(state: TraversalState): ReadonlyArray<TreeNode> | null | undefined {
         const rightResult = this.right.match(state);
         if (rightResult) {
             if (state.hasPreviousSibling()) {
@@ -484,7 +483,7 @@ class SiblingCombinator extends SelectorCombinator {
         super(left, right);
     }
 
-    match(state: TraversalState): ?$ReadOnlyArray<TreeNode> {
+    match(state: TraversalState): ReadonlyArray<TreeNode> | null | undefined {
         const rightResult = this.right.match(state);
         if (rightResult) {
             state = state.clone();

package/src/{tree-transformer.js → tree-transformer.ts}

@@ -1,4 +1,3 @@
-// @flow
 /**
  * TreeTransformer is a class for traversing and transforming trees.  Create a
  * TreeTransformer by passing the root node of the tree to the
@@ -61,7 +60,9 @@ import {Errors, PerseusError} from "@khanacademy/perseus-error";
 
 // 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
-export type TreeNode = {type: string, ...};
+export type TreeNode = {
+    type: string;
+};
 
 // TraversalCallback is the type of the callback function passed to the
 // traverse() method. It is invoked with node, state, and content arguments
@@ -117,7 +118,6 @@ export default class TreeTransformer {
     // details. Note that this method uses the TraversalState object to store
     // information about the structure of the tree.
     _traverse(
-        // eslint-disable-next-line ft-flow/no-mutable-array
         n: TreeNode | Array<TreeNode>,
         state: TraversalState,
         f: TraversalCallback,
@@ -126,7 +126,7 @@ export default class TreeTransformer {
         if (TreeTransformer.isNode(n)) {
             // If we were called on a node object, then we handle it
             // this way.
-            const node = ((n: any): TreeNode); // safe cast; we just tested
+            const node = n as TreeNode; // safe cast; we just tested
 
             // Put the node on the stack before recursing on its children
             state._containers.push(node);
@@ -137,8 +137,9 @@ export default class TreeTransformer {
             // but other nodes types like "math" may also have content.
             // TODO(mdr): We found a new Flow error when upgrading:
             //     "node.content (property `content` is missing in `TreeNode` [1].)"
-            // $FlowFixMe[prop-missing](0.57.3->0.75.0)
+            // @ts-expect-error [FEI-5003] - TS2339 - Property 'content' does not exist on type 'TreeNode'.
             if (typeof node.content === "string") {
+                // @ts-expect-error [FEI-5003] - TS2339 - Property 'content' does not exist on type 'TreeNode'.
                 content = node.content;
             }
 
@@ -204,7 +205,7 @@ export default class TreeTransformer {
                 state._indexes.push(index);
                 content += this._traverse(nodes[index], state, f);
                 // Casting to convince Flow that this is a number
-                index = ((state._indexes.pop(): any): number) + 1;
+                index = (state._indexes.pop() as number) + 1;
             }
 
             // Pop the array off the stack. Note, however, that we do not call
@@ -242,8 +243,7 @@ export class TraversalState {
     // elements, depending on whether we just recursed on an array or on a
     // node. This is hard for Flow to deal with, so you'll see a number of
     // Flow casts through the any type when working with these two properties.
-    _currentNode: ?TreeNode;
-    // eslint-disable-next-line ft-flow/no-mutable-array
+    _currentNode: TreeNode | null | undefined;
     _containers: Stack<TreeNode | Array<TreeNode>>;
     _indexes: Stack<string | number>;
     _ancestors: Stack<TreeNode>;
@@ -288,7 +288,7 @@ export class TraversalState {
     /**
      * Return the parent of the current node, if there is one, or null.
      */
-    parent(): ?TreeNode {
+    parent(): TreeNode | null | undefined {
         return this._ancestors.top();
     }
 
@@ -299,14 +299,14 @@ export class TraversalState {
      * This method makes a copy of the internal state, so modifications to the
      * returned array have no effect on the traversal.
      */
-    ancestors(): $ReadOnlyArray<TreeNode> {
+    ancestors(): ReadonlyArray<TreeNode> {
         return this._ancestors.values();
     }
 
     /**
      * Return the next sibling of this node, if it has one, or null otherwise.
      */
-    nextSibling(): ?TreeNode {
+    nextSibling(): TreeNode | null | undefined {
         const siblings = this._containers.top();
 
         // If we're at the root of the tree or if the parent is an
@@ -316,7 +316,7 @@ export class TraversalState {
         }
 
         // The top index is a number because the top container is an array
-        const index = ((this._indexes.top(): any): number);
+        const index = this._indexes.top() as number;
         if (siblings.length > index + 1) {
             return siblings[index + 1];
         }
@@ -327,7 +327,7 @@ export class TraversalState {
      * Return the previous sibling of this node, if it has one, or null
      * otherwise.
      */
-    previousSibling(): ?TreeNode {
+    previousSibling(): TreeNode | null | undefined {
         const siblings = this._containers.top();
 
         // If we're at the root of the tree or if the parent is an
@@ -337,7 +337,7 @@ export class TraversalState {
         }
 
         // The top index is a number because the top container is an array
-        const index = ((this._indexes.top(): any): number);
+        const index = this._indexes.top() as number;
         if (index > 0) {
             return siblings[index - 1];
         }
@@ -349,11 +349,11 @@ export class TraversalState {
      * the removed sibling or null. This method makes it easy to traverse a
      * tree and concatenate adjacent text nodes into a single node.
      */
-    removeNextSibling(): ?TreeNode {
+    removeNextSibling(): TreeNode | null | undefined {
         const siblings = this._containers.top();
         if (siblings && Array.isArray(siblings)) {
             // top index is a number because top container is an array
-            const index = ((this._indexes.top(): any): number);
+            const index = this._indexes.top() as number;
             if (siblings.length > index + 1) {
                 return siblings.splice(index + 1, 1)[0];
             }
@@ -372,7 +372,7 @@ export class TraversalState {
      * This method throws an error if you attempt to replace the root node of
      * the tree.
      */
-    replace(...replacements: $ReadOnlyArray<TreeNode>): void {
+    replace(...replacements: ReadonlyArray<TreeNode>): void {
         const parent = this._containers.top();
         if (!parent) {
             throw new PerseusError(
@@ -386,7 +386,7 @@ export class TraversalState {
         // or object property. This is hard for Flow, so we have to do some
         // unsafe casting and be careful when we use which cast version
         if (Array.isArray(parent)) {
-            const index = ((this._indexes.top(): any): number);
+            const index = this._indexes.top() as number;
             // For an array parent we just splice the new nodes in
             parent.splice(index, 1, ...replacements);
             // Adjust the index to account for the changed array length.
@@ -394,7 +394,7 @@ export class TraversalState {
             this._indexes.pop();
             this._indexes.push(index + replacements.length - 1);
         } else {
-            const property = ((this._indexes.top(): any): string);
+            const property = this._indexes.top() as string;
             // For an object parent we care how many new nodes there are
             if (replacements.length === 0) {
                 // Deletion
@@ -417,7 +417,7 @@ export class TraversalState {
     hasPreviousSibling(): boolean {
         return (
             Array.isArray(this._containers.top()) &&
-            ((this._indexes.top(): any): number) > 0
+            (this._indexes.top() as number) > 0
         );
     }
 
@@ -441,7 +441,7 @@ export class TraversalState {
         // Since we know that we have a previous sibling, we know that
         // the value on top of the stack is a number, but we have to do
         // this unsafe cast because Flow doesn't know that.
-        const index = ((this._indexes.pop(): any): number);
+        const index = this._indexes.pop() as number;
         this._indexes.push(index - 1);
     }
 
@@ -527,10 +527,9 @@ export class TraversalState {
  * the TraversalState class simpler in a number of places.
  */
 class Stack<T> {
-    // eslint-disable-next-line ft-flow/no-mutable-array
     stack: Array<T>;
 
-    constructor(array: ?$ReadOnlyArray<T>) {
+    constructor(array?: ReadonlyArray<T> | null) {
         this.stack = array ? array.slice(0) : [];
     }
 
@@ -541,6 +540,7 @@ class Stack<T> {
 
     /** Pop a value off of the stack. */
     pop(): T {
+        // @ts-expect-error [FEI-5003] - TS2322 - Type 'T | undefined' is not assignable to type 'T'.
         return this.stack.pop();
     }
 
@@ -550,7 +550,7 @@ class Stack<T> {
     }
 
     /** Return a copy of the stack as an array */
-    values(): $ReadOnlyArray<T> {
+    values(): ReadonlyArray<T> {
         return this.stack.slice(0);
     }
 

package/src/types.ts

@@ -0,0 +1,7 @@
+export type LinterContextProps = {
+    contentType: string;
+    highlightLint: boolean;
+    paths: ReadonlyArray<string>;
+    stack: ReadonlyArray<string>;
+    // additional properties can be added to the context by widgets
+};

package/tsconfig.json

@@ -0,0 +1,12 @@
+{
+    "exclude": ["dist", "**/*.test.*", "**/*.testdata.*", "**/*.stories.*", "**/*.cypress.*"],
+    "extends": "../tsconfig-shared.json",
+    "compilerOptions": {
+        "outDir": "./dist",
+        "rootDir": "src",
+    },
+    "references": [
+        {"path": "../perseus-error"},
+        {"path": "../pure-markdown"},
+    ]
+}