Updates install tools.

We now prompt the user to install fortran-language-server and
Fortran IntelliSense if the packages are missing.

There is a slight issue with the calls being asynchronous, so if they are installed
in the wrong order Fortran IntelliSense first and then fortls an error
is being throw.

Author: gnikit

src/extension.ts

@@ -7,10 +7,11 @@ import FortranHoverProvider from './features/hover-provider'
 import { FortranCompletionProvider } from './features/completion-provider'
 import { FortranDocumentSymbolProvider } from './features/document-symbol-provider'
 
-import { FORTRAN_FREE_FORM_ID, EXTENSION_ID } from './lib/helper'
-import { FortranLangServer, checkForLangServer } from './lang-server'
+import { FortranLangServer } from './lang-server'
+import { FORTRAN_FREE_FORM_ID, EXTENSION_ID, promptForMissingTool } from './lib/helper'
 import { LoggingService } from './services/logging-service'
 import * as pkg from '../package.json'
+import { LANG_SERVER_TOOL_ID } from './lib/tools'
 
 export function activate(context: vscode.ExtensionContext) {
   const loggingService = new LoggingService()
@@ -54,6 +55,25 @@ export function activate(context: vscode.ExtensionContext) {
     loggingService.logInfo('Symbol Provider is not enabled')
   }
 
+  // Check if the language server is installed and if not prompt to install it
+  if (!which.sync('fortls', { nothrow: true })) {
+    let msg = `It is highly recommended to use the fortran-language-server to 
+              enable hover, peeking, gotos and many more.
+              For a full list of features the language server adds see:
+              https://github.com/hansec/fortran-language-server`;
+    promptForMissingTool(LANG_SERVER_TOOL_ID, msg, 'Python', loggingService);
+  }
+
+  // Check that Fortran Intellisense is installed and if not prompt to install
+  if (!vscode.extensions.getExtension('hansec.fortran-ls')) {
+    let msg = `It is highly recommended to install the Fortran IntelliSense 
+              extension. The extension is used to interface with the 
+              fortran-language-server.
+              For a full list of features provided by the extension see:
+              https://github.com/hansec/vscode-fortran-ls`;
+    promptForMissingTool('hansec.fortran-ls', msg, 'VSExt', loggingService);
+  }
+
   // Our interface with `fortls` has been disabled in favour of the @hansec's
   // VS Code extension Fortran IntelliSense
   const useInternalFLInterface = false;

src/lib/helper.ts

@@ -1,7 +1,8 @@
 import * as fs from 'fs';
 import * as vscode from 'vscode';
+import { installPythonTool } from './tools';
 import intrinsics from './fortran-intrinsics';
-import { installTool, LANG_SERVER_TOOL_ID } from './tools';
+import { LoggingService } from '../services/logging-service';
 
 // IMPORTANT: this should match the value
 // on the package.json otherwise the extension won't
@@ -109,24 +110,50 @@ export function isPositionInString(
 let saveKeywordToJson = keyword => {
   let doc = _loadDocString(keyword);
   let docObject = JSON.stringify({ keyword: keyword, docstr: doc });
-  fs.appendFile('src/docs/' + keyword + '.json', docObject, function(err) {
+  fs.appendFile('src/docs/' + keyword + '.json', docObject, function (err) {
     if (err) throw err;
     console.log('Saved!');
   });
 };
 
 
-export function promptForMissingTool(tool: string) {
+/**
+ * Install a package either a Python pip package or a VS Marketplace Extension.
+ * 
+ * For the Python install supply the name of the package in PyPi
+ * e.g. fortran-language-server
+ * 
+ * For the VS Extension to be installed supply the id of the extension 
+ * e.g 'hansec.fortran-ls'
+ * 
+ * @param tool name of the tool e.g. fortran-language-server
+ * @param msg optional message for installing said package
+ * @param toolType type of tool, supports `Python` (through pip) and 'VSExt'
+ */
+export function promptForMissingTool(tool: string, msg: string, toolType: string, logger?: LoggingService) {
   const items = ['Install'];
-  let message = '';
-  if (tool === 'fortran-langserver') {
-    message =
-      'You choose to use the fortranLanguageServer functionality but it is not installed. Please press the Install button to install it';
-  }
-  vscode.window.showInformationMessage(message, ...items).then(selected => {
-    if (selected === 'Install') {
-      installTool(tool);
-    }
+  return new Promise((resolve, reject) => {
+    resolve(
+      vscode.window.showInformationMessage(msg, ...items).then(selected => {
+        if (selected === 'Install') {
+          switch (toolType) {
+            case 'Python':
+              installPythonTool(tool, logger);
+              break;
+
+            case 'VSExt':
+              logger.logInfo(`Installing VS Marketplace Extension with id: ${tool}`);
+              vscode.commands.executeCommand('workbench.extensions.installExtension', tool);
+              logger.logInfo(`Extension ${tool} successfully installed`);
+              break;
+
+            default:
+              logger.logError(`Failed to install tool: ${tool}`);
+              break;
+          }
+        }
+      })
+    );
   });
 
 }

src/lib/tools.ts

@@ -1,20 +1,22 @@
-export const LANG_SERVER_TOOL_ID = 'fortran-langserver';
+export const LANG_SERVER_TOOL_ID = 'fortran-language-server';
+export const FORMATTERS = ['Disabled', 'findent', 'fprettify'];
+
 import * as cp from 'child_process';
+import { LoggingService } from '../services/logging-service';
 
+export function installPythonTool(pyPackage: string, logger?: LoggingService) {
 
-export function installTool(toolname) {
-  if (toolname === LANG_SERVER_TOOL_ID) {
-    const installProcess = cp.spawn(
-      'pip',
-      'install --user --upgrade fortran-language-server'.split(' ')
-    );
-    installProcess.on('exit', (code, signal) => {
-      if (code !== 0) {
-        // extension failed to install
-      }
-    });
-    installProcess.on('error', err => {
-      // failed to install
-    });
-  }
+  const installProcess = cp.spawn(
+    'pip',
+    'install --user --upgrade '.concat(pyPackage).split(' ')
+  );
+  installProcess.stdout.on('data', (data) => { logger.logInfo(`pip install: ${data}`) });
+  installProcess.on('exit', (code, signal) => {
+    if (code !== 0) {
+      logger.logError(`Python package ${pyPackage} failed to install with code: ${code}, signal: ${signal}`);
+    }
+  });
+  installProcess.on('error', err => {
+    logger.logError(`${err}`);
+  });
 }