Add to Dictionary (#23)

* Initial plan

* Add "Add to Dictionary" feature with persistent word storage

- Create src/dictionary.ts for persisting dictionary words via MarkEdit file API
- Add addToDictionary() export in src/lint.ts using Harper's importWords/exportWords
- Load persisted dictionary words at linter startup
- Add problemText field to Diagnostic interface in src/decoration.ts
- Add "Add to Dictionary" button in tooltip UI (src/tooltip.ts)
- Add tests for dictionary parsing (tests/dictionary.test.ts)
- Update decoration tests for new problemText field
- Document feature in README.md

Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com>

* Address code review: simplify problemText checks in tooltip

Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com>

* Address review: rename dict, use documents dir, integrate into Ignore with addToDict setting

- Rename dictionary.ts → dict.ts, dictionary file → proofreading-dict.txt
- Use documents directory instead of library for discoverability
- Remove separate "Add to Dictionary" button from tooltip
- Integrate dictionary into "Ignore" button, controlled by addToDict setting (default true)
- Add addToDict to ProofreadingSettings with tests
- Update README to document addToDict setting

Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com>

* Fix cross-editor safety: read dict from disk instead of Harper memory

When adding a word, read the current file from disk (not exportWords())
to preserve words added by other editor instances. Only appends the
new word if not already present, and skips the save entirely for
duplicates.

Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com>

* Move addToDict to 2nd position in README settings docs

Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com>

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: cyanzhong <6745066+cyanzhong@users.noreply.github.com>
Co-authored-by: Ying Zhong <0x00eeee@gmail.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: 3 people

README.md

@@ -16,6 +16,7 @@ You can customize behavior from `settings.json` with the `extension.markeditProo
 {
   "extension.markeditProofreading": {
     "autoLintDelay": 1000,
+    "addToDict": true,
     "lintPreset": "relaxed",
     "lintRuleOverrides": {
       "SpelledNumbers": false,
@@ -27,6 +28,7 @@ You can customize behavior from `settings.json` with the `extension.markeditProo
 ```
 
 - `autoLintDelay`: Delay in milliseconds before automatic proofreading runs after a document change (default: `1000`). Set to `-1` to disable automatic proofreading entirely (use "Proofread Now" to lint on demand)
+- `addToDict`: When `true` (default), clicking "Ignore" on a flagged word also adds it to a personal dictionary so it won't be flagged in future sessions. Set to `false` to disable this behavior
 - `lintPreset`: `"strict"`, `"standard"` (default), or `"relaxed"`
 - `lintRuleOverrides`: Per-rule overrides (`true` / `false` / `null`) applied on top of the preset
 - `disabledLintKinds`: Additional lint kinds to filter out, available kinds:
@@ -37,3 +39,7 @@ You can customize behavior from `settings.json` with the `extension.markeditProo
 
 For a full list of available rule names, see:
 https://writewithharper.com/docs/rules
+
+## Dictionary
+
+When `addToDict` is enabled (default), clicking "Ignore" on a flagged word also adds it to a personal dictionary persisted in `proofreading-dict.txt` under the MarkEdit documents directory. Dictionary words are automatically loaded when the extension starts.

src/decoration.ts

@@ -10,6 +10,7 @@ export interface Diagnostic {
   lintKind: string;
   title: string;
   messageHtml: string;
+  problemText: string;
   actions: DiagnosticAction[];
 }
 
@@ -59,6 +60,7 @@ export function lintToDiagnostic(l: Lint): Diagnostic {
     lintKind: l.lint_kind(),
     title: l.lint_kind_pretty(),
     messageHtml: l.message_html(),
+    problemText: l.get_problem_text(),
     actions: l.suggestions().map(suggestionToAction),
   };
 }

src/dict.ts

@@ -0,0 +1,28 @@
+import { MarkEdit } from 'markedit-api';
+
+const dictionaryFileName = 'proofreading-dict.txt';
+
+function dictionaryPath(): string {
+  return `${MarkEdit.getDirectoryPath('documents')}/${dictionaryFileName}`;
+}
+
+export async function loadWords(): Promise<string[]> {
+  const content = await MarkEdit.getFileContent(dictionaryPath());
+  if (!content) {
+    return [];
+  }
+
+  return parseWords(content);
+}
+
+export async function saveWords(words: string[]): Promise<void> {
+  await MarkEdit.createFile({
+    path: dictionaryPath(),
+    string: words.join('\n'),
+    overwrites: true,
+  });
+}
+
+export function parseWords(content: string): string[] {
+  return content.split('\n').map(w => w.trim()).filter(w => w.length > 0);
+}

