Allow external copying files into the workspace on markdown drop / paste (#182572)

Allow copying files in the workspace on markdown drop / paste

Fixes #157043

Also:

- Renames the markdown paste settings and makes them no longer experimental
- Makes the copyFiles setting no longer experimental
- Adds a `markdown.copyFiles.overwriteBehavior` which lets you control if/how existing files are overwritten

Author: mjbvz

extensions/markdown-language-features/package.json

@@ -456,13 +456,36 @@
           "markdownDescription": "%configuration.markdown.editor.drop.enabled%",
           "scope": "resource"
         },
-        "markdown.experimental.editor.pasteLinks.enabled": {
+        "markdown.editor.drop.copyIntoWorkspace": {
+          "type": "string",
+          "markdownDescription": "%configuration.markdown.editor.drop.copyIntoWorkspace%",
+          "default": "mediaFiles",
+          "enum": [
+            "mediaFiles",
+            "never"
+          ],
+          "markdownEnumDescriptions": [
+            "%configuration.copyIntoWorkspace.mediaFiles%",
+            "%configuration.copyIntoWorkspace.never%"
+          ]
+        },
+        "markdown.editor.filePaste.enabled": {
           "type": "boolean",
           "scope": "resource",
-          "markdownDescription": "%configuration.markdown.editor.pasteLinks.enabled%",
-          "default": true,
-          "tags": [
-            "experimental"
+          "markdownDescription": "%configuration.markdown.editor.filePaste.enabled%",
+          "default": true
+        },
+        "markdown.editor.filePaste.copyIntoWorkspace": {
+          "type": "string",
+          "markdownDescription": "%configuration.markdown.editor.filePaste.copyIntoWorkspace%",
+          "default": "mediaFiles",
+          "enum": [
+            "mediaFiles",
+            "never"
+          ],
+          "markdownEnumDescriptions": [
+            "%configuration.copyIntoWorkspace.mediaFiles%",
+            "%configuration.copyIntoWorkspace.never%"
           ]
         },
         "markdown.validate.enabled": {
@@ -588,13 +611,26 @@
           "description": "%configuration.markdown.occurrencesHighlight.enabled%",
           "scope": "resource"
         },
-        "markdown.experimental.copyFiles.destination": {
+        "markdown.copyFiles.destination": {
           "type": "object",
           "markdownDescription": "%configuration.markdown.copyFiles.destination%",
           "additionalProperties": {
             "type": "string"
           }
         },
+        "markdown.copyFiles.overwriteBehavior": {
+          "type": "string",
+          "markdownDescription": "%configuration.markdown.copyFiles.overwriteBehavior%",
+          "default": "nameIncrementally",
+          "enum": [
+            "nameIncrementally",
+            "overwrite"
+          ],
+          "markdownEnumDescriptions": [
+            "%configuration.markdown.copyFiles.overwriteBehavior.nameIncrementally%",
+            "%configuration.markdown.copyFiles.overwriteBehavior.overwrite%"
+          ]
+        },
         "markdown.preferredMdPathExtensionStyle": {
           "type": "string",
           "default": "auto",

extensions/markdown-language-features/package.nls.json

@@ -32,17 +32,21 @@
 	"configuration.markdown.links.openLocation.currentGroup": "Open links in the active editor group.",
 	"configuration.markdown.links.openLocation.beside": "Open links beside the active editor.",
 	"configuration.markdown.suggest.paths.enabled.description": "Enable path suggestions while writing links in Markdown files.",
-	"configuration.markdown.suggest.paths.includeWorkspaceHeaderCompletions": "Enable suggestions for headers in other Markdown files in the current workspace. Accepting one of these suggestions inserts the full path to header in that file, for example `[link text](/path/to/file.md#header)`.",
+	"configuration.markdown.suggest.paths.includeWorkspaceHeaderCompletions": "Enable suggestions for headers in other Markdown files in the current workspace. Accepting one of these suggestions inserts the full path to header in that file, for example: `[link text](/path/to/file.md#header)`.",
 	"configuration.markdown.suggest.paths.includeWorkspaceHeaderCompletions.never": "Disable workspace header suggestions.",
-	"configuration.markdown.suggest.paths.includeWorkspaceHeaderCompletions.onDoubleHash": "Enable workspace header suggestions after typing `##` in a path, for example `[link text](##`.",
-	"configuration.markdown.suggest.paths.includeWorkspaceHeaderCompletions.onSingleOrDoubleHash": "Enable workspace header suggestions after typing either `##` or `#` in a path, for example `[link text](#` or `[link text](##`.",
+	"configuration.markdown.suggest.paths.includeWorkspaceHeaderCompletions.onDoubleHash": "Enable workspace header suggestions after typing `##` in a path, for example: `[link text](##`.",
+	"configuration.markdown.suggest.paths.includeWorkspaceHeaderCompletions.onSingleOrDoubleHash": "Enable workspace header suggestions after typing either `##` or `#` in a path, for example: `[link text](#` or `[link text](##`.",
 	"configuration.markdown.editor.drop.enabled": "Enable dropping files into a Markdown editor while holding Shift. Requires enabling `#editor.dropIntoEditor.enabled#`.",
-	"configuration.markdown.editor.pasteLinks.enabled": "Enable pasting files into a Markdown editor inserts Markdown links. Requires enabling `#editor.pasteAs.enabled#`.",
+	"configuration.markdown.editor.drop.copyIntoWorkspace": "Controls if files outside of the workspace that are dropped into a Markdown editor should be copied into the workspace.\n\nUse `#markdown.copyFiles.destination#` to configure where copied dropped files should be created",
+	"configuration.markdown.editor.filePaste.enabled": "Enable pasting files into a Markdown editor to create Markdown links. Requires enabling `#editor.pasteAs.enabled#`.",
+	"configuration.markdown.editor.filePaste.copyIntoWorkspace": "Controls if files outside of the workspace that are pasted into a Markdown editor should be copied into the workspace.\n\nUse `#markdown.copyFiles.destination#` to configure where copied files should be created.",
+	"configuration.copyIntoWorkspace.mediaFiles": "Try to copy external image and video files into the workspace.",
+	"configuration.copyIntoWorkspace.never": "Do not copy external files into the workspace.",
 	"configuration.markdown.validate.enabled.description": "Enable all error reporting in Markdown files.",
-	"configuration.markdown.validate.referenceLinks.enabled.description": "Validate reference links in Markdown files, for example `[link][ref]`. Requires enabling `#markdown.validate.enabled#`.",
-	"configuration.markdown.validate.fragmentLinks.enabled.description": "Validate fragment links to headers in the current Markdown file, for example `[link](#header)`. Requires enabling `#markdown.validate.enabled#`.",
+	"configuration.markdown.validate.referenceLinks.enabled.description": "Validate reference links in Markdown files, for example: `[link][ref]`. Requires enabling `#markdown.validate.enabled#`.",
+	"configuration.markdown.validate.fragmentLinks.enabled.description": "Validate fragment links to headers in the current Markdown file, for example: `[link](#header)`. Requires enabling `#markdown.validate.enabled#`.",
 	"configuration.markdown.validate.fileLinks.enabled.description": "Validate links to other files in Markdown files, for example `[link](/path/to/file.md)`. This checks that the target files exists. Requires enabling `#markdown.validate.enabled#`.",
-	"configuration.markdown.validate.fileLinks.markdownFragmentLinks.description": "Validate the fragment part of links to headers in other files in Markdown files, for example `[link](/path/to/file.md#header)`. Inherits the setting value from `#markdown.validate.fragmentLinks.enabled#` by default.",
+	"configuration.markdown.validate.fileLinks.markdownFragmentLinks.description": "Validate the fragment part of links to headers in other files in Markdown files, for example: `[link](/path/to/file.md#header)`. Inherits the setting value from `#markdown.validate.fragmentLinks.enabled#` by default.",
 	"configuration.markdown.validate.ignoredLinks.description": "Configure links that should not be validated. For example adding `/about` would not validate the link `[about](/about)`, while the glob `/assets/**/*.svg` would let you skip validation for any link to `.svg` files under the `assets` directory.",
 	"configuration.markdown.validate.unusedLinkDefinitions.description": "Validate link definitions that are unused in the current file.",
 	"configuration.markdown.validate.duplicateLinkDefinitions.description": "Validate duplicated definitions in the current file.",
@@ -54,7 +58,10 @@
 	"configuration.markdown.updateLinksOnFileMove.include.property": "The glob pattern to match file paths against. Set to true to enable the pattern.",
 	"configuration.markdown.updateLinksOnFileMove.enableForDirectories": "Enable updating links when a directory is moved or renamed in the workspace.",
 	"configuration.markdown.occurrencesHighlight.enabled": "Enable highlighting link occurrences in the current document.",
-	"configuration.markdown.copyFiles.destination": "Defines where files copied into a Markdown document should be created. This is a map from globs that match on the Markdown document to destinations.\n\nThe destinations may use the following variables:\n\n- `${documentFileName}` — The full filename of the Markdown document, for example `readme.md`.\n- `${documentBaseName}` — The basename of Markdown document, for example `readme`.\n- `${documentExtName}` — The extension of the Markdown document, for example `md`.\n- `${documentDirName}` — The name of the Markdown document's parent directory.\n- `${documentWorkspaceFolder}` — The workspace folder for the Markdown document, for examples, `/Users/me/myProject`. This is the same as `${documentDirName}` if the file is not part of in a workspace.\n- `${fileName}` — The file name of the dropped file, for example `image.png`.",
+	"configuration.markdown.copyFiles.destination": "Defines where files copied created by drop or paste should be created. This is a map from globs that match on the Markdown document to destinations.\n\nThe destinations may use the following variables:\n\n- `${documentFileName}` — The full filename of the Markdown document, for example: `readme.md`.\n- `${documentBaseName}` — The basename of Markdown document, for example: `readme`.\n- `${documentExtName}` — The extension of the Markdown document, for example: `md`.\n- `${documentDirName}` — The name of the Markdown document's parent directory.\n- `${documentWorkspaceFolder}` — The workspace folder for the Markdown document, for example: `/Users/me/myProject`. This is the same as `${documentDirName}` if the file is not part of in a workspace.\n- `${fileName}` — The file name of the dropped file, for example: `image.png`.",
+	"configuration.markdown.copyFiles.overwriteBehavior": "Controls if files created by drop or paste should overwrite existing files.",
+	"configuration.markdown.copyFiles.overwriteBehavior.nameIncrementally": "If a file with the same name already exists, append a number to the file name, for example: `image.png` becomes `image-1.png`.",
+	"configuration.markdown.copyFiles.overwriteBehavior.overwrite": "If a file with the same name already exists, overwrite it.",
 	"configuration.markdown.preferredMdPathExtensionStyle": "Controls if file extensions (e.g. `.md`) are added or not for links to Markdown files. This setting is used when file paths are added by tooling such as path completions or file renames.",
 	"configuration.markdown.preferredMdPathExtensionStyle.auto": "For existing paths, try to maintain the file extension style. For new paths, add file extensions.",
 	"configuration.markdown.preferredMdPathExtensionStyle.includeExtension": "Prefer including the file extension. For example, path completions to a file named `file.md` will insert `file.md`.",

extensions/markdown-language-features/src/commands/insertResource.ts

@@ -6,8 +6,9 @@
 import * as vscode from 'vscode';
 import { Utils } from 'vscode-uri';
 import { Command } from '../commandManager';
-import { createUriListSnippet, getParentDocumentUri, imageFileExtensions } from '../languageFeatures/copyFiles/dropIntoEditor';
+import { createUriListSnippet, mediaFileExtensions } from '../languageFeatures/copyFiles/shared';
 import { coalesce } from '../util/arrays';
+import { getParentDocumentUri } from '../util/document';
 import { Schemes } from '../util/schemes';
 
 
@@ -47,7 +48,7 @@ export class InsertImageFromWorkspace implements Command {
 			canSelectFolders: false,
 			canSelectMany: true,
 			filters: {
-				[vscode.l10n.t("Images")]: Array.from(imageFileExtensions)
+				[vscode.l10n.t("Media")]: Array.from(mediaFileExtensions.keys())
 			},
 			openLabel: vscode.l10n.t("Insert image"),
 			title: vscode.l10n.t("Insert image"),
@@ -75,14 +76,14 @@ async function insertLink(activeEditor: vscode.TextEditor, selectedFiles: vscode
 	await vscode.workspace.applyEdit(edit);
 }
 
-function createInsertLinkEdit(activeEditor: vscode.TextEditor, selectedFiles: vscode.Uri[], insertAsImage: boolean) {
+function createInsertLinkEdit(activeEditor: vscode.TextEditor, selectedFiles: vscode.Uri[], insertAsMedia: boolean) {
 	const snippetEdits = coalesce(activeEditor.selections.map((selection, i): vscode.SnippetTextEdit | undefined => {
 		const selectionText = activeEditor.document.getText(selection);
 		const snippet = createUriListSnippet(activeEditor.document, selectedFiles, {
-			insertAsImage: insertAsImage,
+			insertAsMedia,
 			placeholderText: selectionText,
 			placeholderStartIndex: (i + 1) * selectedFiles.length,
-			separator: insertAsImage ? '\n' : ' ',
+			separator: insertAsMedia ? '\n' : ' ',
 		});
 
 		return snippet ? new vscode.SnippetTextEdit(selection, snippet.snippet) : undefined;

extensions/markdown-language-features/src/languageFeatures/copyFiles/copyFiles.ts

@@ -6,14 +6,41 @@ import * as path from 'path';
 import * as picomatch from 'picomatch';
 import * as vscode from 'vscode';
 import { Utils } from 'vscode-uri';
-import { getParentDocumentUri } from './dropIntoEditor';
+import { getParentDocumentUri } from '../../util/document';
+
+type OverwriteBehavior = 'overwrite' | 'nameIncrementally';
+
+interface CopyFileConfiguration {
+	readonly destination: Record<string, string>;
+	readonly overwriteBehavior: OverwriteBehavior;
+}
+
+function getCopyFileConfiguration(document: vscode.TextDocument): CopyFileConfiguration {
+	const config = vscode.workspace.getConfiguration('markdown', document);
+	return {
+		destination: config.get<Record<string, string>>('copyFiles.destination') ?? {},
+		overwriteBehavior: readOverwriteBehavior(config),
+	};
+}
+
+function readOverwriteBehavior(config: vscode.WorkspaceConfiguration): OverwriteBehavior {
+	switch (config.get('copyFiles.overwriteBehavior')) {
+		case 'overwrite': return 'overwrite';
+		default: return 'nameIncrementally';
+	}
+}
 
 export class NewFilePathGenerator {
 
 	private readonly _usedPaths = new Set<string>();
 
-	async getNewFilePath(document: vscode.TextDocument, file: vscode.DataTransferFile, token: vscode.CancellationToken): Promise<vscode.Uri | undefined> {
-		const desiredPath = getDesiredNewFilePath(document, file);
+	async getNewFilePath(
+		document: vscode.TextDocument,
+		file: vscode.DataTransferFile,
+		token: vscode.CancellationToken,
+	): Promise<{ readonly uri: vscode.Uri; readonly overwrite: boolean } | undefined> {
+		const config = getCopyFileConfiguration(document);
+		const desiredPath = getDesiredNewFilePath(config, document, file);
 
 		const root = Utils.dirname(desiredPath);
 		const ext = path.extname(file.name);
@@ -29,13 +56,20 @@ export class NewFilePathGenerator {
 				continue;
 			}
 
+			// Try overwriting if it already exists
+			if (config.overwriteBehavior === 'overwrite') {
+				this._usedPaths.add(uri.toString());
+				return { uri, overwrite: true };
+			}
+
+			// Otherwise we need to check the fs to see if it exists
 			try {
 				await vscode.workspace.fs.stat(uri);
 			} catch {
 				if (!this._wasPathAlreadyUsed(uri)) {
 					// Does not exist
 					this._usedPaths.add(uri.toString());
-					return uri;
+					return { uri, overwrite: false };
 				}
 			}
 		}
@@ -46,10 +80,9 @@ export class NewFilePathGenerator {
 	}
 }
 
-function getDesiredNewFilePath(document: vscode.TextDocument, file: vscode.DataTransferFile): vscode.Uri {
+function getDesiredNewFilePath(config: CopyFileConfiguration, document: vscode.TextDocument, file: vscode.DataTransferFile): vscode.Uri {
 	const docUri = getParentDocumentUri(document);
-	const config = vscode.workspace.getConfiguration('markdown').get<Record<string, string>>('experimental.copyFiles.destination') ?? {};
-	for (const [rawGlob, rawDest] of Object.entries(config)) {
+	for (const [rawGlob, rawDest] of Object.entries(config.destination)) {
 		for (const glob of parseGlob(rawGlob)) {
 			if (picomatch.isMatch(docUri.path, glob)) {
 				return resolveCopyDestination(docUri, file.name, rawDest, uri => vscode.workspace.getWorkspaceFolder(uri)?.uri);