@khanacademy/perseus-linter 0.2.5 → 0.3.0

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

@@ -1,12 +1,11 @@
-// @flow
-import Rule from "./rule.js";
-import AllRules from "./rules/all-rules.js";
-import TreeTransformer from "./tree-transformer.js";
+import Rule from "./rule";
+import AllRules from "./rules/all-rules";
+import TreeTransformer from "./tree-transformer";
 
-export {linterContextProps, linterContextDefault} from "./proptypes.js";
-export type {LinterContextProps} from "./types.js";
+export {linterContextProps, linterContextDefault} from "./proptypes";
+export type {LinterContextProps} from "./types";
 
-const allLintRules: $ReadOnlyArray<$FlowFixMe> = AllRules.filter(
+const allLintRules: ReadonlyArray<any> = AllRules.filter(
     (r) => r.severity < Rule.Severity.BULK_WARNING,
 );
 
@@ -37,12 +36,12 @@ export {Rule, allLintRules as rules};
 // online linting and batch linting.
 //
 export function runLinter(
-    tree: $FlowFixMe,
-    context: $FlowFixMe,
+    tree: any,
+    context: any,
     highlight: boolean,
-    rules?: $ReadOnlyArray<$FlowFixMe> = allLintRules,
-): $ReadOnlyArray<$FlowFixMe> {
-    const warnings = [];
+    rules: ReadonlyArray<any> = allLintRules,
+): ReadonlyArray<any> {
+    const warnings: Array<any> = [];
     const tt = new TreeTransformer(tree);
 
     // The markdown parser often outputs adjacent text nodes. We
@@ -51,8 +50,7 @@ export function runLinter(
         if (TreeTransformer.isTextNode(node)) {
             let next = state.nextSibling();
             while (TreeTransformer.isTextNode(next)) {
-                // $FlowFixMe[prop-missing]
-                // $FlowFixMe[incompatible-use]
+                // @ts-expect-error [FEI-5003] - TS2339 - Property 'content' does not exist on type 'TreeNode'. | TS2533 - Object is possibly 'null' or 'undefined'. | TS2339 - Property 'content' does not exist on type 'TreeNode'.
                 node.content += next.content;
                 state.removeNextSibling();
                 next = state.nextSibling();
@@ -77,14 +75,14 @@ export function runLinter(
     // issue too. But using JavaScript has its own downsides: there is
     // risk that the linter JavaScript would interfere with
     // widget-related Javascript.
-    let tableWarnings = [];
+    let tableWarnings: Array<never> = [];
     let insideTable = false;
 
     // Traverse through the nodes of the parse tree. At each node, loop
     // through the array of lint rules and check whether there is a
     // lint violation at that node.
     tt.traverse((node, state, content) => {
-        const nodeWarnings = [];
+        const nodeWarnings: Array<any> = [];
 
         // If our rule is only designed to be tested against a particular
         // content type and we're not in that content type, we don't need to
@@ -99,7 +97,7 @@ export function runLinter(
         const nodeContext = {
             ...context,
             stack: stack.join("."),
-        };
+        } as const;
 
         applicableRules.forEach((rule) => {
             const warning = rule.check(node, state, content, nodeContext);
@@ -159,6 +157,7 @@ export function runLinter(
         // this node, then we need to save the warnings for display
         // on the table itself
         if (insideTable && nodeWarnings.length) {
+            // @ts-expect-error [FEI-5003] - TS2345 - Argument of type 'any' is not assignable to parameter of type 'never'.
             tableWarnings.push(...nodeWarnings);
         }
 
@@ -186,6 +185,7 @@ export function runLinter(
                 // node under a new lint node and put the warnings there.
                 state.replace({
                     type: "lint",
+                    // @ts-expect-error [FEI-5003] - TS2345 - Argument of type '{ type: string; content: TreeNode; message: string; ruleName: any; blockHighlight: any; insideTable: boolean; severity: any; }' is not assignable to parameter of type 'TreeNode'.
                     content: node,
                     message: nodeWarnings.map((w) => w.message).join("\n\n"),
                     ruleName: nodeWarnings[0].rule,
@@ -219,7 +219,7 @@ export function runLinter(
                 // single line, so keeping them combined in that case might
                 // be the best thing, anyway.
                 //
-                // $FlowFixMe[prop-missing]
+                // @ts-expect-error [FEI-5003] - TS2339 - Property 'content' does not exist on type 'TreeNode'.
                 const content = node.content; // Text nodes have content
                 const warning = nodeWarnings[0]; // There is only one warning.
                 // These are the lint boundaries within the content
@@ -228,7 +228,8 @@ export function runLinter(
                 const prefix = content.substring(0, start);
                 const lint = content.substring(start, end);
                 const suffix = content.substring(end);
-                const replacements = []; // What we'll replace the node with
+                // TODO(FEI-5003): Give this a real type.
+                const replacements: any[] = []; // What we'll replace the node with
 
                 // The prefix text node, if there is one
                 if (prefix) {
@@ -269,10 +270,7 @@ export function runLinter(
     return warnings;
 }
 
-export function pushContextStack(
-    context: $FlowFixMe,
-    name: string,
-): $FlowFixMe {
+export function pushContextStack(context: any, name: string): any {
     const stack = context.stack || [];
     return {
         ...context,

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

@@ -1,20 +1,10 @@
-// @flow
 // Define the shape of the linter context object that is passed through the
 // tree with additional information about what we are checking.
-
 import PropTypes from "prop-types";
 
-import type {LinterContextProps} from "./types.js";
+import type {LinterContextProps} from "./types";
 
-export const linterContextProps: React$PropType$Primitive<{
-    contentType?: string,
-    highlightLint?: boolean,
-    // eslint-disable-next-line ft-flow/no-mutable-array
-    paths?: Array<string>,
-    // eslint-disable-next-line ft-flow/no-mutable-array
-    stack?: Array<string>,
-    ...
-}> = PropTypes.shape({
+export const linterContextProps = PropTypes.shape({
     contentType: PropTypes.string,
     highlightLint: PropTypes.bool,
     paths: PropTypes.arrayOf(PropTypes.string),
@@ -24,6 +14,6 @@ export const linterContextProps: React$PropType$Primitive<{
 export const linterContextDefault: LinterContextProps = {
     contentType: "",
     highlightLint: false,
-    paths: ([]: $ReadOnlyArray<any>),
-    stack: ([]: $ReadOnlyArray<any>),
+    paths: [] as ReadonlyArray<any>,
+    stack: [] as ReadonlyArray<any>,
 };

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

@@ -1,4 +1,3 @@
-// @flow
 /**
  * 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
@@ -124,9 +123,9 @@
 
 import {Errors, PerseusError} from "@khanacademy/perseus-error";
 
-import Selector from "./selector.js";
+import Selector from "./selector";
 
-import type {TraversalState, TreeNode} from "./tree-transformer.js";
+import type {TraversalState, TreeNode} from "./tree-transformer";
 
 // This represents the type returned by String.match(). It is an
 // array of strings, but also has index:number and input:string properties.
@@ -134,28 +133,29 @@ import type {TraversalState, TreeNode} from "./tree-transformer.js";
 export type PatternMatchType = any;
 
 // This is the return type of the check() method of a Rule object
-export type RuleCheckReturnType = ?{|
-    rule: string,
-    message: string,
-    start: number,
-    end: number,
-    severity?: number,
-|};
+export type RuleCheckReturnType =
+    | {
+          rule: string;
+          message: string;
+          start: number;
+          end: number;
+          severity?: number;
+      }
+    | null
+    | undefined;
 
 // 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)
-export type LintTesterReturnType = ?(
-    string
-    | {|
-        message: string,
-        start: number,
-        end: number,
-    |});
+export type LintTesterReturnType = string | {
+    message: string,
+    start: number,
+    end: number
+} | null | undefined;
 
-export type LintRuleContextObject = ?Object;
+export type LintRuleContextObject = any | null | undefined;
 
 // 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
@@ -166,7 +166,7 @@ export type LintRuleContextObject = ?Object;
 export type LintTester = (
     state: TraversalState,
     content: string,
-    selectorMatch: $ReadOnlyArray<TreeNode>,
+    selectorMatch: ReadonlyArray<TreeNode>,
     patternMatch: PatternMatchType,
     context: LintRuleContextObject,
 ) => LintTesterReturnType;
@@ -185,19 +185,19 @@ export default class Rule {
     name: string; // The name of the rule
     severity: number; // The severity of the rule
     selector: Selector; // The specified selector or the DEFAULT_SELECTOR
-    pattern: ?RegExp; // A regular expression if one was specified
+    pattern: RegExp | null | undefined; // A regular expression if one was specified
     lint: LintTester; // The lint-testing function or a default
     applies: AppliesTester; // Checks to see if we should apply a rule or not
-    message: ?string; // The error message for use with the default function
+    message: string | null | undefined; // The error message for use with the default function
     static DEFAULT_SELECTOR: Selector;
 
     // The comment at the top of this file has detailed docs for
     // this constructor and its arguments
     constructor(
-        name: ?string,
-        severity: ?number,
-        selector: ?Selector,
-        pattern: ?RegExp,
+        name: string | null | undefined,
+        severity: number | null | undefined,
+        selector: Selector | null | undefined,
+        pattern: RegExp | null | undefined,
         lint: LintTester | string,
         applies: AppliesTester,
     ) {
@@ -233,7 +233,7 @@ export default class Rule {
 
     // A factory method for use with rules described in JSON files
     // See the documentation at the start of this file for details.
-    static makeRule(options: Object): Rule {
+    static makeRule(options: any): Rule {
         return new Rule(
             options.name,
             options.severity,
@@ -312,7 +312,7 @@ export default class Rule {
                 start: error.start,
                 end: error.end,
             };
-        } catch (e) {
+        } catch (e: any) {
             // If the lint function threw an exception we handle that as
             // a special type of lint. We want the user to see the lint
             // warning in this case (even though it is out of their control)
@@ -339,10 +339,14 @@ ${e.stack}`,
     _defaultLintFunction(
         state: TraversalState,
         content: string,
-        selectorMatch: $ReadOnlyArray<TreeNode>,
+        selectorMatch: ReadonlyArray<TreeNode>,
         patternMatch: PatternMatchType,
         context: LintRuleContextObject,
-    ): {|end: number, message: string, start: number|} {
+    ): {
+        end: number;
+        message: string;
+        start: number;
+    } {
         return {
             message: this.message || "",
             start: patternMatch.index,
@@ -365,7 +369,9 @@ ${e.stack}`,
     //   input "foo"     ==> output /foo/
     //   input "/foo/i"  ==> output /foo/i
     //
-    static makePattern(pattern: ?(RegExp | string)): ?RegExp {
+    static makePattern(
+        pattern?: RegExp | string | null,
+    ): RegExp | null | undefined {
         if (!pattern) {
             return null;
         }
@@ -376,7 +382,8 @@ ${e.stack}`,
             const lastSlash = pattern.lastIndexOf("/");
             const expression = pattern.substring(1, lastSlash);
             const flags = pattern.substring(lastSlash + 1);
-            return new RegExp(expression, ((flags: any): RegExp$flags));
+            // @ts-expect-error [FEI-5003] - TS2713 - Cannot access 'RegExp.flags' because 'RegExp' is a type, but not a namespace. Did you mean to retrieve the type of the property 'flags' in 'RegExp' with 'RegExp["flags"]'?
+            return new RegExp(expression, flags as RegExp.flags);
         }
         return new RegExp(pattern);
     }
@@ -387,7 +394,7 @@ ${e.stack}`,
     // want to simulate a match on the entire content string.
     static FakePatternMatch(
         input: string,
-        match: ?string,
+        match: string | null | undefined,
         index: number,
     ): PatternMatchType {
         const result: any = [match];
@@ -396,12 +403,12 @@ ${e.stack}`,
         return result;
     }
 
-    static Severity: {|
-        BULK_WARNING: number,
-        ERROR: number,
-        GUIDELINE: number,
-        WARNING: number,
-    |} = {
+    static Severity: {
+        BULK_WARNING: number;
+        ERROR: number;
+        GUIDELINE: number;
+        WARNING: number;
+    } = {
         ERROR: 1,
         WARNING: 2,
         GUIDELINE: 3,

package/src/rules/{absolute-url.js → absolute-url.ts}

@@ -1,9 +1,8 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-import {getHostname} from "./lint-utils.js";
+import {getHostname} from "./lint-utils";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "absolute-url",
     severity: Rule.Severity.GUIDELINE,
     selector: "link, image",
@@ -21,4 +20,4 @@ https://www.khanacademy.org URL prefix.
 Use a relative URL beginning with / instead.`;
         }
     },
-}): Rule);
+}) as Rule;

package/src/rules/all-rules.ts

@@ -0,0 +1,71 @@
+// TODO(davidflanagan):
+// This should probably be converted to use import and to export
+// and object that maps rule names to rules. Also, maybe this should
+// be an auto-generated file with a script that updates it any time
+// we add a new rule?
+
+import AbsoluteUrl from "./absolute-url";
+import BlockquotedMath from "./blockquoted-math";
+import BlockquotedWidget from "./blockquoted-widget";
+import DoubleSpacingAfterTerminal from "./double-spacing-after-terminal";
+import ExtraContentSpacing from "./extra-content-spacing";
+import HeadingLevel1 from "./heading-level-1";
+import HeadingLevelSkip from "./heading-level-skip";
+import HeadingSentenceCase from "./heading-sentence-case";
+import HeadingTitleCase from "./heading-title-case";
+import ImageAltText from "./image-alt-text";
+import ImageInTable from "./image-in-table";
+import ImageSpacesAroundUrls from "./image-spaces-around-urls";
+import ImageWidget from "./image-widget";
+import LinkClickHere from "./link-click-here";
+import LongParagraph from "./long-paragraph";
+import MathAdjacent from "./math-adjacent";
+import MathAlignExtraBreak from "./math-align-extra-break";
+import MathAlignLinebreaks from "./math-align-linebreaks";
+import MathEmpty from "./math-empty";
+import MathFontSize from "./math-font-size";
+import MathFrac from "./math-frac";
+import MathNested from "./math-nested";
+import MathStartsWithSpace from "./math-starts-with-space";
+import MathTextEmpty from "./math-text-empty";
+import MathWithoutDollars from "./math-without-dollars";
+import NestedLists from "./nested-lists";
+import Profanity from "./profanity";
+import TableMissingCells from "./table-missing-cells";
+import UnbalancedCodeDelimiters from "./unbalanced-code-delimiters";
+import UnescapedDollar from "./unescaped-dollar";
+import WidgetInTable from "./widget-in-table";
+
+export default [
+    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,
+];

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

@@ -1,10 +1,9 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "blockquoted-math",
     severity: Rule.Severity.WARNING,
     selector: "blockQuote math, blockQuote blockMath",
     message: `Blockquoted math:
 math should not be indented.`,
-}): Rule);
+}) as Rule;

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

@@ -1,10 +1,9 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "blockquoted-widget",
     severity: Rule.Severity.WARNING,
     selector: "blockQuote widget",
     message: `Blockquoted widget:
 widgets should not be indented.`,
-}): Rule);
+}) as Rule;

package/src/rules/{double-spacing-after-terminal.js → double-spacing-after-terminal.ts}

@@ -1,12 +1,11 @@
 /* eslint-disable no-useless-escape */
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "double-spacing-after-terminal",
     severity: Rule.Severity.BULK_WARNING,
     selector: "paragraph",
     pattern: /[.!\?] {2}/i,
     message: `Use a single space after a sentence-ending period, or
 any other kind of terminal punctuation.`,
-}): Rule);
+}) as Rule;

package/src/rules/{extra-content-spacing.js → extra-content-spacing.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "extra-content-spacing",
     selector: "paragraph",
     pattern: /\s+$/,
@@ -9,4 +8,4 @@ export default (Rule.makeRule({
         return context.contentType === "article";
     },
     message: `No extra whitespace at the end of content blocks.`,
-}): Rule);
+}) as Rule;

package/src/rules/{heading-level-1.js → heading-level-1.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "heading-level-1",
     severity: Rule.Severity.WARNING,
     selector: "heading",
@@ -11,4 +10,4 @@ export default (Rule.makeRule({
 Begin headings with two or more # characters.`;
         }
     },
-}): Rule);
+}) as Rule;

package/src/rules/{heading-level-skip.js → heading-level-skip.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "heading-level-skip",
     severity: Rule.Severity.WARNING,
     selector: "heading ~ heading",
@@ -17,4 +16,4 @@ this heading is level ${currentHeading.level} but
 the previous heading was level ${previousHeading.level}`;
         }
     },
-}): Rule);
+}) as Rule;

package/src/rules/{heading-sentence-case.js → heading-sentence-case.ts}

@@ -1,11 +1,10 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "heading-sentence-case",
     severity: Rule.Severity.GUIDELINE,
     selector: "heading",
     pattern: /^\W*[a-z]/, // first letter is lowercase
     message: `First letter is lowercase:
 the first letter of a heading should be capitalized.`,
-}): Rule);
+}) as Rule;

package/src/rules/{heading-title-case.js → heading-title-case.ts}

@@ -1,17 +1,22 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
 // These are 3-letter and longer words that we would not expect to be
 // capitalized even in a title-case heading.  See
 // http://blog.apastyle.org/apastyle/2012/03/title-case-and-sentence-case-capitalization-in-apa-style.html
-const littleWords = {and: true, nor: true, but: true, the: true, for: true};
+const littleWords = {
+    and: true,
+    nor: true,
+    but: true,
+    the: true,
+    for: true,
+} as const;
 
-function isCapitalized(word) {
+function isCapitalized(word: any) {
     const c = word[0];
     return c === c.toUpperCase();
 }
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "heading-title-case",
     severity: Rule.Severity.GUIDELINE,
     selector: "heading",
@@ -60,4 +65,4 @@ This heading appears to be in title-case, but should be sentence-case.
 Only capitalize the first letter and proper nouns.`;
         }
     },
-}): Rule);
+}) as Rule;

package/src/rules/{image-alt-text.js → image-alt-text.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "image-alt-text",
     severity: Rule.Severity.WARNING,
     selector: "image",
@@ -18,4 +17,4 @@ for accessibility, all images should have descriptive alt text.
 This image's alt text is only ${image.alt.length} characters long.`;
         }
     },
-}): Rule);
+}) as Rule;

package/src/rules/{image-in-table.js → image-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: "image-in-table",
     severity: Rule.Severity.BULK_WARNING,
     selector: "table image",
     message: `Image in table:
 do not put images inside of tables.`,
-}): Rule);
+}) as Rule;