src/lint.ts

@@ -3,6 +3,7 @@ import { MarkEdit } from 'markedit-api';
 import { getProofreadingSettings } from './settings';
 import { presetDisabledRules } from './rules';
 import { presetDisabledKinds } from './kinds';
+import { loadWords, saveWords } from './dict';
 
 const linter = new LocalLinter({ binary: binaryInlined });
 const settings = getProofreadingSettings(MarkEdit.userSettings);
@@ -11,6 +12,8 @@ const linterReady = configureLinter().catch(error => {
   console.warn('[MarkEdit-proofreading] Failed to configure linter.', error);
 });
 
+export const shouldAddToDict = settings.addToDict;
+
 export async function lint(text: string) {
   await linterReady;
   const lints = await linter.lint(text);
@@ -23,6 +26,18 @@ export async function lint(text: string) {
   return lints.filter(lint => !disabledKinds.has(lint.lint_kind()));
 }
 
+export async function addToDictionary(word: string): Promise<void> {
+  await linterReady;
+  await linter.importWords([word]);
+
+  // Read from disk (not Harper memory) to preserve words added by other editors
+  const existing = await loadWords();
+  if (!existing.includes(word)) {
+    existing.push(word);
+    await saveWords(existing);
+  }
+}
+
 function resolveDisabledKinds(): ReadonlySet<string> {
   const fromPreset = presetDisabledKinds(settings.lintPreset);
   if (settings.disabledLintKinds.length === 0) {
@@ -34,23 +49,30 @@ function resolveDisabledKinds(): ReadonlySet<string> {
 
 async function configureLinter() {
   const disabledRules = presetDisabledRules(settings.lintPreset);
+  const hasRuleConfig =
+    disabledRules.length > 0 ||
+    Object.keys(settings.lintRuleOverrides).length > 0;
 
-  if (disabledRules.length === 0 && Object.keys(settings.lintRuleOverrides).length === 0) {
-    return;
-  }
+  if (hasRuleConfig) {
+    const config: LintConfig = await linter.getDefaultLintConfig();
 
-  const config: LintConfig = await linter.getDefaultLintConfig();
+    for (const rule of disabledRules) {
+      if (rule in config) {
+        config[rule] = false;
+      }
+    }
 
-  for (const rule of disabledRules) {
-    if (rule in config) {
-      config[rule] = false;
+    // Apply user rule overrides on top
+    for (const [name, val] of Object.entries(settings.lintRuleOverrides)) {
+      config[name] = val;
     }
-  }
 
-  // Apply user rule overrides on top
-  for (const [name, val] of Object.entries(settings.lintRuleOverrides)) {
-    config[name] = val;
+    await linter.setLintConfig(config);
   }
 
-  await linter.setLintConfig(config);
+  // Load persisted dictionary words (always, even if no rules to configure)
+  const words = await loadWords();
+  if (words.length > 0) {
+    await linter.importWords(words);
+  }
 }

src/settings.ts

@@ -13,6 +13,7 @@ export interface ProofreadingSettings {
   lintPreset: LintPreset;
   lintRuleOverrides: LintConfig;
   disabledLintKinds: string[];
+  addToDict: boolean;
 }
 
 export function getProofreadingSettings(userSettings: JSONObject | undefined): ProofreadingSettings {
@@ -21,6 +22,7 @@ export function getProofreadingSettings(userSettings: JSONObject | undefined): P
     lintPreset: 'standard',
     lintRuleOverrides: {},
     disabledLintKinds: [],
+    addToDict: true,
   };
 
   const root = asObject(userSettings);
@@ -37,8 +39,9 @@ export function getProofreadingSettings(userSettings: JSONObject | undefined): P
   ) as LintConfig;
 
   const disabledLintKinds = parseStringArray(raw.disabledLintKinds);
+  const addToDict = raw.addToDict === false ? false : true;
 
-  return { autoLintDelay, lintPreset, lintRuleOverrides, disabledLintKinds };
+  return { autoLintDelay, lintPreset, lintRuleOverrides, disabledLintKinds, addToDict };
 }
 
 function parseLintPreset(value: JSONValue): LintPreset {

src/tooltip.ts

@@ -2,6 +2,7 @@ import { StateField, StateEffect } from '@codemirror/state';
 import { showTooltip, EditorView } from '@codemirror/view';
 import type { Tooltip, TooltipView } from '@codemirror/view';
 import { diagnosticsField, setDiagnosticsEffect } from './decoration';
+import { addToDictionary, shouldAddToDict } from './lint';
 import type { Diagnostic } from './decoration';
 
 const setClickTooltip = StateEffect.define<Diagnostic | null>();
@@ -265,6 +266,9 @@ function createTooltip(view: EditorView, diagnostic: Diagnostic) {
   ignore.textContent = 'Ignore';
   ignore.onmousedown = (e) => e.preventDefault();
   ignore.onclick = () => {
+    if (shouldAddToDict && diagnostic.problemText) {
+      void addToDictionary(diagnostic.problemText);
+    }
     const { diagnostics } = view.state.field(diagnosticsField);
     const filtered = diagnostics.filter(d =>
       !(d.from === diagnostic.from && d.to === diagnostic.to && d.lintKind === diagnostic.lintKind),

tests/decoration.test.ts

@@ -17,6 +17,7 @@ describe('lintToDiagnostic', () => {
       lint_kind: () => 'Style',
       lint_kind_pretty: () => 'Style',
       message_html: () => '<p>Use another word</p>',
+      get_problem_text: () => 'word',
       suggestions: () => [
         makeSuggestion(SuggestionKind.Remove, ''),
         makeSuggestion(SuggestionKind.InsertAfter, 'ed'),
@@ -32,6 +33,7 @@ describe('lintToDiagnostic', () => {
       lintKind: 'Style',
       title: 'Style',
       messageHtml: '<p>Use another word</p>',
+      problemText: 'word',
     });
 
     expect(diagnostic.actions.map(a => a.name)).toEqual(['Remove', 'Insert "ed"', 'fixed']);
@@ -43,6 +45,7 @@ describe('lintToDiagnostic', () => {
       lint_kind: () => 'Typo',
       lint_kind_pretty: () => 'Typo',
       message_html: () => '<p>Typo</p>',
+      get_problem_text: () => 'typo',
       suggestions: () => [
         makeSuggestion(SuggestionKind.Remove, ''),
         makeSuggestion(SuggestionKind.Replace, 'word'),

tests/dict.test.ts

@@ -0,0 +1,24 @@
+import { describe, expect, it } from 'vitest';
+import { parseWords } from '../src/dict';
+
+describe('parseWords', () => {
+  it('splits content into trimmed non-empty words', () => {
+    expect(parseWords('hello\nworld\n')).toEqual(['hello', 'world']);
+  });
+
+  it('trims whitespace from each line', () => {
+    expect(parseWords('  foo  \n  bar  ')).toEqual(['foo', 'bar']);
+  });
+
+  it('filters out blank lines', () => {
+    expect(parseWords('one\n\n\ntwo\n\nthree')).toEqual(['one', 'two', 'three']);
+  });
+
+  it('returns empty array for empty content', () => {
+    expect(parseWords('')).toEqual([]);
+  });
+
+  it('handles single word without newline', () => {
+    expect(parseWords('hello')).toEqual(['hello']);
+  });
+});

tests/settings.test.ts

@@ -11,6 +11,7 @@ describe('proofreading settings', () => {
     expect(settings.lintPreset).toBe('standard');
     expect(settings.lintRuleOverrides).toEqual({});
     expect(settings.disabledLintKinds).toEqual([]);
+    expect(settings.addToDict).toBe(true);
   });
 
   it('parses lint preset, per-rule overrides from user settings', () => {
@@ -119,4 +120,20 @@ describe('proofreading settings', () => {
       'extension.markeditProofreading': { autoLintDelay: 'fast' },
     }).autoLintDelay).toBe(1000);
   });
+
+  it('defaults addToDict to true and allows disabling', () => {
+    expect(getProofreadingSettings(undefined).addToDict).toBe(true);
+
+    expect(getProofreadingSettings({
+      'extension.markeditProofreading': { addToDict: false },
+    }).addToDict).toBe(false);
+
+    expect(getProofreadingSettings({
+      'extension.markeditProofreading': { addToDict: true },
+    }).addToDict).toBe(true);
+
+    expect(getProofreadingSettings({
+      'extension.markeditProofreading': { addToDict: 'yes' },
+    }).addToDict).toBe(true);
+  });
 });