merge some pathMapping options

OPTIONS.md

@@ -20,7 +20,8 @@
   "${workspaceFolder}/**/*.js",
   "!**/node_modules/**"
 ]</pre></code><h4>outputCapture</h4><p>From where to capture output messages: the default debug API if set to <code>console</code>, or stdout/stderr streams if set to <code>std</code>.</p>
-<h5>Default value:</h4><pre><code>"console"</pre></code><h4>pauseForSourceMap</h4><p>Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as <code>rootPath</code> is not disabled.</p>
+<h5>Default value:</h4><pre><code>"console"</pre></code><h4>pathMapping</h4><p>A mapping of folders from one path to another. To resolve scripts to their original locations. Typical use is to map scripts in <code>node_modules</code> to their sources that locate in another folder.</p>
+<h5>Default value:</h4><pre><code>{}</pre></code><h4>pauseForSourceMap</h4><p>Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as <code>rootPath</code> is not disabled.</p>
 <h5>Default value:</h4><pre><code>false</pre></code><h4>port</h4><p>Debug port to attach to. Default is 9229.</p>
 <h5>Default value:</h4><pre><code>9229</pre></code><h4>processId</h4><p>ID of process to attach to.</p>
 <h5>Default value:</h4><pre><code>undefined</pre></code><h4>remoteRoot</h4><p>Absolute path to the remote directory containing the program.</p>
@@ -68,7 +69,8 @@
   "${workspaceFolder}/**/*.js",
   "!**/node_modules/**"
 ]</pre></code><h4>outputCapture</h4><p>From where to capture output messages: the default debug API if set to <code>console</code>, or stdout/stderr streams if set to <code>std</code>.</p>
-<h5>Default value:</h4><pre><code>"console"</pre></code><h4>pauseForSourceMap</h4><p>Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as <code>rootPath</code> is not disabled.</p>
+<h5>Default value:</h4><pre><code>"console"</pre></code><h4>pathMapping</h4><p>A mapping of folders from one path to another. To resolve scripts to their original locations. Typical use is to map scripts in <code>node_modules</code> to their sources that locate in another folder.</p>
+<h5>Default value:</h4><pre><code>{}</pre></code><h4>pauseForSourceMap</h4><p>Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as <code>rootPath</code> is not disabled.</p>
 <h5>Default value:</h4><pre><code>false</pre></code><h4>profileStartup</h4><p>If true, will start profiling as soon as the process launches</p>
 <h5>Default value:</h4><pre><code>false</pre></code><h4>program</h4><p>Absolute path to the program. Generated value is guessed by looking at package.json and opened files. Edit this attribute.</p>
 <h5>Default value:</h4><pre><code>""</pre></code><h4>remoteRoot</h4><p>Absolute path to the remote directory containing the program.</p>
@@ -116,7 +118,8 @@
   "${workspaceFolder}/**/*.js",
   "!**/node_modules/**"
 ]</pre></code><h4>outputCapture</h4><p>From where to capture output messages: the default debug API if set to <code>console</code>, or stdout/stderr streams if set to <code>std</code>.</p>
