Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

feat(obsidian): can now ignore suggestions

Elijah Potter4da93acaef21
diff --git a/harper-wasm/src/lib.rs b/harper-wasm/src/lib.rs
index 5a7ed8e55..6befc85b2 100644
--- a/harper-wasm/src/lib.rs
+++ b/harper-wasm/src/lib.rs
@@ -174,6 +174,10 @@ impl Linter {
Ok(())
}
+
+ pub fn clear_ignored_lints(&mut self) {
+ self.ignored_lints = IgnoredLints::new();
+ }
}
impl Default for Linter {
diff --git a/packages/harper.js/src/Linter.ts b/packages/harper.js/src/Linter.ts
index ec440135f..90630da7c 100644
--- a/packages/harper.js/src/Linter.ts
+++ b/packages/harper.js/src/Linter.ts
@@ -60,4 +60,7 @@ export default interface Linter {
/** Import ignored lints from a JSON list to the linter.
* This function appends to the existing lints, if any. */
importIgnoredLints(json: string): Promise<void>;
+
+ /** Clear records of all previously ignored lints. */
+ clearIgnoredLints(): Promise<void>;
}
diff --git a/packages/harper.js/src/LocalLinter.ts b/packages/harper.js/src/LocalLinter.ts
index 7d9611e87..1a72abd91 100644
--- a/packages/harper.js/src/LocalLinter.ts
+++ b/packages/harper.js/src/LocalLinter.ts
@@ -115,4 +115,10 @@ export default class LocalLinter implements Linter {
return this.inner!.import_ignored_lints(json);
}
+
+ async clearIgnoredLints(): Promise<void> {
+ await this.initialize();
+
+ return this.inner!.clear_ignored_lints();
+ }
}
diff --git a/packages/harper.js/src/WorkerLinter/index.ts b/packages/harper.js/src/WorkerLinter/index.ts
index f5159ae6c..e2dfdfe10 100644
--- a/packages/harper.js/src/WorkerLinter/index.ts
+++ b/packages/harper.js/src/WorkerLinter/index.ts
@@ -125,6 +125,10 @@ export default class WorkerLinter implements Linter {
return this.rpc('importIgnoredLints', [json]);
}
+ async clearIgnoredLints(): Promise<void> {
+ return this.rpc('clearIgnoredLints', []);
+ }
+
/** 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/harper.js/vite.config.js b/packages/harper.js/vite.config.js
index dc7f19a56..f23b88f49 100644
--- a/packages/harper.js/vite.config.js
+++ b/packages/harper.js/vite.config.js
@@ -55,7 +55,8 @@ export default defineConfig({
test: {
browser: {
provider: 'playwright',
- enabled: true
+ enabled: true,
+ headless: true
}
},
assetsInclude: ['**/*.wasm']
diff --git a/packages/obsidian-plugin/src/HarperSettingTab.ts b/packages/obsidian-plugin/src/HarperSettingTab.ts
index 482d4f3fe..318b61118 100644
--- a/packages/obsidian-plugin/src/HarperSettingTab.ts
+++ b/packages/obsidian-plugin/src/HarperSettingTab.ts
@@ -56,6 +56,16 @@ export class HarperSettingTab extends PluginSettingTab {
})
);
}
+
+ 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 --git a/packages/obsidian-plugin/src/index.ts b/packages/obsidian-plugin/src/index.ts
index 3f08de77b..de6c1de00 100644
--- a/packages/obsidian-plugin/src/index.ts
+++ b/packages/obsidian-plugin/src/index.ts
@@ -17,6 +17,7 @@ function suggestionToLabel(sug: Suggestion) {
}
export type Settings = {
+ ignoredLints?: string;
useWebWorker: boolean;
lintSettings: LintConfig;
};
@@ -36,10 +37,20 @@ export default class HarperPlugin extends Plugin {
settings = { useWebWorker: true, lintSettings: {} };
}
- if (settings.useWebWorker) {
- this.harper = new WorkerLinter();
+ const oldSettings = await this.getSettings();
+
+ if (settings.useWebWorker != oldSettings.useWebWorker) {
+ if (settings.useWebWorker) {
+ this.harper = new WorkerLinter();
+ } else {
+ this.harper = new LocalLinter();
+ }
} else {
- this.harper = new LocalLinter();
+ await this.harper.clearIgnoredLints();
+ }
+
+ if (settings.ignoredLints !== undefined) {
+ await this.harper.importIgnoredLints(settings.ignoredLints);
}
await this.harper.setLintConfig(settings.lintSettings);
@@ -54,10 +65,16 @@ export default class HarperPlugin extends Plugin {
await this.saveData(settings);
}
+ public async reinitialize() {
+ const settings = await this.getSettings();
+ await this.initializeFromSettings(settings);
+ }
+
public async getSettings(): Promise<Settings> {
const usingWebWorker = this.harper instanceof WorkerLinter;
return {
+ ignoredLints: await this.harper.exportIgnoredLints(),
useWebWorker: usingWebWorker,
lintSettings: await this.harper.getLintConfig()
};
@@ -157,6 +174,10 @@ export default class HarperPlugin extends Plugin {
severity: 'error',
title: lint.lint_kind(),
message: lint.message(),
+ ignore: async () => {
+ await this.harper.ignoreLint(lint);
+ await this.reinitialize();
+ },
actions: lint.suggestions().map((sug) => {
return {
name: suggestionToLabel(sug),
diff --git a/packages/obsidian-plugin/src/lint.ts b/packages/obsidian-plugin/src/lint.ts
index 10d05fc81..a2591e715 100644
--- a/packages/obsidian-plugin/src/lint.ts
+++ b/packages/obsidian-plugin/src/lint.ts
@@ -21,6 +21,7 @@ import {
RangeSet
} from '@codemirror/state';
import elt from 'crelt';
+import { Lint } from 'harper.js';
type Severity = 'hint' | 'info' | 'warning' | 'error';
@@ -50,6 +51,8 @@ export interface Diagnostic {
/// An optional array of actions that can be taken on this
/// diagnostic.
actions?: readonly Action[];
+ /// A callback for when the user selects to "ignore" the diagnostic.
+ ignore?: () => void;
}
/// An action associated with a diagnostic.
@@ -420,6 +423,20 @@ function renderDiagnostic(view: EditorView, diagnostic: Diagnostic, inPanel: boo
nameElt
);
}),
+ diagnostic.ignore &&
+ elt(
+ 'div',
+ {
+ class: 'cm-diagnosticIgnore',
+ onclick: (e) => {
+ e.preventDefault();
+ if (diagnostic.ignore) {
+ diagnostic.ignore();
+ }
+ }
+ },
+ 'Ignore Diagnostic'
+ ),
diagnostic.source && elt('div', { class: 'cm-diagnosticSource' }, diagnostic.source)
);
}
@@ -500,6 +517,16 @@ const baseTheme = EditorView.baseTheme({
opacity: 0.7
},
+ '.cm-diagnosticIgnore': {
+ color: 'black',
+ padding: 'var(--size-4-1) 0px',
+ fontSize: 'var(--font-ui-small)'
+ },
+
+ '.cm-diagnosticIgnore:hover': {
+ textDecoration: 'underline'
+ },
+
'.cm-lintRange': {
backgroundPosition: 'left bottom',
backgroundRepeat: 'repeat-x',