Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
feat(obsidian): added dialect switch
Elijah Potter8eba7cf773bd
diff --git a/harper-core/src/linting/lint_group.rs b/harper-core/src/linting/lint_group.rsindex 9bb93fef6..1313fc45e 100644--- a/harper-core/src/linting/lint_group.rs+++ b/harper-core/src/linting/lint_group.rs@@ -199,7 +199,7 @@ impl LintGroup {/// If it returns `false`, it is because a linter with that key already existed in the group.////// This function is not significantly different from [`Self::add`], but allows us to take- /// advantage of some properties of [`PatterLinter`]s for cache optimization.+ /// advantage of some properties of [`PatternLinter`]s for cache optimization.pub fn add_pattern_linter(&mut self,name: impl AsRef<str>,diff --git a/harper-wasm/src/lib.rs b/harper-wasm/src/lib.rsindex 853186be9..9c2af6dd3 100644--- a/harper-wasm/src/lib.rs+++ b/harper-wasm/src/lib.rs@@ -269,6 +269,11 @@ impl Linter {.map(|v| v.iter().collect()).collect()}++ /// Get the dialect this struct was constructed for.+ pub fn get_dialect(&self) -> Dialect {+ self.dialect+ }}#[wasm_bindgen]diff --git a/packages/harper.js/src/Linter.ts b/packages/harper.js/src/Linter.tsindex d9c490c19..0b2714d33 100644--- a/packages/harper.js/src/Linter.ts+++ b/packages/harper.js/src/Linter.ts@@ -71,6 +71,9 @@ export default 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>;}export interface LinterInit {diff --git a/packages/harper.js/src/LocalLinter.ts b/packages/harper.js/src/LocalLinter.tsindex 2427f75a3..c7bb83561 100644--- a/packages/harper.js/src/LocalLinter.ts+++ b/packages/harper.js/src/LocalLinter.ts@@ -1,4 +1,4 @@-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';@@ -120,4 +120,10 @@ export default class LocalLinter implements Linter {return inner.export_words();}++ async getDialect(): Promise<Dialect> {+ const inner = await this.inner;++ return inner.get_dialect();+ }}diff --git a/packages/harper.js/src/WorkerLinter/index.ts b/packages/harper.js/src/WorkerLinter/index.tsindex 2a9076c1e..f927f9720 100644--- a/packages/harper.js/src/WorkerLinter/index.ts+++ b/packages/harper.js/src/WorkerLinter/index.ts@@ -116,30 +116,34 @@ export default class WorkerLinter implements Linter {return JSON.parse(await this.getDefaultLintConfigAsJSON()) as LintConfig;}- async ignoreLint(lint: Lint): Promise<void> {+ ignoreLint(lint: Lint): Promise<void> {return this.rpc('ignoreLint', [lint]);}- async exportIgnoredLints(): Promise<string> {+ exportIgnoredLints(): Promise<string> {return this.rpc('exportIgnoredLints', []);}- async importIgnoredLints(json: string): Promise<void> {+ importIgnoredLints(json: string): Promise<void> {return this.rpc('importIgnoredLints', [json]);}- async clearIgnoredLints(): Promise<void> {+ clearIgnoredLints(): Promise<void> {return this.rpc('clearIgnoredLints', []);}- async importWords(words: string[]): Promise<void> {+ importWords(words: string[]): Promise<void> {return this.rpc('importWords', [words]);}- async exportWords(): Promise<string[]> {+ exportWords(): Promise<string[]> {return this.rpc('exportWords', []);}+ getDialect(): Promise<Dialect> {+ return this.rpc('getDialect', []);+ }+/** Run a procedure on the remote worker. */private async rpc(procName: string, args: any[]): Promise<any> {const promise = new Promise((resolve, reject) => {diff --git a/packages/obsidian-plugin/src/HarperSettingTab.ts b/packages/obsidian-plugin/src/HarperSettingTab.tsindex 318b61118..f27504956 100644--- a/packages/obsidian-plugin/src/HarperSettingTab.ts+++ b/packages/obsidian-plugin/src/HarperSettingTab.ts@@ -2,6 +2,7 @@ import './index.js';import { startCase } from 'lodash-es';import { App, PluginSettingTab, Setting } from 'obsidian';import HarperPlugin, { Settings } from './index.js';+import { Dialect } from 'harper.js';export class HarperSettingTab extends PluginSettingTab {private plugin: HarperPlugin;@@ -28,7 +29,7 @@ export class HarperSettingTab extends PluginSettingTab {const { containerEl } = this;containerEl.empty();- console.log(this.settings.lintSettings);+ console.log(this.settings);new Setting(containerEl).setName('Use Web Worker').addToggle((toggle) =>toggle.setValue(this.settings.useWebWorker).onChange(async (value) => {@@ -37,6 +38,19 @@ export class HarperSettingTab extends PluginSettingTab {}));+ 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);+ });+ });+for (const setting of Object.keys(this.settings.lintSettings)) {const value = this.settings.lintSettings[setting];const description = this.descriptions[setting];diff --git a/packages/obsidian-plugin/src/index.ts b/packages/obsidian-plugin/src/index.tsindex 348eed14a..a959e479b 100644--- a/packages/obsidian-plugin/src/index.ts+++ b/packages/obsidian-plugin/src/index.ts@@ -1,8 +1,8 @@import { toArray } from 'lodash-es';import logoSvg from '../logo.svg';import { Plugin, Menu, PluginManifest, App, Notice } from 'obsidian';-import { LintConfig, Linter, Suggestion } from 'harper.js';-import { LocalLinter, SuggestionKind, WorkerLinter, binary } from 'harper.js';+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';@@ -20,6 +20,7 @@ function suggestionToLabel(sug: Suggestion) {export type Settings = {ignoredLints?: string;useWebWorker: boolean;+ dialect?: Dialect;lintSettings: LintConfig;userDictionary?: string[];};@@ -30,7 +31,7 @@ export default class HarperPlugin extends Plugin {constructor(app: App, manifest: PluginManifest) {super(app, manifest);- this.harper = new WorkerLinter({ binary });+ this.harper = new WorkerLinter({ binary: binaryInlined });this.editorExtensions = [];}@@ -41,11 +42,14 @@ export default class HarperPlugin extends Plugin {const oldSettings = await this.getSettings();- if (settings.useWebWorker != oldSettings.useWebWorker) {+ if (+ settings.useWebWorker != oldSettings.useWebWorker ||+ settings.dialect != oldSettings.dialect+ ) {if (settings.useWebWorker) {- this.harper = new WorkerLinter({ binary });+ this.harper = new WorkerLinter({ binary: binaryInlined, dialect: settings.dialect });} else {- this.harper = new LocalLinter({ binary });+ this.harper = new LocalLinter({ binary: binaryInlined, dialect: settings.dialect });}} else {await this.harper.clearIgnoredLints();@@ -83,7 +87,8 @@ export default class HarperPlugin extends Plugin {ignoredLints: await this.harper.exportIgnoredLints(),useWebWorker: usingWebWorker,lintSettings: await this.harper.getLintConfig(),- userDictionary: await this.harper.exportWords()+ userDictionary: await this.harper.exportWords(),+ dialect: await this.harper.getDialect()};}