package/src/rules/{image-spaces-around-urls.js → image-spaces-around-urls.ts}

@@ -1,7 +1,6 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "image-spaces-around-urls",
     severity: Rule.Severity.ERROR,
     selector: "image",
@@ -32,4 +31,4 @@ Whitespace in image URLs causes translation difficulties.`;
             }
         }
     },
-}): Rule);
+}) as Rule;

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

@@ -1,5 +1,4 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
 // Normally we have one rule per file. But since our selector class
 // can't match specific widget types directly, this rule implements
@@ -7,7 +6,7 @@ import Rule from "../rule.js";
 // slightly increase efficiency, but it means that if there is more
 // than one problem with an image widget, the user will only see one
 // problem at a time.
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "image-widget",
     severity: Rule.Severity.WARNING,
     selector: "widget",
@@ -47,4 +46,4 @@ This image's alt text is only ${alt.trim().length} characters long.`;
 Don't include math expressions in image captions.`;
         }
     },
-}): Rule);
+}) as Rule;

package/src/rules/{link-click-here.js → link-click-here.ts}

@@ -1,11 +1,10 @@
-// @flow
-import Rule from "../rule.js";
+import Rule from "../rule";
 
-export default (Rule.makeRule({
+export default Rule.makeRule({
     name: "link-click-here",
     severity: Rule.Severity.WARNING,
     selector: "link",
     pattern: /click here/i,
     message: `Inappropriate link text:
 Do not use the words "click here" in links.`,
-}): Rule);
+}) as Rule;