@khanacademy/perseus-linter 0.0.0-PR862-20231207182234 → 0.0.0-PR875-20250221232857

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,36 +1,36 @@
 {
-    "name": "@khanacademy/perseus-linter",
-    "description": "Linter engine for Perseus",
-    "author": "Khan Academy",
-    "license": "MIT",
-    "version": "0.0.0-PR862-20231207182234",
-    "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",
-    "scripts": {
-        "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
-    },
-    "dependencies": {
-        "@khanacademy/perseus-core": "0.0.0-PR862-20231207182234",
-        "@khanacademy/perseus-error": "^0.0.0-PR862-20231207182234"
-    },
-    "devDependencies": {
-        "@khanacademy/pure-markdown": "^0.0.0-PR862-20231207182234",
-        "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-20250221232857",
+  "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-20250221232857"
+  },
+  "devDependencies": {
+    "prop-types": "15.6.1",
+    "@khanacademy/pure-markdown": "0.0.0-PR875-20250221232857"
+  },
+  "peerDependencies": {
+    "prop-types": "15.6.1"
+  },
+  "keywords": [],
+  "scripts": {}
+}

package/.eslintrc.js

@@ -1,12 +0,0 @@
-/* eslint-disable @typescript-eslint/no-var-requires */
-/* eslint-disable import/no-commonjs */
-const path = require("path");
-
-module.exports = {
-    rules: {
-        "import/no-extraneous-dependencies": [
-            "error",
-            {packageDir: [__dirname, path.join(__dirname, "../../")]},
-        ],
-    },
-};

package/CHANGELOG.md

