harper.js 0.18.0 → 0.19.0

package/dist/harper.d.ts

@@ -16,6 +16,10 @@ export declare class Lint {
      * Get a string representing the general category of the lint.
      */
     lint_kind(): string;
+    /**
+     * Get a string representing the general category of the lint.
+     */
+    lint_kind_pretty(): string;
     /**
      * Equivalent to calling `.length` on the result of `suggestions()`.
      */
@@ -23,7 +27,7 @@ export declare class Lint {
     /**
      * Get an array of any suggestions that may resolve the issue.
      */
-    suggestions(): (Suggestion)[];
+    suggestions(): Suggestion[];
     /**
      * Get the location of the problematic text.
      */
@@ -74,6 +78,15 @@ export declare interface Linter {
     getLintDescriptions(): 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. */
+    ignoreLint(lint: Lint): Promise<void>;
+    /** Export the ignored lints to a JSON list of privacy-respecting hashes. */
+    exportIgnoredLints(): Promise<string>;
+    /** Import ignored lints from a JSON list to the linter.
+     * This function appends to the existing lints, if any. */
+    importIgnoredLints(json: string): Promise<void>;
+    /** Clear records of all previously ignored lints. */
+    clearIgnoredLints(): Promise<void>;
 }
 
 /** The option used to configure the parser for an individual linting operation. */
@@ -101,6 +114,10 @@ export declare class LocalLinter implements Linter {
     toTitleCase(text: string): Promise<string>;
     getLintDescriptions(): Promise<Record<string, string>>;
     getLintDescriptionsAsJSON(): Promise<string>;
+    ignoreLint(lint: Lint): Promise<void>;
+    exportIgnoredLints(): Promise<string>;
+    importIgnoredLints(json: string): Promise<void>;
+    clearIgnoredLints(): Promise<void>;
 }
 
 /**
@@ -177,6 +194,10 @@ export declare class WorkerLinter implements Linter {
     getLintDescriptions(): Promise<Record<string, string>>;
     getDefaultLintConfigAsJSON(): Promise<string>;
     getDefaultLintConfig(): Promise<LintConfig>;
+    ignoreLint(lint: Lint): Promise<void>;
+    exportIgnoredLints(): Promise<string>;
+    importIgnoredLints(json: string): Promise<void>;
+    clearIgnoredLints(): Promise<void>;
     /** Run a procedure on the remote worker. */
     private rpc;
     private submitRemainingRequests;