harper.js 0.68.0 → 0.72.0

package/dist/harper.d.ts

@@ -49,16 +49,18 @@ declare enum Language {
 export declare class Lint {
     private constructor();
     free(): void;
-    to_json(): string;
-    static from_json(json: string): Lint;
     /**
-     * Get the content of the source material pointed to by [`Self::span`]
+     * Get an array of any suggestions that may resolve the issue.
      */
-    get_problem_text(): string;
+    suggestions(): Suggestion[];
     /**
-     * Get a string representing the general category of the lint.
+     * Get a description of the error as HTML.
      */
-    lint_kind(): string;
+    message_html(): string;
+    /**
+     * Get the content of the source material pointed to by [`Self::span`]
+     */
+    get_problem_text(): string;
     /**
      * Get a string representing the general category of the lint.
      */
@@ -67,10 +69,6 @@ export declare class Lint {
      * Equivalent to calling `.length` on the result of `suggestions()`.
      */
     suggestion_count(): number;
-    /**
-     * Get an array of any suggestions that may resolve the issue.
-     */
-    suggestions(): Suggestion[];
     /**
      * Get the location of the problematic text.
      */
@@ -79,10 +77,12 @@ export declare class Lint {
      * Get a description of the error.
      */
     message(): string;
+    to_json(): string;
+    static from_json(json: string): Lint;
     /**
-     * Get a description of the error as HTML.
+     * Get a string representing the general category of the lint.
      */
-    message_html(): string;
+    lint_kind(): string;
 }
 
 /** A linting rule configuration dependent on upstream Harper's available rules.
@@ -170,54 +170,49 @@ declare class Linter_2 {
     private constructor();
     free(): void;
     /**
-     * Construct a new `Linter`.
-     * Note that this can mean constructing the curated dictionary, which is the most expensive operation
-     * in Harper.
+     * Clear the user dictionary.
      */
-    static new(dialect: Dialect): Linter_2;
+    clear_words(): void;
     /**
-     * Helper method to quickly check if a plain string is likely intended to be English
+     * Get the dialect this struct was constructed for.
      */
-    is_likely_english(text: string): boolean;
+    get_dialect(): Dialect;
     /**
-     * Helper method to remove non-English text from a plain English document.
+     * Add a specific context hash to the ignored lints list.
      */
-    isolate_english(text: string): string;
+    ignore_hash(hash: bigint): void;
+    ignore_lint(source_text: string, lint: Lint): void;
     /**
-     * Get a JSON map containing the descriptions of all the linting rules, formatted as HTML.
+     * Compute the context hash of a given lint.
      */
-    get_lint_descriptions_html_as_json(): string;
+    context_hash(source_text: string, lint: Lint): bigint;
     /**
-     * Get a Record containing the descriptions of all the linting rules, formatted as HTML.
+     * Export words from the dictionary.
+     * Note: this will only return words previously added by [`Self::import_words`].
      */
-    get_lint_descriptions_html_as_object(): any;
+    export_words(): string[];
     /**
-     * Get a JSON map containing the descriptions of all the linting rules, formatted as Markdown.
+     * Import words into the dictionary.
      */
-    get_lint_descriptions_as_json(): string;
+    import_words(additional_words: string[]): void;
     /**
-     * Get a Record containing the descriptions of all the linting rules, formatted as Markdown.
+     * Helper method to remove non-English text from a plain English document.
      */
-    get_lint_descriptions_as_object(): any;
-    get_lint_config_as_json(): string;
-    set_lint_config_from_json(json: string): void;
+    isolate_english(text: string): string;
+    organized_lints(text: string, language: Language): OrganizedGroup[];
     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;
     /**
-     * Add a specific context hash to the ignored lints list.
-     */
-    ignore_hash(hash: bigint): void;
-    /**
-     * Compute the context hash of a given lint.
+     * Apply a suggestion from a given lint.
+     * This action will be logged to the Linter's statistics.
      */
-    context_hash(source_text: string, lint: Lint): bigint;
-    organized_lints(text: string, language: Language): OrganizedGroup[];
+    apply_suggestion(source_text: string, lint: Lint, suggestion: Suggestion): string;
+    import_stats_file(file: string): void;
     /**
-     * Perform the configured linting on the provided text.
+     * Helper method to quickly check if a plain string is likely intended to be English
      */
-    lint(text: string, language: Language): Lint[];
+    is_likely_english(text: string): boolean;
+    clear_ignored_lints(): void;
+    generate_stats_file(): string;
     /**
      * Export the linter's ignored lints as a privacy-respecting JSON list of hashes.
      */
@@ -226,31 +221,36 @@ declare class Linter_2 {
      * Import into the linter's ignored lints from a privacy-respecting JSON list of hashes.
      */
     import_ignored_lints(json: string): void;
-    clear_ignored_lints(): void;
+    get_lint_config_as_json(): string;
+    get_lint_config_as_object(): any;
+    set_lint_config_from_json(json: string): void;
+    set_lint_config_from_object(object: any): void;
     /**
-     * Clear the user dictionary.
+     * Get a JSON map containing the descriptions of all the linting rules, formatted as Markdown.
      */
-    clear_words(): void;
+    get_lint_descriptions_as_json(): string;
     /**
-     * Import words into the dictionary.
+     * Get a Record containing the descriptions of all the linting rules, formatted as Markdown.
      */
-    import_words(additional_words: string[]): void;
+    get_lint_descriptions_as_object(): any;
     /**
-     * Export words from the dictionary.
-     * Note: this will only return words previously added by [`Self::import_words`].
+     * Get a JSON map containing the descriptions of all the linting rules, formatted as HTML.
      */
-    export_words(): string[];
+    get_lint_descriptions_html_as_json(): string;
     /**
-     * Get the dialect this struct was constructed for.
+     * Get a Record containing the descriptions of all the linting rules, formatted as HTML.
      */
-    get_dialect(): Dialect;
+    get_lint_descriptions_html_as_object(): any;
     /**
-     * Apply a suggestion from a given lint.
-     * This action will be logged to the Linter's statistics.
+     * Construct a new `Linter`.
+     * Note that this can mean constructing the curated dictionary, which is the most expensive operation
+     * in Harper.
      */
-    apply_suggestion(source_text: string, lint: Lint, suggestion: Suggestion): string;
-    generate_stats_file(): string;
-    import_stats_file(file: string): void;
+    static new(dialect: Dialect): Linter_2;
+    /**
+     * Perform the configured linting on the provided text.
+     */
+    lint(text: string, language: Language): Lint[];
 }
 
 export declare interface LinterInit {
@@ -337,11 +337,11 @@ export declare interface SerializedRequest {
 export declare class Span {
     private constructor();
     free(): void;
-    to_json(): string;
-    static from_json(json: string): Span;
+    len(): number;
     static new(start: number, end: number): Span;
+    to_json(): string;
     is_empty(): boolean;
-    len(): number;
+    static from_json(json: string): Span;
     start: number;
     end: number;
 }
@@ -352,8 +352,6 @@ export declare class Span {
 export declare class Suggestion {
     private constructor();
     free(): void;
-    to_json(): string;
-    static from_json(json: string): Suggestion;
     /**
      * Get the text that is going to replace the problematic section.
      * If [`Self::kind`] is `SuggestionKind::Remove`, this will return an empty
@@ -361,6 +359,8 @@ export declare class Suggestion {
      */
     get_replacement_text(): string;
     kind(): SuggestionKind;
+    to_json(): string;
+    static from_json(json: string): Suggestion;
 }
 
 /**