Support paste config

Author: Andrew L

src/index.ts

@@ -1,3 +1,4 @@
+import {OptionConfig, PASTE_AS_PLAIN_TEXT_ATTRIBUTE} from './option-config'
 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'
@@ -12,9 +13,10 @@ interface Subscription {
   unsubscribe: () => void
 }
 
-function subscribe(el: HTMLElement): Subscription {
-  installSkipFormatting(el, installTable, installImageLink, installLink, installText, installHTML)
+function subscribe(el: HTMLElement, optionConfig?: OptionConfig): Subscription {
+  markElementWithConfigIfNeeded(el, optionConfig)
 
+  installSkipFormatting(el, installTable, installImageLink, installLink, installText, installHTML)
   return {
     unsubscribe: () => {
       uninstallSkipFormatting(el)
@@ -27,6 +29,18 @@ function subscribe(el: HTMLElement): Subscription {
   }
 }
 
+function markElementWithConfigIfNeeded(el: HTMLElement, optionConfig?: OptionConfig) {
+  // eslint-disable-next-line no-console
+  console.log(optionConfig)
+
+  if (optionConfig?.pasteAsPlainText) {
+    // eslint-disable-next-line no-console
+    console.log(optionConfig?.pasteAsPlainText, 'HERE')
+
+    el.setAttribute(PASTE_AS_PLAIN_TEXT_ATTRIBUTE, 'true')
+  }
+}
+
 export {
   subscribe,
   installHTML,

src/option-config.ts

@@ -0,0 +1,7 @@
+const PASTE_AS_PLAIN_TEXT_ATTRIBUTE = 'data-paste-as-plain-text'
+
+interface OptionConfig {
+  pasteAsPlainText?: boolean
+}
+
+export {PASTE_AS_PLAIN_TEXT_ATTRIBUTE, OptionConfig}

src/paste-markdown-link.ts

@@ -1,3 +1,4 @@
+import {PASTE_AS_PLAIN_TEXT_ATTRIBUTE} from './option-config'
 import {insertText} from './text'
 import {shouldSkipFormatting} from './paste-keyboard-shortcut-helper'
 
@@ -11,7 +12,13 @@ export function uninstall(el: HTMLElement): void {
 
 function onPaste(event: ClipboardEvent) {
   const {currentTarget: el} = event
-  if (shouldSkipFormatting(el as HTMLElement)) return
+  const element = el as HTMLElement
+  const shouldPastePlainText = element.hasAttribute(PASTE_AS_PLAIN_TEXT_ATTRIBUTE)
+  const shouldSkipDefaultBehavior = shouldSkipFormatting(element)
+
+  if ((!shouldPastePlainText && shouldSkipDefaultBehavior) || (shouldPastePlainText && !shouldSkipDefaultBehavior)) {
+    return
+  }
 
   const transfer = event.clipboardData
   if (!transfer || !hasPlainText(transfer)) return
@@ -26,6 +33,7 @@ function onPaste(event: ClipboardEvent) {
 
   const selectedText = field.value.substring(field.selectionStart, field.selectionEnd)
   if (!selectedText.length) return
+
   // Prevent linkification when replacing an URL
   // Trim whitespace in case whitespace is selected by mistake or by intention
   if (isURL(selectedText.trim())) return

test/test.js

@@ -43,6 +43,38 @@ describe('paste-markdown', function () {
       assert.equal(textarea.value, 'The examples can be found [here](https://github.com).')
     })
 
+    it('turns pasted urls on selected text into markdown links if pasteAsPlainText is false', function () {
+      subscription = subscribeWithOptionConfig(subscription, textarea, false)
+
+      // eslint-disable-next-line i18n-text/no-en
+      textarea.value = 'The examples can be found here.'
+      textarea.setSelectionRange(26, 30)
+      paste(textarea, {'text/plain': 'https://github.com'})
+      assert.equal(textarea.value, 'The examples can be found [here](https://github.com).')
+    })
+
+    it('turns pasted urls on selected text into markdown links if pasteAsPlainText is true and skip format flag is true', function () {
+      subscription = subscribeWithOptionConfig(subscription, textarea, true)
+
+      // eslint-disable-next-line i18n-text/no-en
+      textarea.value = 'The examples can be found here.'
+      textarea.setSelectionRange(26, 30)
+      dispatchSkipFormattingKeyEvent(textarea)
+      paste(textarea, {'text/plain': 'https://github.com'})
+      assert.equal(textarea.value, 'The examples can be found [here](https://github.com).')
+    })
+
+    it('pastes as plain text on selected text if pasteAsPlainText is true', function () {
+      subscription = subscribeWithOptionConfig(subscription, textarea, true)
+
+      // eslint-disable-next-line i18n-text/no-en
+      textarea.value = 'The examples can be found here.'
+      textarea.setSelectionRange(26, 30)
+      paste(textarea, {'text/plain': 'https://github.com'})
+      // The text area will be unchanged at this stage as the paste won't be handled by our listener
+      assert.equal(textarea.value, 'The examples can be found here.')
+    })
+
     it('creates a markdown link when the pasted url includes a trailing slash', function () {
       // eslint-disable-next-line i18n-text/no-en
       textarea.value = 'The examples can be found here.'
@@ -353,6 +385,12 @@ function dispatchSkipFormattingKeyEvent(textarea) {
   )
 }
 
+function subscribeWithOptionConfig(subscription, textarea, pasteAsPlainText) {
+  // Clear the before test subscription with no config and re-subscribe with config
+  subscription.unsubscribe()
+  return subscribe(textarea, {pasteAsPlainText})
+}
+
 function paste(textarea, data) {
   const dataTransfer = new DataTransfer()
   for (const key in data) {