-<h5>Default value:</h4><pre><code>"console"</pre></code><h4>pauseForSourceMap</h4><p>Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as <code>rootPath</code> is not disabled.</p>
+<h5>Default value:</h4><pre><code>"console"</pre></code><h4>pathMapping</h4><p>A mapping of folders from one path to another. To resolve scripts to their original locations. Typical use is to map scripts in <code>node_modules</code> to their sources that locate in another folder.</p>
+<h5>Default value:</h4><pre><code>{}</pre></code><h4>pauseForSourceMap</h4><p>Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as <code>rootPath</code> is not disabled.</p>
 <h5>Default value:</h4><pre><code>false</pre></code><h4>remoteRoot</h4><p>Absolute path to the remote directory containing the program.</p>
 <h5>Default value:</h4><pre><code>null</pre></code><h4>resolveSourceMapLocations</h4><p>A list of minimatch patterns for locations (folders and URLs) in which source maps can be used to resolve local files. This can be used to avoid incorrectly breaking in external source mapped code. Patterns can be prefixed with &quot;!&quot; to exclude them. May be set to an empty array or null to avoid restriction.</p>
 <h5>Default value:</h4><pre><code>[
@@ -162,7 +165,8 @@
 <h5>Default value:</h4><pre><code>[
   "${workspaceFolder}/out/**/*.js"
 ]</pre></code><h4>outputCapture</h4><p>From where to capture output messages: the default debug API if set to <code>console</code>, or stdout/stderr streams if set to <code>std</code>.</p>
-<h5>Default value:</h4><pre><code>"console"</pre></code><h4>pauseForSourceMap</h4><p>Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as <code>rootPath</code> is not disabled.</p>
+<h5>Default value:</h4><pre><code>"console"</pre></code><h4>pathMapping</h4><p>A mapping of folders from one path to another. To resolve scripts to their original locations. Typical use is to map scripts in <code>node_modules</code> to their sources that locate in another folder.</p>
+<h5>Default value:</h4><pre><code>{}</pre></code><h4>pauseForSourceMap</h4><p>Whether to wait for source maps to load for each incoming script. This has a performance overhead, and might be safely disabled when running off of disk, so long as <code>rootPath</code> is not disabled.</p>
 <h5>Default value:</h4><pre><code>false</pre></code><h4>remoteRoot</h4><p>Absolute path to the remote directory containing the program.</p>
 <h5>Default value:</h4><pre><code>null</pre></code><h4>rendererDebugOptions</h4><p>Chrome launch options used when attaching to the renderer process, with <code>debugWebviews</code> or <code>debugWebWorkerHost</code>.</p>
 <h5>Default value:</h4><pre><code>{}</pre></code><h4>resolveSourceMapLocations</h4><p>A list of minimatch patterns for locations (folders and URLs) in which source maps can be used to resolve local files. This can be used to avoid incorrectly breaking in external source mapped code. Patterns can be prefixed with &quot;!&quot; to exclude them. May be set to an empty array or null to avoid restriction.</p>

src/build/generate-contributions.ts

@@ -298,6 +298,12 @@ const baseConfigurationAttributes: ConfigurationAttributes<IBaseConfiguration> =
     default: [],
     description: refString('base.cascadeTerminateToConfigurations.label'),
   },
+  pathMapping: {
+    type: 'object',
+    additionalProperties: { type: 'string' },
+    description: refString('browser.pathMapping.description'),
+    default: {},
+  },
 };
 
 /**
@@ -358,12 +364,8 @@ const nodeBaseConfigurationAttributes: ConfigurationAttributes<INodeBaseConfigur
     default: 12,
   },
   pathMapping: {
-    type: 'object',
-    items: {
-      type: 'string',
-    },
+    ...baseConfigurationAttributes.pathMapping,
     markdownDescription: refString('node.pathMapping.description'),
-    default: {},
   },
 };
 
@@ -687,9 +689,8 @@ const chromiumBaseConfigurationAttributes: ConfigurationAttributes<IChromiumBase
     default: true,
   },
   pathMapping: {
-    type: 'object',
+    ...baseConfigurationAttributes.pathMapping,
     description: refString('browser.pathMapping.description'),
-    default: {},
   },
   webRoot: {
     type: 'string',

src/configuration.ts

@@ -207,6 +207,14 @@ export interface IBaseConfiguration extends IMandatedConfiguration {
    * e.g.: "function () { return {...this, extraProperty: 'otherProperty' } }"
    */
   customPropertiesGenerator?: string;
