feat(mapping): add support for workspaceFolder placeholders

README.md

@@ -122,14 +122,14 @@ Define custom mappings which can be useful for using absolute paths or in combin
 ```javascript
 {
 	"path-intellisense.mappings": {
-		"/": "${workspaceRoot}",
-		"lib": "${workspaceRoot}/lib",
+		"/": "${workspaceFolder}",
+		"lib": "${workspaceFolder}/lib",
 		"global": "/Users/dummy/globalLibs"
 	},
 }
 ```
 
-Use \${workspaceRoot} when the path should be relative to the current root of the current project.
+Use \${workspaceFolder} when the path should be relative to the current root of the current project. V2.2.1 and lower used \${workspaceRoot}. Newer version support both placeholders.
 
 ## History
 

src/configuration/configuration.service.ts

@@ -1,7 +1,7 @@
 import * as vscode from "vscode";
 import { Config, Mapping } from "./configuration.interface";
 import { getWorkfolderTsConfigConfiguration } from "./tsconfig.service";
-import { parseMappings, replaceWorkspaceRoot } from "./mapping.service";
+import { parseMappings, replaceWorkspaceFolder } from "./mapping.service";
 
 export async function getConfiguration(
   resource: vscode.Uri
@@ -32,5 +32,5 @@ async function getMappings(
   const mappings = parseMappings(configuration["mappings"]);
   const tsConfigMappings = await getWorkfolderTsConfigConfiguration(workfolder);
   const allMappings = [...mappings, ...tsConfigMappings];
-  return replaceWorkspaceRoot(allMappings, workfolder);
+  return replaceWorkspaceFolder(allMappings, workfolder);
 }

src/configuration/mapping.service.ts

@@ -15,20 +15,40 @@ export function parseMappings(mappings: { [key: string]: string }): Mapping[] {
  * @param mappings
  * @param workfolder
  */
-export function replaceWorkspaceRoot(
+export function replaceWorkspaceFolder(
   mappings: Mapping[],
   workfolder?: vscode.WorkspaceFolder
 ): Mapping[] {
   const rootPath = workfolder?.uri.path;
 
   if (rootPath) {
+    /** Replace placeholder with workspace folder */
     return mappings.map(({ key, value }) => ({
       key,
-      value: value.replace("${workspaceRoot}", rootPath),
+      value: replaceWorkspaceFolder(value, rootPath),
     }));
   } else {
-    return mappings.filter(
-      ({ value }) => value.indexOf("${workspaceRoot}") === -1
-    );
+    /** Filter items out which contain a workspace root */
+    return mappings.filter(({ value }) => !valueContainsWorkspaceFolder(value));
   }
 }
+
+/**
+ * Replaces both placeholders with the rootpath
+ * - ${workspaceRoot}    // old way and only legacy support
+ * - ${workspaceFolder}  // new way
+ * @param value
+ * @param rootPath
+ */
+function replaceWorkspaceFolder(value: string, rootPath: string) {
+  return value
+    .replace("${workspaceRoot}", rootPath)
+    .replace("${workspaceFolder}", rootPath);
+}
+
+function valueContainsWorkspaceFolder(value: string): boolean {
+  return (
+    value.indexOf("${workspaceRoot}") >= 0 ||
+    value.indexOf("${workspaceFolder}") >= 0
+  );
+}

src/configuration/tsconfig.service.ts

@@ -42,7 +42,7 @@ function createMappingsFromWorkspaceConfig(tsconfig: {
     mappings.push({
       key: baseUrl,
       // value: `${workfolder.uri.path}/${baseUrl}`
-      value: "${workspaceRoot}/" + baseUrl,
+      value: "${workspaceFolder}/" + baseUrl,
     });
   }
 

src/test/demo-workspace/demo.code-workspace

@@ -14,7 +14,7 @@
     "path-intellisense.absolutePathToWorkspace": true,
     "path-intellisense.extensionOnImport": true,
     "path-intellisense.mappings": {
-      "lib": "${workspaceRoot}/lib"
+      "lib": "${workspaceFolder}/lib"
     }
   }
 }