give enhancers a way to return an optional cleanup function

nedtwigg · nedtwigg · commit 9e46e004ce58 · 2025-09-26T09:10:28.000-07:00
diff --git a/src/lib/enhancer.ts b/src/lib/enhancer.ts
@@ -40,9 +40,15 @@ export interface CommentEnhancer<Spot extends CommentSpot = CommentSpot> {
   /**
    * If `tryToEnhance` returns non-null, then this gets called.
    */
-  enhance(textarea: HTMLTextAreaElement, spot: Spot): OverTypeInstance
+  enhance(textarea: HTMLTextAreaElement, spot: Spot): OvertypeWithCleanup
   /** Returns a ReactNode which will be displayed in the table row. */
   tableUpperDecoration(spot: Spot): ReactNode
   /** The default title of a row */
   tableTitle(spot: Spot): string
 }
+
+/** Allows enhancers to attach an optional cleanup field to the return value of `enhance()`. */
+export interface OvertypeWithCleanup {
+  instance: OverTypeInstance
+  cleanup?: () => void
+}
diff --git a/src/lib/enhancers/CommentEnhancerMissing.tsx b/src/lib/enhancers/CommentEnhancerMissing.tsx
@@ -1,6 +1,10 @@
-import type { OverTypeInstance } from 'overtype'
 import type { ReactNode } from 'react'
