Add extension menu items (#21)

* Initial plan

* Add extension menu items: Proofread Now, Ignore All, Version, Check Release

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

* Move globals.d.ts from src to types directory

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

* Wrap menu items under a parent "Proofread" menu with SF Symbol icon

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

* Move repoUrl to const.ts; remove addMenuItems wrapper, call buildMenuItem directly in main.ts

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

* nit-picking

* Remove unnecessary stale document check from proofreadNow

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

* Revert accidental lock file changes

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

* Replace sliceString(0) with toString() in menu.ts and extension.ts

Co-authored-by: cyanzhong <6745066+cyanzhong@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>

Author: Copilot

main.ts

@@ -1,4 +1,6 @@
 import { MarkEdit } from 'markedit-api';
 import { proofreadingExtension } from './src/extension';
+import { buildMenuItem } from './src/menu';
 
 MarkEdit.addExtension(proofreadingExtension());
+MarkEdit.addMainMenuItem(buildMenuItem());

src/const.ts

@@ -0,0 +1 @@
+export const repoUrl = 'https://github.com/MarkEdit-app/MarkEdit-proofreading';

src/extension.ts

@@ -39,7 +39,7 @@ const lintScheduler = ViewPlugin.fromClass(class {
 
   async runLint() {
     const doc = this.view.state.doc;
-    const text = doc.sliceString(0);
+    const text = doc.toString();
     const lints = await lint(text);
 
     if (this.view.state.doc !== doc) {

src/menu.ts

@@ -0,0 +1,42 @@
+import { MarkEdit } from 'markedit-api';
+import type { MenuItem } from 'markedit-api';
+import { setDiagnosticsEffect, lintToDiagnostic } from './decoration';
+import { lint } from './lint';
+import { repoUrl } from './const';
+
+export function buildMenuItem(): MenuItem {
+  return {
+    title: 'Proofread',
+    icon: 'text.badge.checkmark',
+    children: [
+      {
+        title: 'Proofread Now',
+        action: proofreadNow,
+      },
+      {
+        title: 'Ignore All',
+        action: ignoreAll,
+      },
+      { separator: true },
+      {
+        title: `Version ${__PKG_VERSION__}`,
+        action: () => open(`${repoUrl}/releases/tag/v${__PKG_VERSION__}`),
+      },
+      {
+        title: 'Check Release (GitHub)',
+        action: () => open(`${repoUrl}/releases`),
+      },
+    ],
+  };
+}
+
+async function proofreadNow() {
+  const view = MarkEdit.editorView;
+  const text = view.state.doc.toString();
+  const lints = await lint(text);
+  view.dispatch({ effects: setDiagnosticsEffect.of(lints.map(lintToDiagnostic)) });
+}
+
+function ignoreAll() {
+  MarkEdit.editorView.dispatch({ effects: setDiagnosticsEffect.of([]) });
+}

tests/menu.test.ts

@@ -0,0 +1,28 @@
+import { describe, expect, it } from 'vitest';
+import { buildMenuItem } from '../src/menu';
+
+describe('buildMenuItem', () => {
+  it('returns the expected menu structure', () => {
+    const item = buildMenuItem();
+
+    expect(item.title).toBe('Proofread');
+    expect(item.icon).toBe('text.badge.checkmark');
+
+    const children = item.children!;
+    expect(children).toHaveLength(5);
+
+    expect(children[0].title).toBe('Proofread Now');
+    expect(typeof children[0].action).toBe('function');
+
+    expect(children[1].title).toBe('Ignore All');
+    expect(typeof children[1].action).toBe('function');
+
+    expect(children[2].separator).toBe(true);
+
+    expect(children[3].title).toMatch(/^Version \S+/);
+    expect(typeof children[3].action).toBe('function');
+
+    expect(children[4].title).toBe('Check Release (GitHub)');
+    expect(typeof children[4].action).toBe('function');
+  });
+});

tsconfig.json

@@ -9,6 +9,8 @@
     "strictNullChecks": true,
     "importHelpers": true,
     "noEmit": true,
-    "skipLibCheck": true
+    "skipLibCheck": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true
   }
 }

types/globals.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Package version read from the `package.json` file.
+ */
+declare const __PKG_VERSION__: string;

vite.config.mts

@@ -1,7 +1,11 @@
 import { defineConfig, mergeConfig } from 'vite';
 import { viteSingleFile } from 'vite-plugin-singlefile';
 import { defaultViteConfig } from 'markedit-vite';
+import mainPackage from './package.json' with { type: 'json' };
 
 export default defineConfig(mergeConfig(defaultViteConfig(), {
+  define: {
+    __PKG_VERSION__: JSON.stringify(mainPackage.version),
+  },
   plugins: [viteSingleFile()],
 }));