harper.js 0.33.0 → 0.34.1

package/dist/harper.d.ts

@@ -79,6 +79,10 @@ export declare class Lint {
      * Get a description of the error.
      */
     message(): string;
+    /**
+     * Get a description of the error as HTML.
+     */
+    message_html(): string;
 }
 
 /** A linting rule configuration dependent on upstream Harper's available rules.
@@ -115,10 +119,14 @@ export declare interface Linter {
     getLintConfigAsJSON(): Promise<string>;
     /** Set the linter's current configuration from JSON. */
     setLintConfigWithJSON(config: string): Promise<void>;
-    /** Get the linting rule descriptions as a JSON map. */
+    /** Get the linting rule descriptions as a JSON map, formatted in Markdown. */
     getLintDescriptionsAsJSON(): Promise<string>;
-    /** Get the linting rule descriptions as an object */
+    /** Get the linting rule descriptions as an object, formatted in Markdown. */
     getLintDescriptions(): Promise<Record<string, string>>;
+    /** Get the linting rule descriptions as a JSON map, formatted in HTML. */
+    getLintDescriptionsHTMLAsJSON(): Promise<string>;
+    /** Get the linting rule descriptions as an object, formatted in HTML */
+    getLintDescriptionsHTML(): Promise<Record<string, string>>;
     /** Convert a string to Chicago-style title case. */
     toTitleCase(text: string): Promise<string>;
     /** Ignore future instances of a lint from a previous linting run in future invocations. */
@@ -168,16 +176,24 @@ declare class Linter_2 {
      */
     isolate_english(text: string): string;
     /**
-     * Get a JSON map containing the descriptions of all the linting rules.
+     * Get a JSON map containing the descriptions of all the linting rules, formatted as HTML.
+     */
+    get_lint_descriptions_html_as_json(): string;
+    /**
+     * Get a Record containing the descriptions of all the linting rules, formatted as HTML.
+     */
+    get_lint_descriptions_html_as_object(): any;
+    /**
+     * Get a JSON map containing the descriptions of all the linting rules, formatted as Markdown.
      */
     get_lint_descriptions_as_json(): string;
-    get_lint_config_as_json(): string;
-    set_lint_config_from_json(json: string): void;
-    summarize_stats(start_time?: bigint | null, end_time?: bigint | null): any;
     /**
-     * Get a Record containing the descriptions of all the linting rules.
+     * Get a Record containing the descriptions of all the linting rules, formatted as Markdown.
      */
     get_lint_descriptions_as_object(): any;
+    get_lint_config_as_json(): string;
+    set_lint_config_from_json(json: string): void;
+    summarize_stats(start_time?: bigint | null, end_time?: bigint | null): any;
     get_lint_config_as_object(): any;
     set_lint_config_from_object(object: any): void;
     ignore_lint(source_text: string, lint: Lint): void;
@@ -249,6 +265,8 @@ export declare class LocalLinter implements Linter {
     toTitleCase(text: string): Promise<string>;
     getLintDescriptions(): Promise<Record<string, string>>;
     getLintDescriptionsAsJSON(): Promise<string>;
+    getLintDescriptionsHTML(): Promise<Record<string, string>>;
+    getLintDescriptionsHTMLAsJSON(): Promise<string>;
     ignoreLint(source: string, lint: Lint): Promise<void>;
     exportIgnoredLints(): Promise<string>;
     importIgnoredLints(json: string): Promise<void>;
@@ -372,6 +390,8 @@ export declare class WorkerLinter implements Linter {
     toTitleCase(text: string): Promise<string>;
     getLintDescriptionsAsJSON(): Promise<string>;
     getLintDescriptions(): Promise<Record<string, string>>;
+    getLintDescriptionsHTMLAsJSON(): Promise<string>;
+    getLintDescriptionsHTML(): Promise<Record<string, string>>;
     getDefaultLintConfigAsJSON(): Promise<string>;
     getDefaultLintConfig(): Promise<LintConfig>;
     ignoreLint(source: string, lint: Lint): Promise<void>;