-import type { CommentEnhancer, CommentSpot, StrippedLocation } from '../enhancer'
+import type {
+  CommentEnhancer,
+  CommentSpot,
+  OvertypeWithCleanup,
+  StrippedLocation,
+} from '../enhancer'
 
 /** Used when an entry is in the table which we don't recognize. */
 export class CommentEnhancerMissing implements CommentEnhancer {
@@ -43,7 +47,7 @@ export class CommentEnhancerMissing implements CommentEnhancer {
   tryToEnhance(_textarea: HTMLTextAreaElement, _location: StrippedLocation): CommentSpot | null {
     throw new Error('Method not implemented.')
   }
-  enhance(_textarea: HTMLTextAreaElement, _spot: CommentSpot): OverTypeInstance {
+  enhance(_textarea: HTMLTextAreaElement, _spot: CommentSpot): OvertypeWithCleanup {
     throw new Error('Method not implemented.')
   }
 }
diff --git a/src/lib/enhancers/github/GitHubEditEnhancer.tsx b/src/lib/enhancers/github/GitHubEditEnhancer.tsx
@@ -1,6 +1,11 @@
-import OverType, { type OverTypeInstance } from 'overtype'
+import OverType from 'overtype'
 import type React from 'react'
-import type { CommentEnhancer, CommentSpot, StrippedLocation } from '@/lib/enhancer'
+import type {
+  CommentEnhancer,
+  CommentSpot,
+  OvertypeWithCleanup,
+  StrippedLocation,
+} from '@/lib/enhancer'
 import { logger } from '@/lib/logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGitHubOptions, prepareGitHubHighlighter } from './github-common'
@@ -50,7 +55,7 @@ export class GitHubEditEnhancer implements CommentEnhancer<GitHubEditSpot> {
     }
   }
 
-  enhance(textArea: HTMLTextAreaElement, spot: GitHubEditSpot): OverTypeInstance {
+  enhance(textArea: HTMLTextAreaElement, spot: GitHubEditSpot): OvertypeWithCleanup {
     prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     const overtype = new OverType(overtypeContainer, {
@@ -60,7 +65,7 @@ export class GitHubEditEnhancer implements CommentEnhancer<GitHubEditSpot> {
     if (!spot.isIssue) {
       // TODO: autoheight not working
     }
-    return overtype
+    return { instance: overtype }
   }
 
   tableUpperDecoration(_spot: GitHubEditSpot): React.ReactNode {
diff --git a/src/lib/enhancers/github/GitHubIssueAppendEnhancer.tsx b/src/lib/enhancers/github/GitHubIssueAppendEnhancer.tsx
@@ -1,7 +1,12 @@
 import { IssueOpenedIcon } from '@primer/octicons-react'
 import OverType, { type OverTypeInstance } from 'overtype'
 import type React from 'react'
-import type { CommentEnhancer, CommentSpot, StrippedLocation } from '@/lib/enhancer'
+import type {
+  CommentEnhancer,
+  CommentSpot,
+  OvertypeWithCleanup,
+  StrippedLocation,
+} from '@/lib/enhancer'
 import { logger } from '@/lib/logger'
 import { oncePerRefresh } from '@/lib/once-per-refresh'
 import { modifyDOM } from '../modifyDOM'
@@ -66,12 +71,12 @@ export class GitHubIssueAppendEnhancer implements CommentEnhancer<GitHubIssueApp
 
   instance: OverTypeInstance | undefined
 
-  enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueAppendSpot): OverTypeInstance {
+  enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueAppendSpot): OvertypeWithCleanup {
     prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     if (this.instance) {
       OverType.instances.delete(overtypeContainer)
-        ; (overtypeContainer as any).overTypeInstance = undefined
+      ;(overtypeContainer as any).overTypeInstance = undefined
     }
     this.registerSubmitHandler(textArea, _spot)
     const thing = new OverType(overtypeContainer, {
@@ -80,7 +85,7 @@ export class GitHubIssueAppendEnhancer implements CommentEnhancer<GitHubIssueApp
       placeholder: 'Use Markdown to format your comment',
     })[0]!
     this.instance = thing
-    return thing
+    return { instance: thing }
   }
 
   private registerSubmitHandler(textArea: HTMLTextAreaElement, _spot: GitHubIssueAppendSpot) {
@@ -90,7 +95,10 @@ export class GitHubIssueAppendEnhancer implements CommentEnhancer<GitHubIssueApp
         if (target) {
           const btn = (e.target as HTMLElement).closest('button')
           if (btn) {
-            if (btn.textContent.trim() === 'Comment' || btn.matches('button[data-variant="primary"]')) {
+            if (
+              btn.textContent.trim() === 'Comment' ||
+              btn.matches('button[data-variant="primary"]')
+            ) {
               this.enhance(textArea, _spot)
               return true
             }
diff --git a/src/lib/enhancers/github/GitHubIssueCreateEnhancer.tsx b/src/lib/enhancers/github/GitHubIssueCreateEnhancer.tsx
@@ -1,5 +1,10 @@
-import OverType, { type OverTypeInstance } from 'overtype'
-import type { CommentEnhancer, CommentSpot, StrippedLocation } from '../../enhancer'
+import OverType from 'overtype'
+import type {
+  CommentEnhancer,
+  CommentSpot,
+  OvertypeWithCleanup,
+  StrippedLocation,
+} from '../../enhancer'
 import { logger } from '../../logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGitHubOptions, prepareGitHubHighlighter } from './github-common'
@@ -50,14 +55,16 @@ export class GitHubIssueCreateEnhancer implements CommentEnhancer<GitHubIssueCre
     }
   }
 
-  enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueCreateSpot): OverTypeInstance {
+  enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueCreateSpot): OvertypeWithCleanup {
     prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
-    return new OverType(overtypeContainer, {
-      ...commonGitHubOptions,
-      minHeight: '400px',
-      placeholder: 'Type your description here...',
-    })[0]!
+    return {
+      instance: new OverType(overtypeContainer, {
+        ...commonGitHubOptions,
+        minHeight: '400px',
+        placeholder: 'Type your description here...',
+      })[0]!,
+    }
   }
 
   tableUpperDecoration(spot: GitHubIssueCreateSpot): React.ReactNode {
diff --git a/src/lib/enhancers/github/GitHubPrAppendEnhancer.tsx b/src/lib/enhancers/github/GitHubPrAppendEnhancer.tsx
@@ -1,6 +1,11 @@
-import OverType, { type OverTypeInstance } from 'overtype'
+import OverType from 'overtype'
 import type React from 'react'
-import type { CommentEnhancer, CommentSpot, StrippedLocation } from '@/lib/enhancer'
+import type {
+  CommentEnhancer,
+  CommentSpot,
+  OvertypeWithCleanup,
+  StrippedLocation,
+} from '@/lib/enhancer'
 import { logger } from '@/lib/logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGitHubOptions, prepareGitHubHighlighter } from './github-common'
@@ -53,15 +58,17 @@ export class GitHubPrAppendEnhancer implements CommentEnhancer<GitHubPrAppendSpo
     }
   }
 
-  enhance(textArea: HTMLTextAreaElement, _spot: GitHubPrAppendSpot): OverTypeInstance {
+  enhance(textArea: HTMLTextAreaElement, _spot: GitHubPrAppendSpot): OvertypeWithCleanup {
     prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
-    return new OverType(overtypeContainer, {
-      ...commonGitHubOptions,
-      minHeight: '102px',
-      padding: 'var(--base-size-8)',
-      placeholder: 'Add your comment here...',
-    })[0]!
+    return {
+      instance: new OverType(overtypeContainer, {
+        ...commonGitHubOptions,
+        minHeight: '102px',
+        padding: 'var(--base-size-8)',
+        placeholder: 'Add your comment here...',
+      })[0]!,
+    }
   }
 
   tableUpperDecoration(spot: GitHubPrAppendSpot): React.ReactNode {
diff --git a/src/lib/enhancers/github/GitHubPrCreateEnhancer.tsx b/src/lib/enhancers/github/GitHubPrCreateEnhancer.tsx
@@ -1,5 +1,10 @@
-import OverType, { type OverTypeInstance } from 'overtype'
-import type { CommentEnhancer, CommentSpot, StrippedLocation } from '../../enhancer'
+import OverType from 'overtype'
+import type {
+  CommentEnhancer,
+  CommentSpot,
+  OvertypeWithCleanup,
+  StrippedLocation,
+} from '../../enhancer'
 import { logger } from '../../logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGitHubOptions, prepareGitHubHighlighter } from './github-common'
@@ -60,14 +65,16 @@ export class GitHubPrCreateEnhancer implements CommentEnhancer<GitHubPrCreateSpo
     }
   }
 
-  enhance(textArea: HTMLTextAreaElement, _spot: GitHubPrCreateSpot): OverTypeInstance {
+  enhance(textArea: HTMLTextAreaElement, _spot: GitHubPrCreateSpot): OvertypeWithCleanup {
     prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
-    return new OverType(overtypeContainer, {
-      ...commonGitHubOptions,
-      minHeight: '250px',
-      placeholder: 'Type your description here...',
-    })[0]!
+    return {
+      instance: new OverType(overtypeContainer, {
+        ...commonGitHubOptions,
+        minHeight: '250px',
+        placeholder: 'Type your description here...',
+      })[0]!,
+    }
   }
 
   tableUpperDecoration(spot: GitHubPrCreateSpot): React.ReactNode {
diff --git a/src/lib/registries.ts b/src/lib/registries.ts
@@ -19,6 +19,7 @@ export interface EnhancedTextarea<T extends CommentSpot = CommentSpot> {
   spot: T
   enhancer: CommentEnhancer<T>
   overtype: OverTypeInstance
+  cleanup?: () => void
 }
 
 export class EnhancerRegistry {
@@ -71,9 +72,9 @@ export class EnhancerRegistry {
       try {
         const spot = enhancer.tryToEnhance(textarea, location)
         if (spot) {
-          const overtype = enhancer.enhance(textarea, spot)
+          const { instance: overtype, cleanup } = enhancer.enhance(textarea, spot)
           this.handleDelayedValueInjection(overtype)
-          return { enhancer, overtype, spot, textarea }
+          return { enhancer, overtype, spot, textarea, ...(cleanup && { cleanup }) }
         }
       } catch (error) {
         console.warn('Handler failed to identify textarea:', error)
