harper.js 0.25.1 → 0.29.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 Elijah Potter
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/harper.d.ts

@@ -1,3 +1,46 @@
+export declare const binary: BinaryModule;
+
+export declare const binaryInlined: BinaryModule;
+
+/** This class aims to define the communication protocol between the main thread and the worker.
+ * Note that much of the complication here comes from the fact that we can't serialize function calls or referenced WebAssembly memory.*/
+export declare class BinaryModule {
+    url: string | URL;
+    private inner;
+    constructor(url: string | URL);
+    getDefaultLintConfigAsJSON(): Promise<string>;
+    getDefaultLintConfig(): Promise<LintConfig>;
+    toTitleCase(text: string): Promise<string>;
+    setup(): Promise<void>;
+    createLinter(dialect?: Dialect): Promise<Linter_2>;
+    serializeArg(arg: any): Promise<RequestArg>;
+    serialize(req: DeserializedRequest): Promise<SerializedRequest>;
+    deserializeArg(requestArg: RequestArg): Promise<any>;
+    deserialize(request: SerializedRequest): Promise<DeserializedRequest>;
+}
+
+/** An object that is received by the web worker to request work to be done. */
+export declare interface DeserializedRequest {
+    /** The procedure to be executed. */
+    procName: string;
+    /** The arguments to the procedure */
+    args: any[];
+}
+
+export declare enum Dialect {
+    American = 0,
+    British = 1,
+    Australian = 2,
+    Canadian = 3,
+}
+
+export declare function isSerializedRequest(v: unknown): v is SerializedRequest;
+
+declare enum Language {
+    Plain = 0,
+    Markdown = 1,
+}
+
 /**
  * An error found in provided text.
  *
@@ -50,8 +93,8 @@ export declare interface Linter {
     setup(): Promise<void>;
     /** Lint the provided text. */
     lint(text: string, options?: LintOptions): Promise<Lint[]>;
-    /** Apply a suggestion to the given text, returning the transformed result. */
-    applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
+    /** 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.
      * The algorithm can be described as "proof of concept" and as such does not work terribly well.*/
     isLikelyEnglish(text: string): Promise<boolean>;
@@ -79,7 +122,7 @@ export declare interface Linter {
     /** 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>;
+    ignoreLint(source: string, 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.
@@ -92,22 +135,109 @@ export declare interface Linter {
     /** Export all added words from the dictionary. Note that this will NOT export anything from the curated dictionary,
      * only words from previous calls to `this.importWords`. */
     exportWords(): Promise<string[]>;
+    /** Get the dialect of English this linter was constructed for. */
+    getDialect(): Promise<Dialect>;
+    /** Get the dialect of English this linter was constructed for. */
+    setDialect(dialect: Dialect): Promise<void>;
+    /** Summarize the linter's usage statistics.
+     * You may optionally pass in a start and/or end time.
+     *
+     * If so, the summary with only include data from _after_ the start time but _before_ the end time. */
+    summarizeStats(start?: bigint, end?: bigint): Promise<Summary>;
+    /** Generate a statistics log file you can save to permanent storage. */
+    generateStatsFile(): Promise<string>;
+    /** Import a statistics log file. */
+    importStatsFile(statsFile: string): Promise<void>;
+}
+
+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.
+     */
+    static new(dialect: Dialect): Linter_2;
+    /**
+     * Helper method to quickly check if a plain string is likely intended to be English
+     */
+    is_likely_english(text: string): boolean;
+    /**
+     * Helper method to remove non-English text from a plain English document.
+     */
+    isolate_english(text: string): string;
+    /**
+     * Get a JSON map containing the descriptions of all the linting rules.
+     */
+    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_lint_descriptions_as_object(): any;
+    get_lint_config_as_object(): any;
+    set_lint_config_from_object(object: any): void;
+    ignore_lint(source_text: string, lint: Lint): void;
+    /**
+     * Perform the configured linting on the provided text.
+     */
+    lint(text: string, language: Language): Lint[];
+    /**
+     * Export the linter's ignored lints as a privacy-respecting JSON list of hashes.
+     */
+    export_ignored_lints(): string;
+    /**
+     * 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;
+    /**
+     * Import words into the dictionary.
+     */
+    import_words(additional_words: string[]): void;
+    /**
+     * Export words from the dictionary.
+     * Note: this will only return words previously added by [`Self::import_words`].
+     */
+    export_words(): string[];
+    /**
+     * Get the dialect this struct was constructed for.
+     */
+    get_dialect(): Dialect;
+    /**
+     * Apply a suggestion from a given lint.
+     * This action will be logged to the Linter's statistics.
+     */
+    apply_suggestion(source_text: string, lint: Lint, suggestion: Suggestion): string;
+    generate_stats_file(): string;
+    import_stats_file(file: string): void;
+}
+
+export declare interface LinterInit {
+    /** The module or path to the WebAssembly binary. */
+    binary: BinaryModule;
+    /** The dialect of English Harper should use. If omitted, Harper will default to American English. */
+    dialect?: Dialect;
 }
 
 /** The option used to configure the parser for an individual linting operation. */
