Skip to content

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

feat(obsidian): allow users to exclude files and paths (#1569)

Elijah Potterf30d08478d75
diff --git a/packages/obsidian-plugin/package.json b/packages/obsidian-plugin/package.json
index b93560195..948e4e944 100644
--- a/packages/obsidian-plugin/package.json
+++ b/packages/obsidian-plugin/package.json
@@ -35,6 +35,7 @@
"crelt": "^1.0.5",
"harper.js": "workspace:*",
"lodash-es": "^4.17.21",
+ "minimatch": "^10.0.3",
"tslib": "catalog:"
}
}
diff --git a/packages/obsidian-plugin/src/HarperSettingTab.ts b/packages/obsidian-plugin/src/HarperSettingTab.ts
index faa1e8abe..2e14199e6 100644
--- a/packages/obsidian-plugin/src/HarperSettingTab.ts
+++ b/packages/obsidian-plugin/src/HarperSettingTab.ts
@@ -4,8 +4,8 @@ import { startCase } from 'lodash-es';
import { type App, PluginSettingTab, Setting } from 'obsidian';
import type State from './State.js';
import type { Settings } from './State.js';
-import { dictToString, stringToDict } from './dictUtils';
import type HarperPlugin from './index.js';
+import { linesToString, stringToLines } from './textUtils';
export class HarperSettingTab extends PluginSettingTab {
private state: State;
@@ -78,13 +78,27 @@ export class HarperSettingTab extends PluginSettingTab {
)
.addTextArea((ta) => {
ta.inputEl.cols = 20;
- ta.setValue(dictToString(this.settings.userDictionary ?? [''])).onChange(async (v) => {
- const dict = stringToDict(v);
+ ta.setValue(linesToString(this.settings.userDictionary ?? [''])).onChange(async (v) => {
+ const dict = stringToLines(v);
this.settings.userDictionary = dict;
await this.state.initializeFromSettings(this.settings);
});
});
+ new Setting(containerEl)
+ .setName('Ignored Files')
+ .setDesc(
+ 'Instruct Harper to ignore certain files in your vault. Accepts glob matches (`folder/**`, etc.)',
+ )
+ .addTextArea((ta) => {
+ ta.inputEl.cols = 20;
+ ta.setValue(linesToString(this.settings.ignoredGlobs ?? [''])).onChange(async (v) => {
+ const lines = stringToLines(v);
+ this.settings.ignoredGlobs = lines;
+ await this.state.initializeFromSettings(this.settings);
+ });
+ });
+
new Setting(containerEl)
.setName('Delay')
.setDesc(
diff --git a/packages/obsidian-plugin/src/State.test.ts b/packages/obsidian-plugin/src/State.test.ts
index d329228ae..15dac647c 100644
--- a/packages/obsidian-plugin/src/State.test.ts
+++ b/packages/obsidian-plugin/src/State.test.ts
@@ -7,6 +7,7 @@ function createEphemeralState(): State {
return new State(
(_) => Promise.resolve(),
() => {},
+ undefined,
);
}
diff --git a/packages/obsidian-plugin/src/State.ts b/packages/obsidian-plugin/src/State.ts
index 27278ec05..5dbfcd171 100644
--- a/packages/obsidian-plugin/src/State.ts
+++ b/packages/obsidian-plugin/src/State.ts
@@ -1,8 +1,9 @@
-import type { Extension } from '@codemirror/state';
+import type { Extension, StateField } from '@codemirror/state';
import type { LintConfig, Linter, Suggestion } from 'harper.js';
import { type Dialect, LocalLinter, SuggestionKind, WorkerLinter, binaryInlined } from 'harper.js';
import { toArray } from 'lodash-es';
-import type { Workspace } from 'obsidian';
+import { minimatch } from 'minimatch';
+import type { MarkdownFileInfo, MarkdownView, Workspace } from 'obsidian';
import { linter } from './lint';
export type Settings = {
@@ -12,6 +13,7 @@ export type Settings = {
lintSettings: LintConfig;
userDictionary?: string[];
delay?: number;
+ ignoredGlobs?: string[];
};
const DEFAULT_DELAY = -1;
@@ -24,13 +26,20 @@ export default class State {
private delay: number;
private workspace: Workspace;
private onExtensionChange: () => void;
+ private ignoredGlobs?: string[];
+ private editorViewField?: StateField<MarkdownFileInfo>;
/** The CodeMirror extension objects that should be inserted by the host. */
private editorExtensions: Extension[];
/** @param saveDataCallback A callback which will be used to save data on disk.
- * @param onExtensionChange A callback this class will run when the extension array is modified. */
- constructor(saveDataCallback: (data: any) => Promise<void>, onExtensionChange: () => void) {
+ * @param onExtensionChange A callback this class will run when the extension array is modified.
+ * @param editorViewField Needed to provide support for ignoring files based on path.*/
+ constructor(
+ saveDataCallback: (data: any) => Promise<void>,
+ onExtensionChange: () => void,
+ editorViewField?: StateField<MarkdownFileInfo>,
+ ) {
this.harper = new WorkerLinter({ binary: binaryInlined });
this.delay = DEFAULT_DELAY;
this.saveData = saveDataCallback;
@@ -77,6 +86,7 @@ export default class State {
this.harper.setup();
this.delay = settings.delay ?? DEFAULT_DELAY;
+ this.ignoredGlobs = settings.ignoredGlobs;
// Reinitialize it.
if (this.hasEditorLinter()) {
@@ -91,6 +101,22 @@ export default class State {
private constructEditorLinter(): Extension {
return linter(
async (view) => {
+ const ignoredGlobs = this.ignoredGlobs ?? [];
+
+ if (this.editorViewField != null) {
+ const mdView = view.state.field(this.editorViewField) as MarkdownView;
+ const file = mdView?.file;
+ const path = file?.path!;
+
+ if (path != null) {
+ for (const glob of ignoredGlobs) {
+ if (minimatch(path, glob)) {
+ return [];
+ }
+ }
+ }
+ }
+
const text = view.state.doc.sliceString(-1);
const chars = toArray(text);
@@ -191,6 +217,7 @@ export default class State {
userDictionary: await this.harper.exportWords(),
dialect: await this.harper.getDialect(),
delay: this.delay,
+ ignoredGlobs: this.ignoredGlobs,
};
}
diff --git a/packages/obsidian-plugin/src/index.ts b/packages/obsidian-plugin/src/index.ts
index cc97b9771..ebbb2b2f8 100644
--- a/packages/obsidian-plugin/src/index.ts
+++ b/packages/obsidian-plugin/src/index.ts
@@ -1,5 +1,5 @@
import { Dialect } from 'harper.js';
-import { type App, Menu, Notice, Plugin, type PluginManifest } from 'obsidian';
+import { type App, Menu, Notice, Plugin, type PluginManifest, editorViewField } from 'obsidian';
import logoSvg from '../logo.svg?raw';
import packageJson from '../package.json';
import { HarperSettingTab } from './HarperSettingTab';
@@ -41,6 +41,7 @@ export default class HarperPlugin extends Plugin {
this.state = new State(
(n) => this.saveData(n),
() => this.app.workspace.updateOptions(),
+ editorViewField,
);
}
diff --git a/packages/obsidian-plugin/src/dictUtils.test.ts b/packages/obsidian-plugin/src/textUtils.test.ts
similarity index 80%
rename from packages/obsidian-plugin/src/dictUtils.test.ts
rename to packages/obsidian-plugin/src/textUtils.test.ts
index 14698e221..fdd527db2 100644
--- a/packages/obsidian-plugin/src/dictUtils.test.ts
+++ b/packages/obsidian-plugin/src/textUtils.test.ts
@@ -1,5 +1,5 @@
import { expect, test } from 'vitest';
-import { dictToString, stringToDict } from './dictUtils';
+import { linesToString, stringToLines } from './textUtils';
test('Dictionary values are reversible', () => {
const possibleDicts = [
@@ -66,8 +66,8 @@ test('Dictionary values are reversible', () => {
];
for (const set of possibleDicts) {
- const text = dictToString(set);
- const back = stringToDict(text);
+ const text = linesToString(set);
+ const back = stringToLines(text);
expect(back).toStrictEqual(set);
}
@@ -76,10 +76,10 @@ test('Dictionary values are reversible', () => {
test('Can handle multiple newlines', () => {
const dictText = 'worda\n\nwordb';
- expect(stringToDict(dictText)).toStrictEqual(['worda', 'wordb']);
+ expect(stringToLines(dictText)).toStrictEqual(['worda', 'wordb']);
});
test('Can handle carriage returns', () => {
const dictText = 'worda\r\n\r\nwordb\r\nwordc';
- expect(stringToDict(dictText)).toStrictEqual(['worda', 'wordb', 'wordc']);
+ expect(stringToLines(dictText)).toStrictEqual(['worda', 'wordb', 'wordc']);
});
diff --git a/packages/obsidian-plugin/src/dictUtils.ts b/packages/obsidian-plugin/src/textUtils.ts
similarity index 53%
rename from packages/obsidian-plugin/src/dictUtils.ts
rename to packages/obsidian-plugin/src/textUtils.ts
index 63ef7a80b..1e33dc6a9 100644
--- a/packages/obsidian-plugin/src/dictUtils.ts
+++ b/packages/obsidian-plugin/src/textUtils.ts
@@ -1,5 +1,5 @@
-/** Converts the content of a text area to viable dictionary values. */
-export function stringToDict(s: string): string[] {
+/** Converts the content of a text area to individual lines. */
+export function stringToLines(s: string): string[] {
return s
.split('\n')
.map((s) => s.trim())
@@ -7,6 +7,6 @@ export function stringToDict(s: string): string[] {
}
/** Converts the content of a text area to viable dictionary values. */
-export function dictToString(values: string[]): string {
+export function linesToString(values: string[]): string {
return values.map((v) => v.trim()).join('\n');
}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 5ecb7df37..b67e34897 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -227,6 +227,9 @@ importers:
lodash-es:
specifier: ^4.17.21
version: 4.17.21
+ minimatch:
+ specifier: ^10.0.3
+ version: 10.0.3
tslib:
specifier: 'catalog:'
version: 2.8.1
@@ -1990,6 +1993,14 @@ packages:
'@types/node':
optional: true
+ '@isaacs/[email protected]':
+ resolution: {integrity: sha512-yzMTt9lEb8Gv7zRioUilSglI0c0smZ9k5D65677DLWLtWJaXIS3CqcGyUFByYKlnUj6TkjLVs54fBl6+TiGQDQ==}
+ engines: {node: 20 || >=22}
+
+ '@isaacs/[email protected]':
+ resolution: {integrity: sha512-ZT55BDLV0yv0RBm2czMiZ+SqCGO7AvmOM3G/w2xhVPH+te0aKgFjmBvGlL1dH+ql2tgGO3MVrbb3jCKyvpgnxA==}
+ engines: {node: 20 || >=22}
+
'@isaacs/[email protected]':
resolution: {integrity: sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==}
engines: {node: '>=12'}
@@ -8116,6 +8127,10 @@ packages:
resolution: {integrity: sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ==}
engines: {node: 20 || >=22}
+ resolution: {integrity: sha512-IPZ167aShDZZUMdRk66cyQAW3qr0WzbHkPdMYa8bzZhlHhO3jALbKdxcaak7W9FfT2rZNpQuUu4Od7ILEpXSaw==}
+ engines: {node: 20 || >=22}
+
resolution: {integrity: sha512-6FsRAQsxQ61mw+qP1ZzbL9Bc78x2p5OqNgNpnoAFLTrX8n5Kxph0CsnhmKKNXTWjXqU5L0pGPR7hYk+XWZr60Q==}
@@ -13670,6 +13685,12 @@ snapshots:
optionalDependencies:
'@types/node': 22.13.10
+ '@isaacs/[email protected]': {}
+
+ '@isaacs/[email protected]':
+ dependencies:
+ '@isaacs/balanced-match': 4.0.1
+
'@isaacs/[email protected]':
dependencies:
string-width: 5.1.2
@@ -21779,6 +21800,10 @@ snapshots:
dependencies:
brace-expansion: 2.0.1
+ dependencies:
+ '@isaacs/brace-expansion': 5.0.0
+
dependencies:
brace-expansion: 1.1.11