@@ -1,148 +0,0 @@
-# @khanacademy/perseus-linter
-
-## 0.0.0-PR862-20231207182234
-
-### Patch Changes
-
--   Updated dependencies [[`1f4e17ba`](https://github.com/Khan/perseus/commit/1f4e17ba77e1491523813655af18a70285a25989), [`8857950b`](https://github.com/Khan/perseus/commit/8857950bdeeb6e13bc3766b1c6545289b21cbe2a)]:
-    -   @khanacademy/perseus-core@0.0.0-PR862-20231207182234
-    -   @khanacademy/perseus-error@0.0.0-PR862-20231207182234
-
-## 0.3.9
-
-### Patch Changes
-
--   [#814](https://github.com/Khan/perseus/pull/814) [`105d2060`](https://github.com/Khan/perseus/commit/105d20603d935d35cff237b17f0bfb57ca751e4c) Thanks [@jeremywiebe](https://github.com/jeremywiebe)! - Minor build change to how we provide Typescript type definitions (should be no change to build output).
-
--   Updated dependencies [[`a91c84fe`](https://github.com/Khan/perseus/commit/a91c84fe53827ff4333220777a9918882b7fe9f0), [`105d2060`](https://github.com/Khan/perseus/commit/105d20603d935d35cff237b17f0bfb57ca751e4c)]:
-    -   @khanacademy/perseus-core@1.4.0
-    -   @khanacademy/perseus-error@0.2.8
-
-## 0.3.8
-
-### Patch Changes
-
--   Updated dependencies [[`79403e06`](https://github.com/Khan/perseus/commit/79403e06eedb597d7818d6c858bbba6f51ff3fe1)]:
-    -   @khanacademy/perseus-core@1.3.0
-    -   @khanacademy/perseus-error@0.2.7
-
-## 0.3.7
-
-### Patch Changes
-
--   Updated dependencies [[`376eb0e4`](https://github.com/Khan/perseus/commit/376eb0e4aaaa4c7a90fd6107a84bb74d382b077c)]:
-    -   @khanacademy/perseus-core@1.2.0
-    -   @khanacademy/perseus-error@0.2.6
-
-## 0.3.6
-
-### Patch Changes
-
--   Updated dependencies [22a9c408]
-    -   @khanacademy/perseus-core@1.1.2
-    -   @khanacademy/perseus-error@0.2.5
-
-## 0.3.5
-
-### Patch Changes
-
--   55d4cd00: Print package name and version when loaded in the page
--   Updated dependencies [55d4cd00]
-    -   @khanacademy/perseus-core@1.1.1
-    -   @khanacademy/perseus-error@0.2.4
-
-## 0.3.4
-
-### Patch Changes
-
--   388b6506: Convert runLinter doc comment to /\*\* \*/ format so editors pick it up better (VSCode).
--   Updated dependencies [388b6506]
-    -   @khanacademy/perseus-error@0.2.3
-
-## 0.3.3
-
-### Patch Changes
-
--   Updated dependencies [a383823d]
-    -   @khanacademy/perseus-error@0.2.2
-
-## 0.3.2
-
-### Patch Changes
-
--   ce5e6297: Upgrade wonder-blocks deps to package versions without Flow types
-
-## 0.3.1
-
-### Patch Changes
-
--   1f062e98: Bump all package versions since the build settings have been updated
--   Updated dependencies [1f062e98]
-    -   @khanacademy/perseus-error@0.2.1
-
-## 0.3.0
-
-### Minor Changes
-
--   53fd3768: Migrate source code to TypeScript
-
-### Patch Changes
-
--   Updated dependencies [53fd3768]
-    -   @khanacademy/perseus-error@0.2.0
-
-## 0.2.5
-
-### Patch Changes
-
--   Updated dependencies [a1b4ab3c]
-    -   @khanacademy/perseus-error@0.1.5
-
-## 0.2.4
-
-### Patch Changes
-
--   Updated dependencies [6a7f36be]
-    -   @khanacademy/perseus-error@0.1.4
-
-## 0.2.3
-
-### Patch Changes
-
--   f567f660: Update the eslint config to look at both the package.json for the package and the one from the root
--   Updated dependencies [f567f660]
-    -   @khanacademy/perseus-error@0.1.3
-
-## 0.2.2
-
-### Patch Changes
-
--   bf180fe1: Fix our use of import/no-extraneous-dependencies
--   Updated dependencies [bf180fe1]
-    -   @khanacademy/perseus-error@0.1.2
-
-## 0.2.1
-
-### Patch Changes
-
--   98d283ff: Fix storybook
--   Updated dependencies [98d283ff]
-    -   @khanacademy/perseus-error@0.1.1
-
-## 0.2.0
-
-### Minor Changes
-
--   2578bd16: Rename NotGorgon to TranslationLinter
--   2578bd16: Rename Gorgon to PerseusLinter
-
-## 0.1.0
-
-### Minor Changes
-
--   a4f10ace: Move Gorgon, PerseusError, PureMarkdown into their own packages
-
-### Patch Changes
-
--   Updated dependencies [a4f10ace]
-    -   @khanacademy/perseus-error@0.1.0

package/src/README.md

@@ -1,41 +0,0 @@
-# perseus-linter
-
-The linter is implemented by the following files:
-
-tree-transformer.js:
-
-  This file defines a TreeTransformer class for traversing (and
-  optionally transforming by inserting, reparenting and removing
-  nodes) markdown parse trees. When traversing a tree, a
-  TreeTransformer calls the function you specify on each node. This is
-  a post-order traversal: the function is called on the way back up,
-  not on the way down. When the function is invoked, it is passed the
-  current node, a state object, and the concatenated content of the
-  node and its descendants.  The state object is the interesting one:
-  it is an instance of TraversalState, which is a class defined in
-  (but not exported by) this same file. TraversalState has an API for
-  querying the ancestors and siblings of the current node, and also an
-  API for replacing the current node with a new one.
-
-selector.js:
-
-  This file defines the Selector class which works like a CSS selector
-  for markdown parse trees. Selector.parse() converts strings like
-  "heading + paragraph > text" to Selector objects. A Selector object
-  has a match() method that tests whether a given node in a parse tree
-  matches. The match() method takes a TraversalState object as its
-  argument, so selectors can only be used during a TreeTransformer
-  traversal.
-
-rule.js:
-
-  This file defines the Rule class which represents a single lint
-  rule. A Rule object has a check() method that takes the same (node,
-  state, content) arguments that a TreeTransformer passes to the
-  traversal callback function. Rules can have a selector, a regular
-  expression, and a function. If a node matches the selector and its
-  content matches the regular expression, then the function is called
-  to check the node and return a warning message if the node does, in
-  fact, have lint.
-
-See the individual file for additional documentation.