Merge pull request #67 from Aleksandaar/feat_display_workspace_folder…

…_option

Add new config option for displaying workspace name

README.md

@@ -38,6 +38,7 @@ For optimal performance, ensure that the VSCode configuration _Editor: Enable Pr
 - `rgMenuActions`: Create menu items which can be selected prior to any query, these items will be added to the ripgrep command to generate the results. Eg: Add `{ "label": "JS/TS", "value": "--type-add 'jsts:*.{js|ts|tsx|jsx}' -t jsts" },` as a menu option to only show js & ts files in the results.
 - `rgQueryParams`: Match ripgrep parameters from the input query directly. E.g: `{ "regex": \"^(.+) -t ?(\\w+)$\", "param": \"-t $1\" },` will translate the query `hello -t rust` to `rg 'hello' -t rust` to enable a filetype filter.
 - `rgQueryParamsShowTitle`: When a ripgrep parameter match from the list in `rgQueryParams`, the quick pick will show the matched result as a preview in the title bar.
+- `showWorkspaceFolderInFilePath`: Include workspace folder name in the folder depth display.
 - `startFolderDisplayIndex`: The folder index to display in the results before '...'.
 - `startFolderDisplayDepth`: The folder depth to display in the results before '...'.
 - `endFolderDisplayDepth`: The folder depth to display in the results after '...'.

package.json

@@ -139,6 +139,11 @@
           "default": 4,
           "description": "The folder depth to display in the results after truncating with '...'."
         },
+        "periscope.showWorkspaceFolderInFilePath": {
+          "type": "boolean",
+          "default": true,
+          "description": "Include workspace folder name in the folder depth display."
+        },
         "periscope.alwaysShowRgMenuActions": {
           "type": "boolean",
           "default": true,

src/utils/formatPathLabel.ts

@@ -21,8 +21,16 @@ export function formatPathLabel(filePath: string) {
     workspaceFolders.find((folder) => filePath.startsWith(folder.uri.fsPath)) || workspaceFolders[0];
 
   const workspaceFolderName = workspaceFolder.name;
-  const relativeFilePath = path.relative(workspaceFolder.uri.fsPath, filePath);
-  const folders = [workspaceFolderName, ...relativeFilePath.split(path.sep)];
+  let relativeFilePath;
+  let folders;
+
+  if (config.showWorkspaceFolderInFilePath) {
+    relativeFilePath = path.relative(workspaceFolder.uri.fsPath, filePath);
+    folders = [workspaceFolderName, ...relativeFilePath.split(path.sep)];
+  } else {
+    relativeFilePath = path.relative(workspaceFolder.uri.fsPath, filePath).replace(/(\.\.\/)+/, '');
+    folders = [...relativeFilePath.split(path.sep)];
+  }
 
   // abbreviate path if too long
   if (folders.length > config.startFolderDisplayDepth + config.endFolderDisplayDepth) {

src/utils/getConfig.ts

@@ -9,6 +9,7 @@ type ConfigItems =
   | 'rgQueryParams'
   | 'rgQueryParamsShowTitle'
   | 'rgPath'
+  | 'showWorkspaceFolderInFilePath'
   | 'startFolderDisplayDepth'
   | 'startFolderDisplayIndex'
   | 'endFolderDisplayDepth'
@@ -32,6 +33,7 @@ export function getConfig() {
     rgQueryParams: vsConfig.get<{ param?: string; regex: string }[]>('rgQueryParams', []),
     rgQueryParamsShowTitle: vsConfig.get<boolean>('rgQueryParamsShowTitle', true),
     rgPath: vsConfig.get<string | undefined>('rgPath', undefined),
+    showWorkspaceFolderInFilePath: vsConfig.get<boolean>('showWorkspaceFolderInFilePath', true),
     startFolderDisplayIndex: vsConfig.get<number>('startFolderDisplayIndex', 0),
     startFolderDisplayDepth: vsConfig.get<number>('startFolderDisplayDepth', 1),
     endFolderDisplayDepth: vsConfig.get<number>('endFolderDisplayDepth', 4),