Use a clear Append/Create dichotomy on the issue enhancement.

Author: nedtwigg

src/lib/enhancers/github/GitHubIssueEnhancer.tsx renamed to src/lib/enhancers/github/GitHubIssueAppendEnhancer.tsx

@@ -6,22 +6,25 @@ import { logger } from '@/lib/logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGithubOptions, prepareGitHubHighlighter } from './github-common'
 
-const GH_ISSUE = 'GH_ISSUE' as const
+const GH_ISSUE_APPEND = 'GH_ISSUE_APPEND' as const
 
-export interface GitHubIssueSpot extends CommentSpot {
-  type: typeof GH_ISSUE
+export interface GitHubIssueAppendSpot extends CommentSpot {
+  type: typeof GH_ISSUE_APPEND
   title: string
   domain: string
   slug: string // owner/repo
   number: number // issue number, undefined for new issues
 }
 
-export class GitHubIssueEnhancer implements CommentEnhancer<GitHubIssueSpot> {
+export class GitHubIssueAppendEnhancer implements CommentEnhancer<GitHubIssueAppendSpot> {
   forSpotTypes(): string[] {
-    return [GH_ISSUE]
+    return [GH_ISSUE_APPEND]
   }
 
-  tryToEnhance(textarea: HTMLTextAreaElement, location: StrippedLocation): GitHubIssueSpot | null {
+  tryToEnhance(
+    textarea: HTMLTextAreaElement,
+    location: StrippedLocation,
+  ): GitHubIssueAppendSpot | null {
     if (textarea.id === 'feedback') {
       return null
     }
@@ -55,12 +58,12 @@ export class GitHubIssueEnhancer implements CommentEnhancer<GitHubIssueSpot> {
       number,
       slug,
       title,
-      type: GH_ISSUE,
+      type: GH_ISSUE_APPEND,
       unique_key,
     }
   }
 
-  enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueSpot): OverTypeInstance {
+  enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueAppendSpot): OverTypeInstance {
     prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     return new OverType(overtypeContainer, {
@@ -70,7 +73,7 @@ export class GitHubIssueEnhancer implements CommentEnhancer<GitHubIssueSpot> {
     })[0]!
   }
 
-  tableUpperDecoration(spot: GitHubIssueSpot): React.ReactNode {
+  tableUpperDecoration(spot: GitHubIssueAppendSpot): React.ReactNode {
     return (
       <>
         <span className='flex h-4 w-4 flex-shrink-0 items-center justify-center'>
@@ -84,7 +87,7 @@ export class GitHubIssueEnhancer implements CommentEnhancer<GitHubIssueSpot> {
     )
   }
 
-  tableTitle(spot: GitHubIssueSpot): string {
+  tableTitle(spot: GitHubIssueAppendSpot): string {
     return spot.title
   }
 }

src/lib/enhancers/github/GitHubIssueNewEnhancer.tsx renamed to src/lib/enhancers/github/GitHubIssueCreateEnhancer.tsx

@@ -4,24 +4,24 @@ import { logger } from '../../logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGithubOptions, prepareGitHubHighlighter } from './github-common'
 
-const GH_ISSUE_NEW = 'GH_ISSUE_NEW' as const
+const GH_ISSUE_CREATE = 'GH_ISSUE_CREATE' as const
 
-interface GitHubIssueNewSpot extends CommentSpot {
-  type: typeof GH_ISSUE_NEW
+interface GitHubIssueCreateSpot extends CommentSpot {
+  type: typeof GH_ISSUE_CREATE
   domain: string
   slug: string // owner/repo
   title: string
 }
 
-export class GitHubIssueNewEnhancer implements CommentEnhancer<GitHubIssueNewSpot> {
+export class GitHubIssueCreateEnhancer implements CommentEnhancer<GitHubIssueCreateSpot> {
   forSpotTypes(): string[] {
-    return [GH_ISSUE_NEW]
+    return [GH_ISSUE_CREATE]
   }
 
   tryToEnhance(
     textarea: HTMLTextAreaElement,
     location: StrippedLocation,
-  ): GitHubIssueNewSpot | null {
+  ): GitHubIssueCreateSpot | null {
     if (textarea.id === 'feedback') {
       return null
     }
@@ -45,12 +45,12 @@ export class GitHubIssueNewEnhancer implements CommentEnhancer<GitHubIssueNewSpo
       domain: location.host,
       slug,
       title,
-      type: GH_ISSUE_NEW,
+      type: GH_ISSUE_CREATE,
       unique_key,
     }
   }
 
-  enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueNewSpot): OverTypeInstance {
+  enhance(textArea: HTMLTextAreaElement, _spot: GitHubIssueCreateSpot): OverTypeInstance {
     prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     return new OverType(overtypeContainer, {
@@ -60,7 +60,7 @@ export class GitHubIssueNewEnhancer implements CommentEnhancer<GitHubIssueNewSpo
     })[0]!
   }
 
-  tableUpperDecoration(spot: GitHubIssueNewSpot): React.ReactNode {
+  tableUpperDecoration(spot: GitHubIssueCreateSpot): React.ReactNode {
     const { slug } = spot
     return (
       <>
@@ -70,11 +70,11 @@ export class GitHubIssueNewEnhancer implements CommentEnhancer<GitHubIssueNewSpo
     )
   }
 
-  tableTitle(spot: GitHubIssueNewSpot): string {
+  tableTitle(spot: GitHubIssueCreateSpot): string {
     return spot.title || 'New Issue'
   }
 
-  buildUrl(spot: GitHubIssueNewSpot): string {
+  buildUrl(spot: GitHubIssueCreateSpot): string {
     return `https://${spot.domain}/${spot.slug}/issue/new`
   }
 }

src/lib/registries.ts

@@ -3,8 +3,8 @@ import OverType from 'overtype'
 import type { CommentEnhancer, CommentSpot, StrippedLocation } from './enhancer'
 import { CommentEnhancerMissing } from './enhancers/CommentEnhancerMissing'
 import { GitHubEditEnhancer } from './enhancers/github/GitHubEditEnhancer'
-import { GitHubIssueEnhancer } from './enhancers/github/GitHubIssueEnhancer'
-import { GitHubIssueNewEnhancer } from './enhancers/github/GitHubIssueNewEnhancer'
+import { GitHubIssueAppendEnhancer } from './enhancers/github/GitHubIssueAppendEnhancer'
+import { GitHubIssueCreateEnhancer } from './enhancers/github/GitHubIssueCreateEnhancer'
 import { GitHubPrEnhancer } from './enhancers/github/GitHubPrEnhancer'
 import { GitHubPRNewEnhancer } from './enhancers/github/GitHubPrNewEnhancer'
 
@@ -22,8 +22,8 @@ export class EnhancerRegistry {
   constructor() {
     // Register all available handlers
     this.register(new GitHubEditEnhancer())
-    this.register(new GitHubIssueEnhancer())
-    this.register(new GitHubIssueNewEnhancer())
+    this.register(new GitHubIssueAppendEnhancer())
+    this.register(new GitHubIssueCreateEnhancer())
     this.register(new GitHubPrEnhancer())
     this.register(new GitHubPRNewEnhancer())
     const textColor = 'rgb(31, 35, 40)'

tests/lib/enhancers/__snapshots__/gh-detection.test.ts.snap

@@ -9,7 +9,7 @@ exports[`github detection > gh_issue:should detect correct spots 1`] = `
       "number": 523,
       "slug": "diffplug/selfie",
       "title": "[jvm] docs for VCR",
-      "type": "GH_ISSUE",
+      "type": "GH_ISSUE_APPEND",
       "unique_key": "github.com:diffplug/selfie:523",
     },
   },
@@ -32,7 +32,7 @@ exports[`github detection > gh_issue_edit:should detect correct spots 1`] = `
       "number": 56,
       "slug": "diffplug/gitcasso",
       "title": "what about the draft?",
-      "type": "GH_ISSUE",
+      "type": "GH_ISSUE_APPEND",
       "unique_key": "github.com:diffplug/gitcasso:56",
     },
   },
@@ -47,7 +47,7 @@ exports[`github detection > gh_issue_new:should detect correct spots 1`] = `
       "domain": "github.com",
       "slug": "diffplug/gitcasso",
       "title": "New issue title",
-      "type": "GH_ISSUE_NEW",
+      "type": "GH_ISSUE_CREATE",
       "unique_key": "github.com:diffplug/gitcasso:new",
     },
   },

tests/playground/replica.tsx

@@ -1,7 +1,7 @@
 import { PopupRoot } from '@/components/PopupRoot'
 import type { CommentStorage, CommentTableRow } from '@/entrypoints/background'
 import type { CommentSpot } from '@/lib/enhancer'
-import type { GitHubIssueSpot } from '@/lib/enhancers/github/GitHubIssueEnhancer'
+import type { GitHubIssueAppendSpot } from '@/lib/enhancers/github/GitHubIssueAppendEnhancer'
 import type { GitHubPrSpot } from '@/lib/enhancers/github/GitHubPrEnhancer'
 
 const gh_pr: GitHubPrSpot = {
@@ -12,12 +12,12 @@ const gh_pr: GitHubPrSpot = {
   type: 'GH_PR',
   unique_key: 'github.com:diffplug/selfie:517',
 }
-const gh_issue: GitHubIssueSpot = {
+const gh_issue: GitHubIssueAppendSpot = {
   domain: 'github.com',
   number: 523,
   slug: 'diffplug/selfie',
   title: 'whoa',
-  type: 'GH_ISSUE',
+  type: 'GH_ISSUE_APPEND',
   unique_key: 'github.com:diffplug/selfie:523',
 }
 

tests/playground/replicaData.tsx

@@ -1,6 +1,6 @@
 import type { CommentTableRow } from '@/entrypoints/background'
 import type { CommentSpot } from '@/lib/enhancer'
-import type { GitHubIssueSpot } from '@/lib/enhancers/github/GitHubIssueEnhancer'
+import type { GitHubIssueAppendSpot } from '@/lib/enhancers/github/GitHubIssueAppendEnhancer'
 import type { GitHubPrSpot } from '@/lib/enhancers/github/GitHubPrEnhancer'
 
 export interface RedditSpot extends CommentSpot {
@@ -93,9 +93,9 @@ export const generateMockDrafts = (): CommentTableRow[] => [
       number: 5678,
       slug: 'facebook/react',
       title: 'Unexpected behavior with useEffect cleanup',
-      type: 'GH_ISSUE',
+      type: 'GH_ISSUE_APPEND',
       unique_key: '3',
-    } satisfies GitHubIssueSpot),
+    } satisfies GitHubIssueAppendSpot),
   },
   {
     isOpenTab: false,