@khanacademy/perseus-linter 0.3.2 → 0.3.4

package/dist/index.d.ts

@@ -3,5 +3,29 @@ export { linterContextProps, linterContextDefault } from "./proptypes";
 export type { LinterContextProps } from "./types";
 declare const allLintRules: ReadonlyArray<any>;
 export { Rule, allLintRules as rules };
+/**
+ * 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<any>): ReadonlyArray<any>;
 export declare function pushContextStack(context: any, name: string): any;

package/dist/index.js

@@ -1566,30 +1566,30 @@ const linterContextDefault = {
 
 const allLintRules = AllRules.filter(r => r.severity < Rule.Severity.BULK_WARNING);
 
-//
-// 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.
-//
+/**
+ * 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.
+ */
 function runLinter(tree, context, highlight) {
   let rules = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : allLintRules;
   const warnings = [];