fix: copy multiline values as template literals (#2197)

Fixes microsoft/vscode#241008

Author: connor4312

CHANGELOG.md

@@ -7,6 +7,7 @@ This changelog records changes to stable releases since 1.50.2. "TBA" changes he
 - fix: explicitly specify completion ranges ([vscode#243409](https://github.com/microsoft/vscode/issues/243409))
 - fix: memory leak between debug sessions ([#2173](https://github.com/microsoft/vscode-js-debug/issues/2173))
 - fix: support `npm.scriptRunner: node`
+- fix: copy multiline values as template literals ([vscode#241008](https://github.com/microsoft/vscode/issues/241008))
 - fix: support "attach to node process" without wmic.exe and on arm64 ([vscode#244139](https://github.com/microsoft/vscode/issues/244139))
 - fix: support webview2 debugging on arm64
 - fix: race condition when opening attached windows ([vscode#239769](https://github.com/microsoft/vscode/issues/239769))

src/adapter/templates/serializeForClipboard.ts

@@ -121,8 +121,13 @@ export const serializeForClipboardTmpl = templateFunction(function(
           ),
           indent.repeat(level) + '}',
         ].join(eol);
-      case 'string':
-        return JSON.stringify(value);
+      case 'string': {
+        if (value.includes('\n')) {
+          return '`' + value.replace(/[`\\\\]|\${/g, '\\$&') + '`';
+        } else {
+          return JSON.stringify(value);
+        }
+      }
       case 'symbol':
         return value.toString();
       case 'undefined':

src/test/evaluate/evaluate.ts

@@ -252,13 +252,18 @@ describe('evaluate', () => {
     'new Date(1665007127286)': '"2022-10-05T21:58:47.286Z"',
     '(() => { const node = document.createElement("div"); node.innerText = "hi"; return node })()':
       `<div>hi</div>`,
+    '"hello\\nmu`lti${line}"': '`hello\nmu\\`lti\\${line}`',
+  };
+
+  const fnCopyExpressions = {
+    '"hello"': 'hello',
+    '"hello\\nmu`lti${line}"': 'hello\nmu`lti${line}',
   };
 
   itIntegrates('copy via function', async ({ r }) => {
     const p = await r.launchAndLoad('blank');
-    p.dap.evaluate({ expression: 'var x = "hello"; copy(x)' });
-    expect((await p.dap.once('copyRequested')).text).to.equal('hello');
-    for (const [expression, expected] of Object.entries(copyExpressions)) {
+    const mapping = { ...copyExpressions, ...fnCopyExpressions };
+    for (const [expression, expected] of Object.entries(mapping)) {
       p.dap.evaluate({ expression: `copy(${expression})` });
       const actual = await p.dap.once('copyRequested');
       expect(actual.text).to.equal(expected, expression);