Rename refactor.

Author: ntwigg

browser-extension/src/datamodel/enhancer.ts

@@ -3,13 +3,13 @@
  * - display it in a table
  * - reopen the draft in-context
  */
-export interface CommentContext {
+export interface CommentSpot {
   unique_key: string
   type: string
 }
 
 /** wraps the textareas of a given platform with Gitcasso's enhancements */
-export interface CommentEnhancer<T extends CommentContext = CommentContext> {
+export interface CommentEnhancer<T extends CommentSpot = CommentSpot> {
   /** guarantees to only return a type within this list */
   forCommentTypes(): string[]
   /**

browser-extension/src/datamodel/handlers/github-handler.ts

@@ -1,4 +1,4 @@
-import type { CommentContext, CommentEnhancer } from '../enhancer'
+import type { CommentEnhancer, CommentSpot } from '../enhancer'
 
 export type GitHubCommentType =
   | 'GH_ISSUE_NEW'
@@ -9,7 +9,7 @@ export type GitHubCommentType =
   | 'GH_PR_EDIT_COMMENT'
   | 'GH_PR_CODE_COMMENT'
 
-export interface GitHubContext extends CommentContext {
+export interface GitHubContext extends CommentSpot {
   type: GitHubCommentType // Override to narrow from string to specific union
   domain: string
   slug: string // owner/repo

browser-extension/src/datamodel/handlers/reddit-handler.ts

@@ -1,8 +1,8 @@
-import type { CommentContext, CommentEnhancer } from '../enhancer'
+import type { CommentEnhancer, CommentSpot } from '../enhancer'
 
 export type RedditCommentType = 'REDDIT_POST_NEW' | 'REDDIT_COMMENT_NEW' | 'REDDIT_COMMENT_EDIT'
 
-export interface RedditContext extends CommentContext {
+export interface RedditContext extends CommentSpot {
   type: RedditCommentType // Override to narrow from string to specific union
   subreddit: string
   postId?: string | undefined

browser-extension/src/datamodel/registries.ts

@@ -1,8 +1,8 @@
-import type { CommentContext, CommentEnhancer } from './enhancer'
+import type { CommentEnhancer, CommentSpot } from './enhancer'
 import { GitHubHandler as GitHubEnhancer } from './handlers/github-handler'
 import { RedditHandler as RedditEnhancer } from './handlers/reddit-handler'
 
-export interface EnhancedTextarea<T extends CommentContext = CommentContext> {
+export interface EnhancedTextarea<T extends CommentSpot = CommentSpot> {
   element: HTMLTextAreaElement
   context: T
   handler: CommentEnhancer<T>
@@ -17,7 +17,7 @@ export class EnhancerRegistry {
     this.register(new RedditEnhancer())
   }
 
-  private register<T extends CommentContext>(handler: CommentEnhancer<T>): void {
+  private register<T extends CommentSpot>(handler: CommentEnhancer<T>): void {
     this.enhancers.add(handler)
   }
 
@@ -56,7 +56,7 @@ export class EnhancerRegistry {
 export class TextareaRegistry {
   private textareas = new Map<HTMLTextAreaElement, EnhancedTextarea<any>>()
 
-  register<T extends CommentContext>(textareaInfo: EnhancedTextarea<T>): void {
+  register<T extends CommentSpot>(textareaInfo: EnhancedTextarea<T>): void {
     this.textareas.set(textareaInfo.element, textareaInfo)
     // TODO: register as a draft in progress with the global list
   }

browser-extension/src/entrypoints/content.ts

@@ -2,21 +2,21 @@ import { CONFIG } from '../common/config'
 import { logger } from '../common/logger'
 import { EnhancerRegistry, TextareaRegistry } from '../datamodel/registries'
 
-const handlerRegistry = new EnhancerRegistry()
-const textareaRegistry = new TextareaRegistry()
+const enhancers = new EnhancerRegistry()
+const enhancedTextareas = new TextareaRegistry()
 
 export default defineContentScript({
   main() {
     const textAreasOnPageLoad = document.querySelectorAll<HTMLTextAreaElement>(`textarea`)
     for (const textarea of textAreasOnPageLoad) {
-      initializeMaybeIsPageload(textarea)
+      enhanceMaybe(textarea)
     }
     const observer = new MutationObserver(handleMutations)
     observer.observe(document.body, {
       childList: true,
       subtree: true,
     })
-    logger.debug('Extension loaded with', handlerRegistry.getAllHandlers().length, 'handlers')
+    logger.debug('Extension loaded with', enhancers.getAllHandlers().length, 'handlers')
   },
   matches: ['<all_urls>'],
   runAt: 'document_end',
@@ -29,13 +29,13 @@ function handleMutations(mutations: MutationRecord[]): void {
       if (node.nodeType === Node.ELEMENT_NODE) {
         const element = node as Element
         if (element.tagName === 'TEXTAREA') {
-          initializeMaybeIsPageload(element as HTMLTextAreaElement)
+          enhanceMaybe(element as HTMLTextAreaElement)
         } else {
           // Also check for textareas within added subtrees
           const textareas = element.querySelectorAll?.('textarea')
           if (textareas) {
             for (const textarea of textareas) {
-              initializeMaybeIsPageload(textarea)
+              enhanceMaybe(textarea)
             }
           }
         }
@@ -47,13 +47,13 @@ function handleMutations(mutations: MutationRecord[]): void {
       if (node.nodeType === Node.ELEMENT_NODE) {
         const element = node as Element
         if (element.tagName === 'TEXTAREA') {
-          textareaRegistry.unregisterDueToModification(element as HTMLTextAreaElement)
+          enhancedTextareas.unregisterDueToModification(element as HTMLTextAreaElement)
         } else {
           // Also check for textareas within removed subtrees
           const textareas = element.querySelectorAll?.('textarea')
           if (textareas) {
             for (const textarea of textareas) {
-              textareaRegistry.unregisterDueToModification(textarea)
+              enhancedTextareas.unregisterDueToModification(textarea)
             }
           }
         }
@@ -62,9 +62,9 @@ function handleMutations(mutations: MutationRecord[]): void {
   }
 }
 
-function initializeMaybeIsPageload(textarea: HTMLTextAreaElement) {
+function enhanceMaybe(textarea: HTMLTextAreaElement) {
   // Check if this textarea is already registered
-  if (textareaRegistry.get(textarea)) {
+  if (enhancedTextareas.get(textarea)) {
     logger.debug('textarea already registered {}', textarea)
     return
   }
@@ -73,10 +73,14 @@ function initializeMaybeIsPageload(textarea: HTMLTextAreaElement) {
   injectStyles()
 
   // Use registry to identify and handle this specific textarea
-  const textareaInfo = handlerRegistry.identifyTextarea(textarea)
-  if (textareaInfo) {
-    logger.debug('Identified textarea:', textareaInfo.context.type, textareaInfo.context.unique_key)
-    textareaRegistry.register(textareaInfo)
+  const enhancedTextarea = enhancers.identifyTextarea(textarea)
+  if (enhancedTextarea) {
+    logger.debug(
+      'Identified textarea:',
+      enhancedTextarea.context.type,
+      enhancedTextarea.context.unique_key,
+    )
+    enhancedTextareas.register(enhancedTextarea)
   } else {
     logger.debug('No handler found for textarea')
   }