Same Append/Create but for prs.

Author: nedtwigg

src/lib/enhancers/github/GitHubPrEnhancer.tsx renamed to src/lib/enhancers/github/GitHubPrAppendEnhancer.tsx

@@ -5,22 +5,25 @@ import { logger } from '@/lib/logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGithubOptions, prepareGitHubHighlighter } from './github-common'
 
-const GH_PR = 'GH_PR' as const
+const GH_PR_APPEND = 'GH_PR_APPEND' as const
 
-export interface GitHubPrSpot extends CommentSpot {
-  type: typeof GH_PR
+export interface GitHubPrAppendSpot extends CommentSpot {
+  type: typeof GH_PR_APPEND
   title: string
   domain: string
   slug: string // owner/repo
   number: number // issue/PR number, undefined for new issues and PRs
 }
 
-export class GitHubPrEnhancer implements CommentEnhancer<GitHubPrSpot> {
+export class GitHubPrAppendEnhancer implements CommentEnhancer<GitHubPrAppendSpot> {
   forSpotTypes(): string[] {
-    return [GH_PR]
+    return [GH_PR_APPEND]
   }
 
-  tryToEnhance(_textarea: HTMLTextAreaElement, location: StrippedLocation): GitHubPrSpot | null {
+  tryToEnhance(
+    _textarea: HTMLTextAreaElement,
+    location: StrippedLocation,
+  ): GitHubPrAppendSpot | null {
     // Only handle github.com domains TODO: identify GitHub Enterprise somehow
     if (location.host !== 'github.com' || _textarea.id !== 'new_comment_field') {
       return null
@@ -45,12 +48,12 @@ export class GitHubPrEnhancer implements CommentEnhancer<GitHubPrSpot> {
       number,
       slug,
       title,
-      type: GH_PR,
+      type: GH_PR_APPEND,
       unique_key,
     }
   }
 
-  enhance(textArea: HTMLTextAreaElement, _spot: GitHubPrSpot): OverTypeInstance {
+  enhance(textArea: HTMLTextAreaElement, _spot: GitHubPrAppendSpot): OverTypeInstance {
     prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     return new OverType(overtypeContainer, {
@@ -61,7 +64,7 @@ export class GitHubPrEnhancer implements CommentEnhancer<GitHubPrSpot> {
     })[0]!
   }
 
-  tableUpperDecoration(spot: GitHubPrSpot): React.ReactNode {
+  tableUpperDecoration(spot: GitHubPrAppendSpot): React.ReactNode {
     const { slug, number } = spot
     return (
       <>
@@ -71,7 +74,7 @@ export class GitHubPrEnhancer implements CommentEnhancer<GitHubPrSpot> {
     )
   }
 
-  tableTitle(spot: GitHubPrSpot): string {
+  tableTitle(spot: GitHubPrAppendSpot): string {
     return spot.title
   }
 }

src/lib/enhancers/github/GitHubPrNewEnhancer.tsx renamed to src/lib/enhancers/github/GitHubPrCreateEnhancer.tsx

@@ -4,23 +4,26 @@ import { logger } from '../../logger'
 import { modifyDOM } from '../modifyDOM'
 import { commonGithubOptions, prepareGitHubHighlighter } from './github-common'
 
-const GH_PR_NEW = 'GH_PR_NEW' as const
+const GH_PR_CREATE = 'GH_PR_CREATE' as const
 
-interface GitHubPRNewSpot extends CommentSpot {
-  type: typeof GH_PR_NEW
+interface GitHubPrCreateSpot extends CommentSpot {
+  type: typeof GH_PR_CREATE
   domain: string
   slug: string // owner/repo
   title: string
   head: string // `user:repo:branch` where changes are implemented
   base: string // branch you want changes pulled into
 }
 
-export class GitHubPRNewEnhancer implements CommentEnhancer<GitHubPRNewSpot> {
+export class GitHubPrCreateEnhancer implements CommentEnhancer<GitHubPrCreateSpot> {
   forSpotTypes(): string[] {
-    return [GH_PR_NEW]
+    return [GH_PR_CREATE]
   }
 
-  tryToEnhance(textarea: HTMLTextAreaElement, location: StrippedLocation): GitHubPRNewSpot | null {
+  tryToEnhance(
+    textarea: HTMLTextAreaElement,
+    location: StrippedLocation,
+  ): GitHubPrCreateSpot | null {
     if (textarea.id === 'feedback') {
       return null
     }
@@ -52,12 +55,12 @@ export class GitHubPRNewEnhancer implements CommentEnhancer<GitHubPRNewSpot> {
       head,
       slug,
       title,
-      type: GH_PR_NEW,
+      type: GH_PR_CREATE,
       unique_key,
     }
   }
 
-  enhance(textArea: HTMLTextAreaElement, _spot: GitHubPRNewSpot): OverTypeInstance {
+  enhance(textArea: HTMLTextAreaElement, _spot: GitHubPrCreateSpot): OverTypeInstance {
     prepareGitHubHighlighter()
     const overtypeContainer = modifyDOM(textArea)
     return new OverType(overtypeContainer, {
@@ -67,7 +70,7 @@ export class GitHubPRNewEnhancer implements CommentEnhancer<GitHubPRNewSpot> {
     })[0]!
   }
 
-  tableUpperDecoration(spot: GitHubPRNewSpot): React.ReactNode {
+  tableUpperDecoration(spot: GitHubPrCreateSpot): React.ReactNode {
     const { slug } = spot
     return (
       <>
@@ -77,11 +80,11 @@ export class GitHubPRNewEnhancer implements CommentEnhancer<GitHubPRNewSpot> {
     )
   }
 
-  tableTitle(spot: GitHubPRNewSpot): string {
+  tableTitle(spot: GitHubPrCreateSpot): string {
     return spot.title || 'New Pull Request'
   }
 
-  buildUrl(spot: GitHubPRNewSpot): string {
+  buildUrl(spot: GitHubPrCreateSpot): string {
     return `https://${spot.domain}/${spot.slug}/issue/new`
   }
 }

src/lib/registries.ts

@@ -5,8 +5,8 @@ import { CommentEnhancerMissing } from './enhancers/CommentEnhancerMissing'
 import { GitHubEditEnhancer } from './enhancers/github/GitHubEditEnhancer'
 import { GitHubIssueAppendEnhancer } from './enhancers/github/GitHubIssueAppendEnhancer'
 import { GitHubIssueCreateEnhancer } from './enhancers/github/GitHubIssueCreateEnhancer'
-import { GitHubPrEnhancer } from './enhancers/github/GitHubPrEnhancer'
-import { GitHubPRNewEnhancer } from './enhancers/github/GitHubPrNewEnhancer'
+import { GitHubPrAppendEnhancer } from './enhancers/github/GitHubPrAppendEnhancer'
+import { GitHubPrCreateEnhancer } from './enhancers/github/GitHubPrCreateEnhancer'
 
 export interface EnhancedTextarea<T extends CommentSpot = CommentSpot> {
   textarea: HTMLTextAreaElement
@@ -24,8 +24,8 @@ export class EnhancerRegistry {
     this.register(new GitHubEditEnhancer())
     this.register(new GitHubIssueAppendEnhancer())
     this.register(new GitHubIssueCreateEnhancer())
-    this.register(new GitHubPrEnhancer())
-    this.register(new GitHubPRNewEnhancer())
+    this.register(new GitHubPrAppendEnhancer())
+    this.register(new GitHubPrCreateEnhancer())
     const textColor = 'rgb(31, 35, 40)'
     const headingColor = 'rgb(174, 52, 151)'
     OverType.setTheme({

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

@@ -68,7 +68,7 @@ exports[`github detection > gh_pr:should detect correct spots 1`] = `
       "slug": "diffplug/selfie",
       "title": "Add "VCR" functionality
           #517",
-      "type": "GH_PR",
+      "type": "GH_PR_APPEND",
       "unique_key": "github.com:diffplug/selfie:517",
     },
   },
@@ -93,7 +93,7 @@ exports[`github detection > gh_pr_edit:should detect correct spots 1`] = `
       "title": "Feat/expand corpus
  
  #58",
-      "type": "GH_PR",
+      "type": "GH_PR_APPEND",
       "unique_key": "github.com:diffplug/gitcasso:58",
     },
   },
@@ -114,7 +114,7 @@ exports[`github detection > gh_pr_new:should detect correct spots 1`] = `
       "head": "cavia-porcellus:selfie:main",
       "slug": "diffplug/selfie",
       "title": "Update README.md",
-      "type": "GH_PR_NEW",
+      "type": "GH_PR_CREATE",
       "unique_key": "github.com:diffplug/selfie:main...cavia-porcellus:selfie:main",
     },
   },

tests/playground/replica.tsx

@@ -2,14 +2,14 @@ import { PopupRoot } from '@/components/PopupRoot'
 import type { CommentStorage, CommentTableRow } from '@/entrypoints/background'
 import type { CommentSpot } from '@/lib/enhancer'
 import type { GitHubIssueAppendSpot } from '@/lib/enhancers/github/GitHubIssueAppendEnhancer'
-import type { GitHubPrSpot } from '@/lib/enhancers/github/GitHubPrEnhancer'
+import type { GitHubPrAppendSpot } from '@/lib/enhancers/github/GitHubPrAppendEnhancer'
 
-const gh_pr: GitHubPrSpot = {
+const gh_pr: GitHubPrAppendSpot = {
   domain: 'github.com',
   number: 517,
   slug: 'diffplug/selfie',
   title: 'wowza',
-  type: 'GH_PR',
+  type: 'GH_PR_APPEND',
   unique_key: 'github.com:diffplug/selfie:517',
 }
 const gh_issue: GitHubIssueAppendSpot = {

tests/playground/replicaData.tsx

@@ -1,7 +1,7 @@
 import type { CommentTableRow } from '@/entrypoints/background'
 import type { CommentSpot } from '@/lib/enhancer'
 import type { GitHubIssueAppendSpot } from '@/lib/enhancers/github/GitHubIssueAppendEnhancer'
-import type { GitHubPrSpot } from '@/lib/enhancers/github/GitHubPrEnhancer'
+import type { GitHubPrAppendSpot } from '@/lib/enhancers/github/GitHubPrAppendEnhancer'
 
 export interface RedditSpot extends CommentSpot {
   title: string
@@ -42,9 +42,9 @@ export const generateMockDrafts = (): CommentTableRow[] => [
       number: 1234,
       slug: 'microsoft/vscode',
       title: "Fix memory leak in extension host (why is this so hard! It's been months!)",
-      type: 'GH_PR',
+      type: 'GH_PR_APPEND',
       unique_key: '1',
-    } satisfies GitHubPrSpot),
+    } satisfies GitHubPrAppendSpot),
   },
   {
     isOpenTab: false,
@@ -129,9 +129,9 @@ export const generateMockDrafts = (): CommentTableRow[] => [
       number: 9012,
       slug: 'vercel/next.js',
       title: 'Update routing documentation',
-      type: 'GH_PR',
+      type: 'GH_PR_APPEND',
       unique_key: '4',
-    } satisfies GitHubPrSpot),
+    } satisfies GitHubPrAppendSpot),
   },
   {
     isOpenTab: true,
@@ -170,8 +170,8 @@ export const generateMockDrafts = (): CommentTableRow[] => [
       number: 3456,
       slug: 'nodejs/node',
       title: 'Add support for ESM in worker threads',
-      type: 'GH_PR',
+      type: 'GH_PR_APPEND',
       unique_key: '5',
-    } satisfies GitHubPrSpot),
+    } satisfies GitHubPrAppendSpot),
   },
 ]