Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
Merge branch 'master' into build/migrate-pnpm
Elijah Potter9233e94073cf
diff --cc packages/harper.js/src/Linter.tsindex acb7961b9,6ba9f136d..215d863c6--- a/packages/harper.js/src/Linter.ts+++ b/packages/harper.js/src/Linter.ts@@@ -1,6 -1,6 +1,6 @@@- import type { Lint, Span, Suggestion } from 'harper-wasm';-import type { Dialect, Lint, Span, Suggestion } from 'harper-wasm';-import { LintConfig, LintOptions } from './main';-import { BinaryModule } from './binary';++import type { Lint, Span, Suggestion, Dialect } from 'harper-wasm';+import type { BinaryModule } from './binary';+import type { LintConfig, LintOptions } from './main';/** An interface for an object that can perform linting actions. */export default interface Linter {diff --cc packages/harper.js/src/LocalLinter.tsindex 4d1abb848,2ae0acff4..d7bbbc1be--- a/packages/harper.js/src/LocalLinter.ts+++ b/packages/harper.js/src/LocalLinter.ts@@@ -1,10 -1,9 +1,10 @@@- import type { Lint, Span, Suggestion, Linter as WasmLinter } from 'harper-wasm';+ import type { Dialect, Lint, Span, Suggestion, Linter as WasmLinter } from 'harper-wasm';import { Language } from 'harper-wasm';import LazyPromise from 'p-lazy';-import Linter, { LinterInit } from './Linter';-import { LintConfig, LintOptions } from './main';-import { BinaryModule } from './binary';+import type Linter from './Linter';+import type { LinterInit } from './Linter';+import type { BinaryModule } from './binary';+import type { LintConfig, LintOptions } from './main';/** A Linter that runs in the current JavaScript context (meaning it is allowed to block the event loop). */export default class LocalLinter implements Linter {diff --cc packages/harper.js/src/WorkerLinter/index.tsindex 291722224,eb12f4109..0a8984d3f--- a/packages/harper.js/src/WorkerLinter/index.ts+++ b/packages/harper.js/src/WorkerLinter/index.ts@@@ -1,9 -1,8 +1,9 @@@- import type { Lint, Span, Suggestion } from 'harper-wasm';-import type { Lint, Suggestion, Span, Dialect } from 'harper-wasm';-import Linter, { LinterInit } from '../Linter';++import type { Lint, Span, Suggestion, Dialect } from 'harper-wasm';+import type Linter from '../Linter';+import type { LinterInit } from '../Linter';+import type { BinaryModule, DeserializedRequest } from '../binary';+import type { LintConfig, LintOptions } from '../main';import Worker from './worker.ts?worker&inline';-import { LintConfig, LintOptions } from '../main';-import { BinaryModule, DeserializedRequest } from '../binary';/** The data necessary to complete a request once the worker has responded. */export interface RequestItem {diff --cc packages/harper.js/src/binary.tsindex 81e977447,142671800..f65e7b073--- a/packages/harper.js/src/binary.ts+++ b/packages/harper.js/src/binary.ts@@@ -1,10 -1,10 +1,10 @@@- import type { InitInput, Span, Suggestion, Linter as WasmLinter } from 'harper-wasm';-import { default as binaryUrl } from 'harper-wasm/harper_wasm_bg.wasm?no-inline';++import type { InitInput, Span, Suggestion, Linter as WasmLinter, Dialect} from 'harper-wasm';import { default as binaryInlinedUrl } from 'harper-wasm/harper_wasm_bg.wasm?inline';-import { Dialect, InitInput, Span, Suggestion, Linter as WasmLinter } from 'harper-wasm';-import pMemoize from 'p-memoize';+import { default as binaryUrl } from 'harper-wasm/harper_wasm_bg.wasm?no-inline';import LazyPromise from 'p-lazy';+import pMemoize from 'p-memoize';+import type { LintConfig } from './main';import { assert } from './utils';-import { LintConfig } from './main';export const loadBinary = pMemoize(async (binary: string) => {const exports = await import('harper-wasm');diff --cc packages/obsidian-plugin/src/HarperSettingTab.tsindex 01ae62943,f5b9846ce..0f93276e6--- a/packages/obsidian-plugin/src/HarperSettingTab.ts+++ b/packages/obsidian-plugin/src/HarperSettingTab.ts@@@ -1,8 -1,8 +1,9 @@@import './index.js';import { startCase } from 'lodash-es';- import { type App, PluginSettingTab, Setting } from 'obsidian';-import { App, BaseComponent, PluginSettingTab, SearchComponent, Setting } from 'obsidian';-import HarperPlugin, { Settings } from './index.js';++import { type App, BaseComponent, PluginSettingTab, SearchComponent, Setting } from 'obsidian';+import type HarperPlugin from './index.js';+import type { Settings } from './index.js';+ import { Dialect, LintConfig } from 'harper.js';export class HarperSettingTab extends PluginSettingTab {private plugin: HarperPlugin;@@@ -39,9 -33,56 +38,56 @@@toggle.setValue(this.settings.useWebWorker).onChange(async (value) => {this.settings.useWebWorker = value;await this.plugin.initializeFromSettings(this.settings);- })+ }),);+ new Setting(containerEl).setName('English Dialect').addDropdown((dropdown) => {+ dropdown+ .addOption(Dialect.American.toString(), 'American')+ .addOption(Dialect.Canadian.toString(), 'Canadian')+ .addOption(Dialect.British.toString(), 'British')+ .addOption(Dialect.Australian.toString(), 'Australian')+ .setValue((this.settings.dialect ?? Dialect.American).toString())+ .onChange(async (value) => {+ this.settings.dialect = parseInt(value);+ await this.plugin.initializeFromSettings(this.settings);+ });+ });++ new Setting(containerEl).setName('The Danger Zone').addButton((button) => {+ button+ .setButtonText('Forget Ignored Suggestions')+ .onClick(() => {+ this.settings.ignoredLints = undefined;+ this.plugin.initializeFromSettings(this.settings);+ })+ .setWarning();+ });++ new Setting(containerEl)+ .setName('Rules')+ .setDesc('Search for a specific Harper rule.')+ .addSearch((search) => {+ search.setPlaceholder('Search for a rule...').onChange((query) => {+ this.renderLintSettingsToId(query, 'HarperLintSettings');+ });+ });++ const lintSettings = document.createElement('DIV');+ lintSettings.id = 'HarperLintSettings';+ containerEl.appendChild(lintSettings);++ this.renderLintSettings('', lintSettings);+ }++ renderLintSettingsToId(searchQuery: string, id: string) {+ const el = document.getElementById(id);+ this.renderLintSettings(searchQuery, el!);+ }++ renderLintSettings(searchQuery: string, containerEl: HTMLElement) {+ containerEl.innerHTML = '';+for (const setting of Object.keys(this.settings.lintSettings)) {const value = this.settings.lintSettings[setting];const description = this.descriptions[setting];@@@ -58,19 -106,9 +111,9 @@@.onChange(async (value) => {this.settings.lintSettings[setting] = stringToValue(value);await this.plugin.initializeFromSettings(this.settings);- })+ }),);}-- new Setting(containerEl).setName('The Danger Zone').addButton((button) => {- button- .setButtonText('Forget Ignored Suggestions')- .onClick(() => {- this.settings.ignoredLints = undefined;- this.plugin.initializeFromSettings(this.settings);- })- .setWarning();- });}}diff --cc packages/obsidian-plugin/src/index.tsindex 7337c6a39,a959e479b..a1ec7db6c--- a/packages/obsidian-plugin/src/index.ts+++ b/packages/obsidian-plugin/src/index.ts@@@ -1,18 -1,18 +1,18 @@@+import type { Extension } from '@codemirror/state';+import type { LintConfig, Linter, Suggestion } from 'harper.js';- import { LocalLinter, SuggestionKind, WorkerLinter, binary } from 'harper.js';++import { Dialect, LocalLinter, SuggestionKind, WorkerLinter, binary } from 'harper.js';import { toArray } from 'lodash-es';+import { type App, Menu, Notice, Plugin, type PluginManifest } from 'obsidian';import logoSvg from '../logo.svg';-import { Plugin, Menu, PluginManifest, App, Notice } from 'obsidian';-import { Dialect, LintConfig, Linter, Suggestion } from 'harper.js';-import { LocalLinter, SuggestionKind, WorkerLinter, binaryInlined } from 'harper.js';-import { linter } from './lint';-import { Extension } from '@codemirror/state';import { HarperSettingTab } from './HarperSettingTab';+import { linter } from './lint';function suggestionToLabel(sug: Suggestion) {- if (sug.kind() == SuggestionKind.Remove) {+ if (sug.kind() === SuggestionKind.Remove) {return 'Remove';- } else if (sug.kind() == SuggestionKind.Replace) {+ } else if (sug.kind() === SuggestionKind.Replace) {return `Replace with “${sug.get_replacement_text()}”`;- } else if (sug.kind() == SuggestionKind.InsertAfter) {+ } else if (sug.kind() === SuggestionKind.InsertAfter) {return `Insert “${sug.get_replacement_text()}” after this.`;}}diff --cc packages/vscode-plugin/src/tests/suite/helper.tsindex ce7c731aa,a708dd42e..9905895b4--- a/packages/vscode-plugin/src/tests/suite/helper.ts+++ b/packages/vscode-plugin/src/tests/suite/helper.ts@@@ -39,9 -47,12 +47,12 @@@ export function createExpectedDiagnostiexport function compareActualVsExpectedDiagnostics(actual: Diagnostic[],- expected: Diagnostic[]+ expected: Diagnostic[],): void {- expect(actual.length).toBe(expected.length);+ if (actual.length != expected.length) {+ throw new Error(`Expected ${expected.length} diagnostics, got ${actual.length}.`);+ }+for (let i = 0; i < actual.length; i++) {expect(actual[i].source).toBe(expected[i].source);expect(actual[i].message).toBe(expected[i].message);diff --cc packages/vscode-plugin/src/tests/suite/integration.test.tsindex ddec7cad8,be877f2be..861cb7bf2--- a/packages/vscode-plugin/src/tests/suite/integration.test.ts+++ b/packages/vscode-plugin/src/tests/suite/integration.test.ts@@@ -9,7 -9,8 +9,8 @@@ importcreateRange,getActualDiagnostics,openFile,+ sleep,+ openUntitled,- sleep} from './helper';describe('Integration >', () => {diff --cc packages/wordpress-plugin/src/harper/SidebarTabContainer.tsxindex 1baecb752,6cc0da8c5..2580ddbdf--- a/packages/wordpress-plugin/src/harper/SidebarTabContainer.tsx+++ b/packages/wordpress-plugin/src/harper/SidebarTabContainer.tsx@@@ -1,8 -1,9 +1,9 @@@- import { Panel, PanelBody, TabPanel } from '@wordpress/components';import React from 'react';+import type { IgnorableLintBox } from './Box';- import LintList from './LintList';import LintSettingList from './LintSettingList';+ import DialectSelectRow from './DialectSelectRow';+ import { Panel, PanelBody, SelectControl, TabPanel } from '@wordpress/components';+ import LintList from './LintList';-import { IgnorableLintBox } from './Box';export default function SidebarTabContainer({lintBoxes,diff --cc packages/wordpress-plugin/src/harper/useLintBoxes.tsindex 056192d48,3d1bc8fc8..aad7e56ec--- a/packages/wordpress-plugin/src/harper/useLintBoxes.ts+++ b/packages/wordpress-plugin/src/harper/useLintBoxes.ts@@@ -1,11 -1,12 +1,12 @@@-import usePersonalDictionary from './usePersonalDictionary';+import type { Lint } from 'harper.js';import { useCallback, useEffect, useState } from 'react';-import { IgnorableLintBox, LintBox } from './Box';-import RichText from './RichText';-import { Lint } from 'harper.js';+import { type IgnorableLintBox, LintBox } from './Box';import { useLinter } from './LinterProvider';-import useLintConfig from './useLintConfig';+import type RichText from './RichText';import useIgnoredLintState, { useIgnoreLint } from './useIgnoredLintState';+import useLintConfig from './useLintConfig';+import usePersonalDictionary from './usePersonalDictionary';+ import useDialect from './useDialect';/*** Lint given elements and return the resulting error targets.