rename and add support for macOS

Author: zutshisunakshi

src/index.ts

@@ -1,30 +1,32 @@
 import {install as installHTML, uninstall as uninstallHTML} from './paste-markdown-html'
 import {install as installImageLink, uninstall as uninstallImageLink} from './paste-markdown-image-link'
 import {install as installLink, uninstall as uninstallLink} from './paste-markdown-link'
-import {install as installTable, uninstall as uninstallTable} from './paste-markdown-table'
-import {install as installText, uninstall as uninstallText} from './paste-markdown-text'
 import {
-  installBefore as installUnformatted,
-  installAfter as installUnformattedAfter,
-  uninstall as uninstallUnformatted
+  installBefore as installSkipFormatting,
+  installAfter as installSkipFormattingPaste,
+  uninstall as uninstallSkipFormatting
 } from './paste-keyboard-shortcut-helper'
+import {install as installTable, uninstall as uninstallTable} from './paste-markdown-table'
+import {install as installText, uninstall as uninstallText} from './paste-markdown-text'
 
 interface Subscription {
   unsubscribe: () => void
 }
 
+// Inorder to intercept default paste behavior correctly using keyboard shorcuts, the
+// order of skip formatting handler functions here does matter.
 function subscribe(el: HTMLElement): Subscription {
-  installUnformatted(el)
+  installSkipFormatting(el)
   installTable(el)
   installImageLink(el)
   installLink(el)
   installText(el)
   installHTML(el)
-  installUnformattedAfter(el)
+  installSkipFormattingPaste(el)
 
   return {
     unsubscribe: () => {
-      uninstallUnformatted(el)
+      uninstallSkipFormatting(el)
       uninstallTable(el)
       uninstallHTML(el)
       uninstallImageLink(el)

src/paste-keyboard-shortcut-helper.ts

@@ -1,32 +1,35 @@
-const unformatted = new WeakMap<HTMLElement, boolean>()
+const skipformattingMap = new WeakMap<HTMLElement, boolean>()
 
-function setUnformattedFlag(event: KeyboardEvent): void {
+function setSkipFormattingFlag(event: KeyboardEvent): void {
   const {currentTarget: el} = event
-  if (event.code === 'KeyV' && (event.ctrlKey || event.metaKey) && event.shiftKey) {
-    unformatted.set(el as HTMLElement, true)
+  const isSkipFormattingKeys = event.code === 'KeyV' && (event.ctrlKey || event.metaKey) && event.shiftKey
+
+  // Supports Cmd+Shift+V (Chrome) / Cmd+Shift+Opt+V (Safari, Firefox and Edge) to mimic paste and match style shortcut on MacOS.
+  if (isSkipFormattingKeys || (isSkipFormattingKeys && event.altKey)) {
+    skipformattingMap.set(el as HTMLElement, true)
   }
 }
 
-function unsetUnformattedFlag(event: ClipboardEvent): void {
+function unsetSkipFormattedFlag(event: ClipboardEvent): void {
   const {currentTarget: el} = event
-  unformatted.delete(el as HTMLElement)
+  skipformattingMap.delete(el as HTMLElement)
 }
 
-export function isUnformatted(el: HTMLElement): boolean {
-  const isUnformattedState = unformatted.get(el) ?? false
+export function shouldSkipformatting(el: HTMLElement): boolean {
+  const shouldSkipformattingState = skipformattingMap.get(el) ?? false
 
-  return isUnformattedState
+  return shouldSkipformattingState
 }
 
 export function installBefore(el: HTMLElement): void {
-  el.addEventListener('keydown', setUnformattedFlag)
+  el.addEventListener('keydown', setSkipFormattingFlag)
 }
 
 export function installAfter(el: HTMLElement): void {
-  el.addEventListener('paste', unsetUnformattedFlag)
+  el.addEventListener('paste', unsetSkipFormattedFlag)
 }
 
 export function uninstall(el: HTMLElement): void {
-  el.removeEventListener('keydown', setUnformattedFlag)
-  el.removeEventListener('paste', unsetUnformattedFlag)
+  el.removeEventListener('keydown', setSkipFormattingFlag)
+  el.removeEventListener('paste', unsetSkipFormattedFlag)
 }

src/paste-markdown-html.ts

@@ -1,5 +1,5 @@
 import {insertText} from './text'
-import {isUnformatted} from './paste-keyboard-shortcut-helper'
+import {shouldSkipformatting} from './paste-keyboard-shortcut-helper'
 
 export function install(el: HTMLElement): void {
   el.addEventListener('paste', onPaste)
@@ -12,7 +12,7 @@ export function uninstall(el: HTMLElement): void {
 function onPaste(event: ClipboardEvent) {
   const transfer = event.clipboardData
   const {currentTarget: el} = event
-  if (isUnformatted(el as HTMLElement)) return
+  if (shouldSkipformatting(el as HTMLElement)) return
   // if there is no clipboard data, or
   // if there is no html content in the clipboard, return
   if (!transfer || !hasHTML(transfer)) return

src/paste-markdown-image-link.ts

@@ -1,6 +1,6 @@
 /* @flow strict */
 import {insertText} from './text'
-import {isUnformatted} from './paste-keyboard-shortcut-helper'
+import {shouldSkipformatting} from './paste-keyboard-shortcut-helper'
 
 export function install(el: HTMLElement): void {
   el.addEventListener('dragover', onDragover)
@@ -39,7 +39,7 @@ function onDragover(event: DragEvent) {
 
 function onPaste(event: ClipboardEvent) {
   const {currentTarget: el} = event
-  if (isUnformatted(el as HTMLElement)) return
+  if (shouldSkipformatting(el as HTMLElement)) return
 
   const transfer = event.clipboardData
   if (!transfer || !hasLink(transfer)) return

src/paste-markdown-link.ts

@@ -1,5 +1,5 @@
 import {insertText} from './text'
-import {isUnformatted} from './paste-keyboard-shortcut-helper'
+import {shouldSkipformatting} from './paste-keyboard-shortcut-helper'
 
 export function install(el: HTMLElement): void {
   el.addEventListener('paste', onPaste)
@@ -11,7 +11,7 @@ export function uninstall(el: HTMLElement): void {
 
 function onPaste(event: ClipboardEvent) {
   const {currentTarget: el} = event
-  if (isUnformatted(el as HTMLElement)) return
+  if (shouldSkipformatting(el as HTMLElement)) return
 
   const transfer = event.clipboardData
   if (!transfer || !hasPlainText(transfer)) return

src/paste-markdown-table.ts

@@ -1,5 +1,5 @@
 import {insertText} from './text'
-import {isUnformatted} from './paste-keyboard-shortcut-helper'
+import {shouldSkipformatting} from './paste-keyboard-shortcut-helper'
 
 export function install(el: HTMLElement): void {
   el.addEventListener('dragover', onDragover)
@@ -37,7 +37,7 @@ function onDragover(event: DragEvent) {
 
 function onPaste(event: ClipboardEvent) {
   const {currentTarget: el} = event
-  if (isUnformatted(el as HTMLElement)) return
+  if (shouldSkipformatting(el as HTMLElement)) return
 
   if (!event.clipboardData) return
 

src/paste-markdown-text.ts

@@ -1,5 +1,5 @@
 import {insertText} from './text'
-import {isUnformatted} from './paste-keyboard-shortcut-helper'
+import {shouldSkipformatting} from './paste-keyboard-shortcut-helper'
 
 export function install(el: HTMLElement): void {
   el.addEventListener('paste', onPaste)
@@ -11,7 +11,7 @@ export function uninstall(el: HTMLElement): void {
 
 function onPaste(event: ClipboardEvent) {
   const {currentTarget: el} = event
-  if (isUnformatted(el as HTMLElement)) return
+  if (shouldSkipformatting(el as HTMLElement)) return
 
   const transfer = event.clipboardData
   if (!transfer || !hasMarkdown(transfer)) return