harper.js 0.34.1 → 0.35.0

package/dist/harper.d.ts

@@ -131,11 +131,15 @@ export declare interface Linter {
     toTitleCase(text: string): Promise<string>;
     /** Ignore future instances of a lint from a previous linting run in future invocations. */
     ignoreLint(source: string, lint: Lint): Promise<void>;
+    /** Ignore future instances of a lint from a previous linting run in future invocations using its hash. */
+    ignoreLintHash(hash: bigint): 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>;
+    /** Produce a context-sensitive hash that represents a lint.  */
+    contextHash(source: string, lint: Lint): Promise<bigint>;
     /** Clear records of all previously ignored lints. */
     clearIgnoredLints(): Promise<void>;
     /** Import words into the dictionary. This is a significant operation, so try to batch words. */
@@ -197,6 +201,14 @@ declare class Linter_2 {
     get_lint_config_as_object(): any;
     set_lint_config_from_object(object: any): void;
     ignore_lint(source_text: string, lint: Lint): void;
+    /**
+     * Add a specific context hash to the ignored lints list.
+     */
+    ignore_hash(hash: bigint): void;
+    /**
+     * Compute the context hash of a given lint.
+     */
+    context_hash(source_text: string, lint: Lint): bigint;
     /**
      * Perform the configured linting on the provided text.
      */
@@ -268,8 +280,10 @@ export declare class LocalLinter implements Linter {
     getLintDescriptionsHTML(): Promise<Record<string, string>>;
     getLintDescriptionsHTMLAsJSON(): Promise<string>;
     ignoreLint(source: string, lint: Lint): Promise<void>;
+    ignoreLintHash(hash: bigint): Promise<void>;
     exportIgnoredLints(): Promise<string>;
     importIgnoredLints(json: string): Promise<void>;
+    contextHash(source: string, lint: Lint): Promise<bigint>;
     clearIgnoredLints(): Promise<void>;
     importWords(words: string[]): Promise<void>;
     exportWords(): Promise<string[]>;
@@ -286,7 +300,7 @@ export declare interface RequestArg {
     type: SerializableTypes;
 }
 
-export declare type SerializableTypes = 'string' | 'number' | 'boolean' | 'object' | 'Suggestion' | 'Lint' | 'Span' | 'Array' | 'undefined';
+export declare type SerializableTypes = 'string' | 'number' | 'boolean' | 'object' | 'Suggestion' | 'Lint' | 'Span' | 'Array' | 'undefined' | 'bigint';
 
 /** An object that is sent to the web worker to request work to be done. */
 export declare interface SerializedRequest {
@@ -395,8 +409,10 @@ export declare class WorkerLinter implements Linter {
     getDefaultLintConfigAsJSON(): Promise<string>;
     getDefaultLintConfig(): Promise<LintConfig>;
     ignoreLint(source: string, lint: Lint): Promise<void>;
+    ignoreLintHash(hash: bigint): Promise<void>;
     exportIgnoredLints(): Promise<string>;
     importIgnoredLints(json: string): Promise<void>;
+    contextHash(source: string, lint: Lint): Promise<bigint>;
     clearIgnoredLints(): Promise<void>;
     importWords(words: string[]): Promise<void>;
     exportWords(): Promise<string[]>;