Skip to content

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

fix(obsidian): store user dictionary in sorted order (#2106)

Elijah Potterefde39eb7928
diff --git a/packages/obsidian-plugin/src/State.test.ts b/packages/obsidian-plugin/src/State.test.ts
index 7f032ee37..b440deede 100644
--- a/packages/obsidian-plugin/src/State.test.ts
+++ b/packages/obsidian-plugin/src/State.test.ts
@@ -2,6 +2,15 @@ import { shuffle } from 'lodash-es';
import { expect, test } from 'vitest';
import State from './State';
+function randomString(length: number): string {
+ const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
+ let result = '';
+ for (let i = 0; i < length; i++) {
+ result += chars.charAt(Math.floor(Math.random() * chars.length));
+ }
+ return result;
+}
+
/** Create an instance of the test class that doesn't use external persistence. */
function createEphemeralState(): State {
return new State(
@@ -172,6 +181,29 @@ test('can persist dictionary words in settings', async () => {
expect(settings.userDictionary).toStrictEqual([testWord]);
});
+test('can persist dictionary order in settings', async () => {
+ const state = createEphemeralState();
+ let settings = await state.getSettings();
+
+ const testDictionary: string[] = [];
+ for (let i = 0; i < 200; i++) {
+ testDictionary.push(randomString(10));
+ }
+
+ settings.userDictionary = testDictionary;
+ await state.initializeFromSettings(settings);
+
+ settings = await state.getSettings();
+
+ const roundOne = settings.userDictionary;
+
+ await state.initializeFromSettings(settings);
+ settings = await state.getSettings();
+ const roundTwo = settings.userDictionary;
+
+ expect(roundOne).toStrictEqual(roundTwo);
+});
+
test('can overwrite dictionary words in settings', async () => {
const state = createEphemeralState();
let settings = await state.getSettings();
diff --git a/packages/obsidian-plugin/src/State.ts b/packages/obsidian-plugin/src/State.ts
index 9849b2192..647ced49d 100644
--- a/packages/obsidian-plugin/src/State.ts
+++ b/packages/obsidian-plugin/src/State.ts
@@ -217,11 +217,14 @@ export default class State {
public async getSettings(): Promise<Settings> {
const usingWebWorker = this.harper instanceof WorkerLinter;
+ const userDictionary = await this.harper.exportWords();
+ userDictionary.sort();
+
return {
ignoredLints: await this.harper.exportIgnoredLints(),
useWebWorker: usingWebWorker,
lintSettings: await this.harper.getLintConfig(),
- userDictionary: await this.harper.exportWords(),
+ userDictionary,
dialect: await this.harper.getDialect(),
delay: this.delay,
ignoredGlobs: this.ignoredGlobs,