harper.js 0.65.0 → 0.68.0

package/dist/harper.d.ts

@@ -97,6 +97,8 @@ export declare interface Linter {
     setup(): Promise<void>;
     /** Lint the provided text. */
     lint(text: string, options?: LintOptions): Promise<Lint[]>;
+    /** Lint the provided text, maintaining the relationship with the source rule. */
+    organizedLints(text: string, options?: LintOptions): Promise<Record<string, Lint[]>>;
     /** Apply a suggestion from a lint to text, returning the changed text. */
     applySuggestion(text: string, lint: Lint, suggestion: Suggestion): Promise<string>;
     /** Determine if the provided text is likely to be intended to be English.
@@ -142,6 +144,8 @@ export declare interface Linter {
     contextHash(source: string, lint: Lint): Promise<bigint>;
     /** Clear records of all previously ignored lints. */
     clearIgnoredLints(): Promise<void>;
+    /** Clear the words which have been added to the dictionary. This will not clear words from the curated dictionary. */
+    clearWords(): Promise<void>;
     /** Import words into the dictionary. This is a significant operation, so try to batch words. */
     importWords(words: string[]): Promise<void>;
     /** Export all added words from the dictionary. Note that this will NOT export anything from the curated dictionary,
@@ -209,6 +213,7 @@ declare class Linter_2 {
      * Compute the context hash of a given lint.
      */
     context_hash(source_text: string, lint: Lint): bigint;
+    organized_lints(text: string, language: Language): OrganizedGroup[];
     /**
      * Perform the configured linting on the provided text.
      */
@@ -222,6 +227,10 @@ declare class Linter_2 {
      */
     import_ignored_lints(json: string): void;
     clear_ignored_lints(): void;
+    /**
+     * Clear the user dictionary.
+     */
+    clear_words(): void;
     /**
      * Import words into the dictionary.
      */
@@ -265,6 +274,7 @@ export declare class LocalLinter implements Linter {
     private createInner;
     setup(): Promise<void>;
     lint(text: string, options?: LintOptions): Promise<Lint[]>;
+    organizedLints(text: string, options?: LintOptions): Promise<Record<string, Lint[]>>;
     applySuggestion(text: string, lint: Lint, suggestion: Suggestion): Promise<string>;
     isLikelyEnglish(text: string): Promise<boolean>;
     isolateEnglish(text: string): Promise<string>;
@@ -285,6 +295,7 @@ export declare class LocalLinter implements Linter {
     importIgnoredLints(json: string): Promise<void>;
     contextHash(source: string, lint: Lint): Promise<bigint>;
     clearIgnoredLints(): Promise<void>;
+    clearWords(): Promise<void>;
     importWords(words: string[]): Promise<void>;
     exportWords(): Promise<string[]>;
     getDialect(): Promise<Dialect>;
@@ -294,6 +305,16 @@ export declare class LocalLinter implements Linter {
     importStatsFile(statsFile: string): Promise<void>;
 }
 
+/**
+ * Used exclusively for [`Linter::organized_lints`]
+ */
+declare class OrganizedGroup {
+    private constructor();
+    free(): void;
+    group: string;
+    lints: Lint[];
+}
+
 /** Serializable argument to a procedure to be run on the web worker. */
 export declare interface RequestArg {
     json: string;
@@ -394,6 +415,7 @@ export declare class WorkerLinter implements Linter {
     private setupMainEventListeners;
     setup(): Promise<void>;
     lint(text: string, options?: LintOptions): Promise<Lint[]>;
+    organizedLints(text: string, options?: LintOptions): Promise<Record<string, Lint[]>>;
     applySuggestion(text: string, lint: Lint, suggestion: Suggestion): Promise<string>;
     isLikelyEnglish(text: string): Promise<boolean>;
     isolateEnglish(text: string): Promise<string>;
@@ -414,6 +436,7 @@ export declare class WorkerLinter implements Linter {
     importIgnoredLints(json: string): Promise<void>;
     contextHash(source: string, lint: Lint): Promise<bigint>;
     clearIgnoredLints(): Promise<void>;
+    clearWords(): Promise<void>;
     importWords(words: string[]): Promise<void>;
     exportWords(): Promise<string[]>;
     getDialect(): Promise<Dialect>;