harper.js 0.15.0 → 0.17.0

package/api-extractor.json

@@ -0,0 +1,20 @@
+{
+	"mainEntryPointFilePath": "./dist/harper.d.ts",
+	"apiReport": {
+		"enabled": false
+	},
+	"docModel": {
+		"enabled": true
+	},
+	"dtsRollup": {
+		"enabled": false
+	},
+	"bundledPackages": ["wasm"],
+	"messages": {
+		"extractorMessageReporting": {
+			"ae-missing-release-tag": {
+				"logLevel": "none"
+			}
+		}
+	}
+}

package/dist/harper.d.ts

@@ -1,9 +1,41 @@
-import { Lint } from 'wasm';
-import { Span } from 'wasm';
-import { Suggestion } from 'wasm';
-
-export { Lint }
+/**
+ * An error found in provided text.
+ *
+ * May include zero or more suggestions that may fix the problematic text.
+ */
+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_problem_text(): string;
+    /**
+     * Get a string representing the general category of the lint.
+     */
+    lint_kind(): string;
+    /**
+     * 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.
+     */
+    span(): Span;
+    /**
+     * Get a description of the error.
+     */
+    message(): string;
+}
 
+/** A linting rule configuration dependent on upstream Harper's available rules.
+ * This is a record, since you shouldn't hard-code the existence of any particular rules and should generalize based on this struct. */
 export declare type LintConfig = Record<string, boolean | undefined>;
 
 /** An interface for an object that can perform linting actions. */
@@ -13,7 +45,7 @@ export declare interface Linter {
      * This function exists to allow you to do this work when it is of least impact to the user experiences (i.e. while you're loading something else). */
     setup(): Promise<void>;
     /** Lint the provided text. */
-    lint(text: string): Promise<Lint[]>;
+    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>;
     /** Determine if the provided text is likely to be intended to be English.
@@ -24,6 +56,12 @@ export declare interface Linter {
     isolateEnglish(text: string): Promise<string>;
     /** Get the linter's current configuration. */
     getLintConfig(): Promise<LintConfig>;
+    /** Get the default (unset) linter configuration as JSON.
+     * This method does not effect the caller's lint configuration, nor does it return the current one. */
+    getDefaultLintConfigAsJSON(): Promise<string>;
+    /** Get the default (unset) linter configuration.
+     * This method does not effect the caller's lint configuration, nor does it return the current one. */
+    getDefaultLintConfig(): Promise<LintConfig>;
     /** Set the linter's current configuration. */
     setLintConfig(config: LintConfig): Promise<void>;
     /** Get the linter's current configuration as JSON. */
@@ -38,17 +76,25 @@ export declare interface Linter {
     toTitleCase(text: string): Promise<string>;
 }
 
-/** A Linter that runs in the current JavaScript context (meaning it is allowed to block the event loop). */
+/** The option used to configure the parser for an individual linting operation. */
+export declare type 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 {
     private inner;
     /** Initialize the WebAssembly and construct the inner Linter. */
     private initialize;
     setup(): Promise<void>;
-    lint(text: string): Promise<Lint[]>;
+    lint(text: string, options?: LintOptions): Promise<Lint[]>;
     applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
     isLikelyEnglish(text: string): Promise<boolean>;
     isolateEnglish(text: string): Promise<string>;
     getLintConfig(): Promise<LintConfig>;
+    getDefaultLintConfigAsJSON(): Promise<string>;
+    getDefaultLintConfig(): Promise<LintConfig>;
     setLintConfig(config: LintConfig): Promise<void>;
     getLintConfigAsJSON(): Promise<string>;
     setLintConfigWithJSON(config: string): Promise<void>;
@@ -57,20 +103,60 @@ export declare class LocalLinter implements Linter {
     getLintDescriptionsAsJSON(): Promise<string>;
 }
 
-export { Span }
+/**
+ * A struct that represents two character indices in a string: a start and an end.
+ */
+export declare class Span {
+    private constructor();
+    free(): void;
+    to_json(): string;
+    static from_json(json: string): Span;
+    static new(start: number, end: number): Span;
+    is_empty(): boolean;
+    len(): number;
+    start: number;
+    end: number;
+}
 
-export { Suggestion }
+/**
+ * A suggestion to fix a Lint.
+ */
+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
+     * string.
+     */
+    get_replacement_text(): string;
+    kind(): SuggestionKind;
+}
 
+/**
+ * Tags the variant of suggestion.
+ */
 export declare enum SuggestionKind {
+    /**
+     * Replace the problematic text.
+     */
     Replace = 0,
-    Remove = 1
+    /**
+     * Remove the problematic text.
+     */
+    Remove = 1,
+    /**
+     * Insert additional text after the error.
+     */
+    InsertAfter = 2,
 }
 
 /** 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`.
- * Also requires top-level await to work. */
+ * NOTE: This class will not work properly in Node. In that case, just use `LocalLinter`. */
 export declare class WorkerLinter implements Linter {
     private worker;
     private requestQueue;
@@ -78,7 +164,7 @@ export declare class WorkerLinter implements Linter {
     constructor();
     private setupMainEventListeners;
     setup(): Promise<void>;
-    lint(text: string): Promise<Lint[]>;
+    lint(text: string, options?: LintOptions): Promise<Lint[]>;
     applySuggestion(text: string, suggestion: Suggestion, span: Span): Promise<string>;
     isLikelyEnglish(text: string): Promise<boolean>;
     isolateEnglish(text: string): Promise<string>;
@@ -89,6 +175,8 @@ export declare class WorkerLinter implements Linter {
     toTitleCase(text: string): Promise<string>;
     getLintDescriptionsAsJSON(): Promise<string>;
     getLintDescriptions(): Promise<Record<string, string>>;
+    getDefaultLintConfigAsJSON(): Promise<string>;
+    getDefaultLintConfig(): Promise<LintConfig>;
     /** Run a procedure on the remote worker. */
     private rpc;
     private submitRemainingRequests;