-export declare type LintOptions = {
+export declare interface LintOptions {
     /** The markup language that is being passed. Defaults to `markdown`. */
     language?: 'plaintext' | 'markdown';
-};
+}
 
 /** A Linter that runs in the current JavaScript context (meaning it is allowed to block the event loop).  */
 export declare class LocalLinter implements Linter {
+    binary: BinaryModule;
     private inner;
-    /** Initialize the WebAssembly and construct the inner Linter. */
-    private initialize;
+    constructor(init: LinterInit);
+    private createInner;
     setup(): Promise<void>;
     lint(text: string, options?: LintOptions): Promise<Lint[]>;
-    applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
+    applySuggestion(text: string, lint: Lint, suggestion: Suggestion): Promise<string>;
     isLikelyEnglish(text: string): Promise<boolean>;
     isolateEnglish(text: string): Promise<string>;
     getLintConfig(): Promise<LintConfig>;
@@ -119,12 +249,33 @@ export declare class LocalLinter implements Linter {
     toTitleCase(text: string): Promise<string>;
     getLintDescriptions(): Promise<Record<string, string>>;
     getLintDescriptionsAsJSON(): Promise<string>;
-    ignoreLint(lint: Lint): Promise<void>;
+    ignoreLint(source: string, lint: Lint): Promise<void>;
     exportIgnoredLints(): Promise<string>;
     importIgnoredLints(json: string): Promise<void>;
     clearIgnoredLints(): Promise<void>;
     importWords(words: string[]): Promise<void>;
     exportWords(): Promise<string[]>;
+    getDialect(): Promise<Dialect>;
+    setDialect(dialect: Dialect): Promise<void>;
+    summarizeStats(start?: bigint, end?: bigint): Promise<any>;
+    generateStatsFile(): Promise<string>;
+    importStatsFile(statsFile: string): Promise<void>;
+}
+
+/** Serializable argument to a procedure to be run on the web worker. */
+export declare interface RequestArg {
+    json: string;
+    type: SerializableTypes;
+}
+
+export declare type SerializableTypes = 'string' | 'number' | 'boolean' | 'object' | 'Suggestion' | 'Lint' | 'Span' | 'Array' | 'undefined';
+
+/** An object that is sent to the web worker to request work to be done. */
+export declare interface SerializedRequest {
+    /** The procedure to be executed. */
+    procName: string;
+    /** The arguments to the procedure */
+    args: RequestArg[];
 }
 
 /**
@@ -177,19 +328,41 @@ export declare enum SuggestionKind {
     InsertAfter = 2,
 }
 
+/**
+ * Represents the summary of linting results.
+ */
+export declare interface Summary {
+    /**
+     * An object mapping each lint type to its count.
+     * Example: `{ "Spelling": 4, "Capitalization": 1 }`
+     */
+    lint_counts: Record<string, number>;
+    /**
+     * The total number of fixes applied.
+     */
+    total_applied: number;
+    /**
+     * An object mapping misspelled words to their occurrence counts.
+     * Example: `{ "mispelled": 1, "mispell": 1, "thigs": 2 }`
+     */
+    misspelled: Record<string, number>;
+}
+
 /** A Linter that spins up a dedicated web worker to do processing on a separate thread.
  * Main benefit: this Linter will not block the event loop for large documents.
  *
  * NOTE: This class will not work properly in Node. In that case, just use `LocalLinter`. */
 export declare class WorkerLinter implements Linter {
+    private binary;
+    private dialect?;
     private worker;
     private requestQueue;
     private working;
-    constructor();
+    constructor(init: LinterInit);
     private setupMainEventListeners;
     setup(): Promise<void>;
     lint(text: string, options?: LintOptions): Promise<Lint[]>;
-    applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
+    applySuggestion(text: string, lint: Lint, suggestion: Suggestion): Promise<string>;
     isLikelyEnglish(text: string): Promise<boolean>;
     isolateEnglish(text: string): Promise<string>;
     getLintConfig(): Promise<LintConfig>;
@@ -201,12 +374,17 @@ export declare class WorkerLinter implements Linter {
     getLintDescriptions(): Promise<Record<string, string>>;
     getDefaultLintConfigAsJSON(): Promise<string>;
     getDefaultLintConfig(): Promise<LintConfig>;
-    ignoreLint(lint: Lint): Promise<void>;
+    ignoreLint(source: string, lint: Lint): Promise<void>;
     exportIgnoredLints(): Promise<string>;
     importIgnoredLints(json: string): Promise<void>;
     clearIgnoredLints(): Promise<void>;
     importWords(words: string[]): Promise<void>;
     exportWords(): Promise<string[]>;
+    getDialect(): Promise<Dialect>;
+    setDialect(dialect: Dialect): Promise<void>;
+    summarizeStats(start?: bigint, end?: bigint): Promise<any>;
+    generateStatsFile(): Promise<string>;
+    importStatsFile(statsFile: string): Promise<void>;
     /** Run a procedure on the remote worker. */
     private rpc;
     private submitRemainingRequests;