@khanacademy/perseus-linter 1.1.0 → 1.2.0

package/dist/rule.d.ts

@@ -122,22 +122,37 @@
  */
 import Selector from "./selector";
 import type { TraversalState, TreeNode } from "./tree-transformer";
-export type PatternMatchType = any;
-export type RuleCheckReturnType = {
+export type MakeRuleOptions = {
+    name: string;
+    pattern?: RegExp;
+    severity?: number;
+    selector?: string;
+    locale?: string;
+    message?: string;
+    lint?: (state: TraversalState, content: string, nodes: any, match: any, context: LintRuleContextObject) => string | undefined;
+    applies?: AppliesTester;
+};
+type PatternMatchType = any;
+type RuleCheckReturnType = {
     rule: string;
     message: string;
     start: number;
     end: number;
     severity?: number;
 } | null | undefined;
-export type LintTesterReturnType = string | {
+type LintTesterReturnType = string | {
     message: string;
     start: number;
     end: number;
 } | null | undefined;
-export type LintRuleContextObject = any | null | undefined;
-export type LintTester = (state: TraversalState, content: string, selectorMatch: ReadonlyArray<TreeNode>, patternMatch: PatternMatchType, context: LintRuleContextObject) => LintTesterReturnType;
-export type AppliesTester = (context: LintRuleContextObject) => boolean;
+type LintRuleContextObject = {
+    content: string;
+    contentType: "article" | "exercise";
+    stack: string[];
+    widgets: any[];
+} | null | undefined;
+type LintTester = (state: TraversalState, content: string, selectorMatch: ReadonlyArray<TreeNode>, patternMatch: PatternMatchType, context: LintRuleContextObject) => LintTesterReturnType;
+type AppliesTester = (context: LintRuleContextObject) => boolean;
 /**
  * A Rule object describes a Perseus lint rule. See the comment at the top of
  * this file for detailed description.
@@ -151,8 +166,8 @@ export default class Rule {
     applies: AppliesTester;
     message: string | null | undefined;
     static DEFAULT_SELECTOR: Selector;
-    constructor(name: string | null | undefined, severity: number | null | undefined, selector: Selector | null | undefined, pattern: RegExp | null | undefined, lint: LintTester | string, applies: AppliesTester);
-    static makeRule(options: any): Rule;
+    constructor(name: string | null | undefined, severity: number | null | undefined, selector: Selector | null | undefined, pattern: RegExp | null | undefined, lint: LintTester | string | undefined, applies: AppliesTester | undefined);
+    static makeRule(options: MakeRuleOptions): Rule;
     check(node: TreeNode, traversalState: TraversalState, content: string, context: LintRuleContextObject): RuleCheckReturnType;
     _defaultLintFunction(state: TraversalState, content: string, selectorMatch: ReadonlyArray<TreeNode>, patternMatch: PatternMatchType, context: LintRuleContextObject): {
         end: number;
@@ -168,3 +183,4 @@ export default class Rule {
         WARNING: number;
     };
 }
+export {};

package/dist/rules/expression-widget.d.ts

@@ -0,0 +1,9 @@
+import Rule from "../rule";
+/**
+ * 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)
+ */
+declare const _default: Rule;
+export default _default;

package/dist/tree-transformer.d.ts

@@ -57,6 +57,8 @@
  **/
 export type TreeNode = {
     type: string;
+    widgetType?: string;
+    id?: string;
 };
 export type TraversalCallback = (node: TreeNode, state: TraversalState, content: string) => void;
 export default class TreeTransformer {

package/package.json

@@ -3,7 +3,7 @@
     "description": "Linter engine for Perseus",
     "author": "Khan Academy",
     "license": "MIT",
-    "version": "1.1.0",
+    "version": "1.2.0",
     "publishConfig": {
         "access": "public"
     },