Merge pull request #672 from fortran-lang:gnikit/issue667

feat: local path resolution

Author: gnikit

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+- Added local path resolution for `fortls`, `findent` and `fprettify` executables
+  ([#667](https://github.com/fortran-lang/vscode-fortran-support/issues/667))
 - Added support for variable resolution in `fortls`
   ([#664](https://github.com/fortran-lang/vscode-fortran-support/issues/664))
 - Added Run and Debug buttons for single Fortran files based on linter settings

src/features/formatting-provider.ts

@@ -13,6 +13,7 @@ import {
   promptForMissingTool,
   getWholeFileRange,
   spawnAsPromise,
+  pathRelToAbs,
 } from '../lib/tools';
 
 export class FortranFormattingProvider implements vscode.DocumentFormattingEditProvider {
@@ -53,7 +54,8 @@ export class FortranFormattingProvider implements vscode.DocumentFormattingEditP
     }
 
     const formatterName = process.platform !== 'win32' ? 'fprettify' : 'fprettify.exe';
-    const formatterPath: string = this.getFormatterPath();
+    const formatterPath: string =
+      this.formatterPath === '' ? '' : pathRelToAbs(this.formatterPath, document.uri);
     const formatter: string = path.join(formatterPath, formatterName);
     // If no formatter is detected try and install it
     if (!which.sync(formatter, { nothrow: true })) {
@@ -78,7 +80,8 @@ export class FortranFormattingProvider implements vscode.DocumentFormattingEditP
    */
   private async doFormatFindent(document: vscode.TextDocument): Promise<vscode.TextEdit[]> {
     const formatterName = process.platform !== 'win32' ? 'findent' : 'findent.exe';
-    const formatterPath: string = this.getFormatterPath();
+    const formatterPath: string =
+      this.formatterPath === '' ? '' : pathRelToAbs(this.formatterPath, document.uri);
     const formatter: string = path.join(formatterPath, formatterName);
     // If no formatter is detected try and install it
     if (!which.sync(formatter, { nothrow: true })) {
@@ -128,7 +131,7 @@ export class FortranFormattingProvider implements vscode.DocumentFormattingEditP
    *
    * @returns {string} path of formatter
    */
-  private getFormatterPath(): string {
+  private get formatterPath(): string {
     const formatterPath: string = this.workspace.get('formatting.path', '');
     if (formatterPath !== '') {
       this.logger.info(`[format] Formatter located in: ${formatterPath}`);

src/lib/tools.ts

@@ -1,4 +1,5 @@
 import * as os from 'os';
+import * as path from 'path';
 import * as vscode from 'vscode';
 import * as assert from 'assert';
 import * as cp from 'child_process';
@@ -76,8 +77,9 @@ export function sortedWorkspaceFolders(): string[] | undefined {
  * @returns outer most workspace folder
  */
 export function getOuterMostWorkspaceFolder(
-  folder: vscode.WorkspaceFolder
-): vscode.WorkspaceFolder {
+  folder: vscode.WorkspaceFolder | undefined
+): vscode.WorkspaceFolder | undefined {
+  if (folder === undefined) return undefined;
   const sorted = sortedWorkspaceFolders();
   for (const element of sorted) {
     let uri = folder.uri.toString();
@@ -262,6 +264,22 @@ export function resolveVariables(
   // return new Promise<string>((resolve) => { resolve(ret) });
 }
 
+/**
+ * Resolves a path relative to the workspace folder, an optional `uri`
+ * can be provided to help retrieve the correct workspace folder when working
+ * with multi-root workspaces, else the first workspace folder is used.
+ *
+ * @param relPath relative path to resolve against the workspace folder
+ * @param uri optional uri of a file/folder within the workspace folder
+ * usefull when using multiroot workspaces to pick the right workspace root
+ * @returns absolute path relative to the workspace root
+ */
+export function pathRelToAbs(relPath: string, uri: vscode.Uri): string | undefined {
+  const root = getOuterMostWorkspaceFolder(vscode.workspace.getWorkspaceFolder(uri));
+  if (root === undefined) return undefined;
+  return path.join(root.uri.fsPath, relPath);
+}
+
 export function getWholeFileRange(document: vscode.TextDocument): vscode.Range {
   return new vscode.Range(0, 0, document.lineCount, 0);
 }

src/lsp/client.ts

@@ -13,6 +13,7 @@ import {
   getOuterMostWorkspaceFolder,
   pipInstall,
   resolveVariables,
+  pathRelToAbs,
 } from '../lib/tools';
 import { Logger } from '../services/logging';
 import { RestartLS } from '../features/commands';
@@ -84,7 +85,8 @@ export class FortlsClient {
 
     const args: string[] = await this.fortlsArguments();
     const fortlsPath = workspace.getConfiguration(EXTENSION_ID).get<string>('fortls.path');
-    const executablePath = resolveVariables(fortlsPath);
+    let executablePath = resolveVariables(fortlsPath);
+    if (fortlsPath !== 'fortls') executablePath = pathRelToAbs(fortlsPath, document.uri);
 
     // Detect language server version and verify selected options
     this.version = this.getLSVersion(executablePath, args);
@@ -306,7 +308,14 @@ export class FortlsClient {
    */
   private async fortlsDownload(): Promise<boolean> {
     const config = workspace.getConfiguration(EXTENSION_ID);
-    const ls = resolveVariables(config.get<string>('fortls.path'));
+    let ls = resolveVariables(config.get<string>('fortls.path'));
+    // The path can be resolved as a relative path if it's part of a workspace
+    // AND it does not have the default value `fortls` or is an absolute path
+    if (workspace.workspaceFolders == undefined && ls !== 'fortls' && !path.isAbsolute(ls)) {
+      const root = workspace.workspaceFolders[0];
+      this.logger.debug(`[lsp.client] Assuming relative fortls path is to ${root.uri.fsPath}`);
+      ls = pathRelToAbs(ls, root.uri);
+    }
 
     // Check for version, if this fails fortls provided is invalid
     const results = spawnSync(ls, ['--version']);

test/tools.test.ts

@@ -1,6 +1,7 @@
 import * as path from 'path';
 import * as assert from 'assert';
-import { shellTask, spawnAsPromise } from '../src/lib/tools';
+import { Uri } from 'vscode';
+import { shellTask, spawnAsPromise, pathRelToAbs } from '../src/lib/tools';
 
 suite('Tools tests', () => {
   test('shellTask returns correct output', async () => {
@@ -49,4 +50,17 @@ suite('Tools tests', () => {
     assert.strictEqual(stdout, 'Hello World!');
     assert.strictEqual(stderr, 'Errors');
   });
+
+  test('Resolve local paths: undefined', () => {
+    const root = Uri.parse('/home/user/project');
+    const absPath = pathRelToAbs('./sample.f90', root);
+    console.log(absPath, root);
+    assert.strictEqual(absPath, undefined);
+  });
+
+  test('Resolve local paths: workspace selection', () => {
+    const root = Uri.parse(path.resolve(__dirname, '../../test/fortran'));
+    const absPath = pathRelToAbs('./sample.f90', root);
+    assert.strictEqual(absPath, path.resolve(__dirname, '../../test/fortran/sample.f90'));
+  });
 });