@khanacademy/perseus-linter 0.0.0-PR875-20240813215114 → 0.0.0-PR875-20250222011102

package/dist/proptypes.d.ts

@@ -1,9 +1,3 @@
-import PropTypes from "prop-types";
 import type { LinterContextProps } from "./types";
-export declare const linterContextProps: PropTypes.Requireable<PropTypes.InferProps<{
-    contentType: PropTypes.Requireable<string>;
-    highlightLint: PropTypes.Requireable<boolean>;
-    paths: PropTypes.Requireable<(string | null | undefined)[]>;
-    stack: PropTypes.Requireable<(string | null | undefined)[]>;
-}>>;
+export declare const linterContextProps: any;
 export declare const linterContextDefault: LinterContextProps;

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/rules/lint-utils.d.ts

@@ -1,2 +1 @@
 export declare function getHostname(url: string): string;
-export declare function isInternalURL(url: string): boolean;

package/dist/shared-utils/add-library-version-to-perseus-debug.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Adds the given perseus library version information to the __perseus_debug__
+ * object and ensures that the object is attached to `globalThis` (`window` in
+ * browser environments).
+ *
+ * This allows each library to provide runtime version information to assist in
+ * debugging in production environments.
+ */
+export declare const addLibraryVersionToPerseusDebug: (libraryName: string, libraryVersion: string) => void;

package/dist/tree-transformer.d.ts

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

package/package.json

@@ -1,38 +1,36 @@
 {
-    "name": "@khanacademy/perseus-linter",
-    "description": "Linter engine for Perseus",
-    "author": "Khan Academy",
-    "license": "MIT",
-    "version": "0.0.0-PR875-20240813215114",
-    "publishConfig": {
-        "access": "public"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/Khan/perseus.git",
-        "directory": "packages/perseus-linter"
-    },
-    "bugs": {
-        "url": "https://github.com/Khan/perseus/issues"
-    },
-    "module": "dist/es/index.js",
-    "main": "dist/index.js",
-    "source": "src/index.ts",
-    "files": [
-        "dist"
-    ],
-    "scripts": {
-        "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
-    },
-    "dependencies": {
-        "@khanacademy/perseus-core": "1.5.0"
-    },
-    "devDependencies": {
-        "@khanacademy/pure-markdown": "^0.3.7",
-        "prop-types": "15.6.1"
-    },
-    "peerDependencies": {
-        "prop-types": "15.6.1"
-    },
-    "keywords": []
-}
+  "name": "@khanacademy/perseus-linter",
+  "description": "Linter engine for Perseus",
+  "author": "Khan Academy",
+  "license": "MIT",
+  "version": "0.0.0-PR875-20250222011102",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Khan/perseus.git",
+    "directory": "packages/perseus-linter"
+  },
+  "bugs": {
+    "url": "https://github.com/Khan/perseus/issues"
+  },
+  "module": "dist/es/index.js",
+  "main": "dist/index.js",
+  "source": "src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@khanacademy/perseus-core": "0.0.0-PR875-20250222011102"
+  },
+  "devDependencies": {
+    "prop-types": "15.6.1",
+    "@khanacademy/pure-markdown": "0.0.0-PR875-20250222011102"
+  },
+  "peerDependencies": {
+    "prop-types": "15.6.1"
+  },
+  "keywords": [],
+  "scripts": {}
+}