+
+  /**
+   * A mapping of folder paths. In the context of Chrome, these are "path"
+   * portions of the URL to absolute paths on disk. In the context of
+   * Node.js, they are mappings from absolute paths to other absolute paths,
+   * which is useful when debugging hard linked files.
+   */
+  pathMapping: PathMapping;
 }
 
 export interface IExtensionHostBaseConfiguration extends INodeBaseConfiguration {
@@ -322,13 +330,6 @@ export interface INodeBaseConfiguration extends IBaseConfiguration, IConfigurati
    * with `--inpect-brk`.
    */
   continueOnAttach?: boolean;
-
-  /**
-   * A mapping of folders from one path to another. To resolve scripts to their
-   * original locations. Typical use is to map scripts in `node_modules` to their
-   * sources that locate in another folder.
-   */
-  pathMapping: PathMapping;
 }
 
 export interface IConfigurationWithEnv {
@@ -450,12 +451,6 @@ export interface IChromiumBaseConfiguration extends IBaseConfiguration {
    */
   disableNetworkCache: boolean;
 
-  /**
-   * A mapping of URLs/paths to local folders, to resolve scripts
-   * in Chrome to scripts on disk
-   */
-  pathMapping: PathMapping;
-
   /**
    * This specifies the workspace absolute path to the webserver root. Used to
    * resolve paths like `/app.js` to files on disk. Shorthand for a pathMapping for "/".
@@ -819,6 +814,7 @@ export const baseDefaults: IBaseConfiguration = {
   sourceMapPathOverrides: defaultSourceMapPathOverrides('${workspaceFolder}'),
   enableContentValidation: true,
   cascadeTerminateToConfigurations: [],
+  pathMapping: {},
   // Should always be determined upstream;
   __workspaceFolder: '',
   __autoExpandGetters: false,
@@ -840,7 +836,6 @@ const nodeBaseDefaults: INodeBaseConfiguration = {
   resolveSourceMapLocations: ['**', '!**/node_modules/**'],
   autoAttachChildProcesses: true,
   runtimeSourcemapPausePatterns: [],
-  pathMapping: {},
 };
 
 export const terminalBaseDefaults: ITerminalLaunchConfiguration = {
@@ -892,7 +887,6 @@ export const nodeLaunchConfigDefaults: INodeLaunchConfiguration = {
   profileStartup: false,
   attachSimplePort: null,
   killBehavior: KillBehavior.Forceful,
-  pathMapping: {},
 };
 
 export const chromeAttachConfigDefaults: IChromeAttachConfiguration = {
@@ -902,7 +896,6 @@ export const chromeAttachConfigDefaults: IChromeAttachConfiguration = {
   address: 'localhost',
   port: 0,
   disableNetworkCache: true,
-  pathMapping: {},
   url: null,
   restart: false,
   urlFilter: '',
@@ -1077,6 +1070,10 @@ export function removeOptionalWorkspaceFolderUsages<T extends AnyLaunchConfigura
       cast.resolveSourceMapLocations?.filter(o => !o.includes(token)) ?? null;
   }
 
+  if ('pathMapping' in cast) {
+    cast.pathMapping = filterValues(cast.pathMapping, v => v.includes(token));
+  }
+
   if ('cwd' in cast && cast.cwd?.includes(token)) {
     cast.cwd = undefined;
   }

src/targets/browser/browserPathResolver.ts

@@ -23,12 +23,10 @@ import {
 import { IUrlResolution } from '../../common/sourcePathResolver';
 import * as utils from '../../common/urlUtils';
 import { urlToRegex } from '../../common/urlUtils';
-import { PathMapping } from '../../configuration';
 import { ISourcePathResolverOptions, SourcePathResolverBase } from '../sourcePathResolver';
 
 export interface IOptions extends ISourcePathResolverOptions {
   baseUrl?: string;
-  pathMapping: PathMapping;
   clientID: string | undefined;
   remoteFilePrefix: string | undefined;
 }

src/targets/node/nodeSourcePathResolver.ts

@@ -16,13 +16,12 @@ import {
 } from '../../common/sourceMaps/sourceMapResolutionUtils';
 import { IUrlResolution } from '../../common/sourcePathResolver';
 import * as urlUtils from '../../common/urlUtils';
-import { AnyLaunchConfiguration, AnyNodeConfiguration, PathMapping } from '../../configuration';
+import { AnyLaunchConfiguration, AnyNodeConfiguration } from '../../configuration';
 import { ILinkedBreakpointLocation } from '../../ui/linkedBreakpointLocation';
 import { ISourcePathResolverOptions, SourcePathResolverBase } from '../sourcePathResolver';
 
 interface IOptions extends ISourcePathResolverOptions {
   basePath?: string;
-  pathMapping: PathMapping;
 }
 
 const localNodeInternalsPrefix = 'node:';

src/targets/sourcePathResolver.ts

@@ -25,9 +25,11 @@ import {
   urlToRegex,
 } from '../common/urlUtils';
 import { SourceMapOverrides } from './sourceMapOverrides';
+import { PathMapping } from '../configuration';
 
 export interface ISourcePathResolverOptions {
   resolveSourceMapLocations: ReadonlyArray<string> | null;
+  pathMapping: PathMapping;
   sourceMapOverrides: { [key: string]: string };
   localRoot: string | null;
   remoteRoot: string | null;