@khanacademy/perseus-linter 3.0.11 → 4.0.0

package/dist/proptypes.d.ts

@@ -1,3 +1,2 @@
 import type { LinterContextProps } from "./types";
-export declare const linterContextProps: any;
 export declare const linterContextDefault: LinterContextProps;

package/dist/rule.d.ts

@@ -129,21 +129,25 @@ export type MakeRuleOptions = {
     selector?: string;
     locale?: string;
     message?: string;
-    lint?: (state: TraversalState, content: string, nodes: any, match: any, context: LintRuleContextObject) => string | undefined;
+    lint?: (state: TraversalState, content: string, nodes: any, match: any, context: LintRuleContextObject) => LintTesterReturnType;
     applies?: AppliesTester;
 };
 type PatternMatchType = any;
-type RuleCheckReturnType = {
+export type LinterWarning = {
     rule: string;
     message: string;
     start: number;
     end: number;
+    target?: string;
     severity?: number;
-} | null | undefined;
+    metadata?: Record<string, any>;
+};
+export type RuleCheckReturnType = LinterWarning | null | undefined;
 type LintTesterReturnType = string | {
     message: string;
     start: number;
     end: number;
+    metadata?: Record<string, any>;
 } | null | undefined;
 type LintRuleContextObject = {
     content: string;

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

@@ -0,0 +1,3 @@
+import Rule from "../rule";
+declare const _default: Rule;
+export default _default;

package/dist/run-linter.d.ts

@@ -0,0 +1,27 @@
+import Rule from "./rule";
+import type { LinterWarning } from "./rule";
+export declare const allLintRules: ReadonlyArray<any>;
+/**
+ * Run the Perseus linter over the specified markdown parse tree, with the
+ * specified context object, and return a (possibly empty) array of lint
+ * warning objects.  If the highlight argument is true, this function also
+ * modifies the parse tree to add "lint" nodes that can be visually rendered,
+ * highlighting the problems for the user. The optional rules argument is an
+ * array of Rule objects specifying which lint rules should be applied to this
+ * parse tree. When omitted, a default set of rules is used.
+ *
+ * The context object may have additional properties that some lint rules
+ * require:
+ *
+ *   context.content is the source content string that was parsed to create
+ *   the parse tree.
+ *
+ *   context.widgets is the widgets object associated
+ *   with the content string
+ *
+ * TODO: to make this even more general, allow the first argument to be a
+ * string and run the parser over it in that case? (but ignore highlight in
+ * that case). This would allow the one function to be used for both online
+ * linting and batch linting.
+ */
+export declare function runLinter(tree: any, context: any, highlight: boolean, rules?: ReadonlyArray<Rule>): ReadonlyArray<LinterWarning>;

package/dist/types.d.ts

@@ -1,3 +1,7 @@
+/**
+ * The shape of the linter context object that is passed through the
+ * tree with additional information about what we are checking.
+ */
 export type LinterContextProps = {
     contentType: string;
     highlightLint: boolean;

package/package.json

@@ -3,7 +3,7 @@
   "description": "Linter engine for Perseus",
   "author": "Khan Academy",
   "license": "MIT",
-  "version": "3.0.11",
+  "version": "4.0.0",
   "publishConfig": {
     "access": "public"
   },
@@ -22,7 +22,7 @@
     "dist"
   ],
   "dependencies": {
-    "@khanacademy/perseus-core": "12.1.0",
+    "@khanacademy/perseus-core": "14.0.0",
     "@khanacademy/perseus-utils": "2.0.4"
   },
   "devDependencies": {
@@ -31,7 +31,7 @@
     "perseus-build-settings": "0.6.2"
   },
   "peerDependencies": {
-    "prop-types": "15.6.1"
+    "prop-types": "^15.6.1"
   },
   "keywords": [],
   "scripts": {}