Changes the extension interface

and adds support for gfortran and ifort compilers

Fixes Rewrite settings interface #292
Fixes Add support for Intel and LLVM compilers #291
Fixes gfortran linter regex cannot display certain failures #295

Author: gnikit

CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [3.0.0]
+
+### Fixed
+
+- Fixes linting regex to capture a wider spectrum of errors
+  ([#295](https://github.com/krvajal/vscode-fortran-support/issues/295))
+
+### Changed
+
+- Changes the interface of the extension to accommodate for the newest features
+  ([#292](https://github.com/krvajal/vscode-fortran-support/issues/292))
+
+### Added
+
+- Adds support for Intel (ifort) and LLVM (flang) compilers
+  ([#291](https://github.com/krvajal/vscode-fortran-support/issues/291))
+- Adds native support for the fortran-language-server (`fortls`) making
+  unnecessary the usage of Fortran Intellisense extension
+  ([#290](https://github.com/krvajal/vscode-fortran-support/issues/290))
+
 ## [2.6.1]
 
 ### Fixed

README.md

@@ -25,6 +25,7 @@
 
 You can control the include paths to be used by the linter with the `fortran.linter.includePaths` setting.
 The `linter.includePaths` should match the include requirements for your projects compilation.
+
 > NOTE: if a glob pattern is used only directories matching the pattern will be included.
 
 ```jsonc

package-lock.json

@@ -2,7 +2,7 @@
   "name": "linter-gfortran",
   "displayName": "Modern Fortran",
   "description": "Modern Fortran language support, including syntax highlighting and error detection.",
-  "version": "2.6.1",
+  "version": "3.0.0",
   "publisher": "krvajalm",
   "license": "MIT",
   "author": {
@@ -128,42 +128,78 @@
       "type": "object",
       "title": "Fortran configuration",
       "properties": {
-        "fortran.includePaths": {
+        "fortran.provide.hover": {
+          "type": "string",
+          "default": "fortls",
+          "enum": [
+            "fortls",
+            "Built-in",
+            "Both",
+            "Disabled"
+          ],
+          "description": "Enables hover support, by default it uses fortran-language-server."
+        },
+        "fortran.provide.autocomplete": {
+          "type": "string",
+          "default": "fortls",
+          "enum": [
+            "fortls",
+            "Built-in",
+            "Both",
+            "Disabled"
+          ],
+          "description": "Enables code autocompletion, by default it uses fortran-language-server."
+        },
+        "fortran.provide.symbols": {
+          "type": "string",
+          "default": "fortls",
+          "enum": [
+            "fortls",
+            "Built-in",
+            "Both",
+            "Disabled"
+          ],
+          "description": "Outline of type members in the document, by default it uses fortran-language-server."
+        },
+        "fortran.linter.compiler": {
+          "type": "string",
+          "default": "gfortran",
+          "enum": [
+            "gfortran",
+            "flang",
+            "ifort",
+            "Disabled"
+          ],
+          "description": "Compiler used for linting support."
+        },
+        "fortran.linter.includePaths": {
           "type": [
             "array"
           ],
           "items": {
             "type": "string"
           },
           "default": [],
-          "description": "Specifies folder paths to be used as include path for the Fortran linter"
+          "description": "Specifies folder paths to be used as include paths during linting. Can resolve glob patterns e.g. `/usr/local/include/**` and internal variables with `~`, `${workspaceFolder}`, `${env}`, `${config}`, `${file}`, `${fileDirname}`, `${fileBasenameNoExtension}`"
         },
-        "fortran.gfortranExecutable": {
+        "fortran.linter.compilerPath": {
           "type": "string",
-          "default": "gfortran",
-          "description": "Specifies the complete path of the gfortran executable"
-        },
-        "fortran.linterEnabled": {
-          "type": "boolean",
-          "default": true,
-          "description": "Enables or disables the linter functionality"
+          "default": "",
+          "description": "Specifies the path to the linter executable."
         },
-        "fortran.linterExtraArgs": {
+        "fortran.linter.extraArgs": {
           "type": [
             "array"
           ],
           "items": {
             "type": "string"
           },
-          "default": [
-            "-Wall"
-          ],
-          "description": "Specify additional options to use when calling the gfortran compiler"
+          "description": "Pass additional options to the linter compiler.  Can resolve internal variables with `~`, `${workspaceFolder}`, `${env}`, `${config}`, `${file}`, `${fileDirname}`, `${fileBasenameNoExtension}`"
         },
-        "fortran.linterModOutput": {
+        "fortran.linter.modOutput": {
           "type": "string",
           "default": "",
-          "description": "Global output directory for .mod files `-J<linterModOutput>`"
+          "description": "Global output directory for .mod files generated due to linting `-J<linter.modOutput>`. Can resolve internal variables with `~`, `${workspaceFolder}`, `${env}`, `${config}`, `${file}`, `${fileDirname}`, `${fileBasenameNoExtension}`"
         },
         "fortran.formatting.formatter": {
           "type": "string",
@@ -183,35 +219,52 @@
         "fortran.formatting.path": {
           "type": "string",
           "default": "",
-          "description": "Specify the full path of where the formatter is installed"
+          "description": "If the formatter is not in the $PATH specify the full path to its location."
         },
-        "fortran.provideSymbols": {
+        "fortran.fortls.path": {
+          "type": "string",
+          "default": "fortls",
+          "description": "Path to the Fortran language server (fortls)."
+        },
+        "fortran.fortls.preserveKeywordOrder": {
           "type": "boolean",
           "default": true,
-          "description": "Enables or disables symbol functionality (disable if using 'Fortran IntelliSense')"
+          "description": "Display variable keywords information when hovering in original order (default: sort to consistent ordering)."
         },
-        "fortran.symbols": {
+        "fortran.fortls.disableDiagnostics": {
+          "type": "boolean",
+          "default": false,
+          "description": "Disable diagnostics (requires v1.12.0+)."
+        },
+        "fortran.fortls.incrementalSync": {
+          "type": "boolean",
+          "default": true,
+          "description": "Use incremental synchronization for file changes."
+        },
+        "fortran.fortls.notifyInit": {
+          "type": "boolean",
+          "default": false,
+          "description": "Notify when workspace initialization is complete (requires v1.7.0+)."
+        },
+        "fortran.fortls.extraArgs": {
           "type": [
             "array"
           ],
           "items": {
             "type": "string"
           },
-          "default": [
-            "function",
-            "subroutine"
-          ],
-          "description": "Specify what kind of symbols should be shown by the symbols' provider"
+          "default": [],
+          "description": "Additional arguments for the fortran-language-server"
         },
-        "fortran.provideHover": {
-          "type": "boolean",
-          "default": true,
-          "description": "Enables hover functionality (disable if using 'Fortran IntelliSense')"
+        "fortran.maxLineLength": {
+          "type": "number",
+          "default": -1,
+          "description": "Maximum line length (fortls requires v1.8.0+). Passed in both the linter and the language server."
         },
-        "fortran.provideCompletion": {
-          "type": "boolean",
-          "default": true,
-          "description": "Enables or disables completion functionality (disable if using 'Fortran IntelliSense')"
+        "fortran.maxCommentLineLength": {
+          "type": "number",
+          "default": -1,
+          "description": "Maximum comment line length (fortls requires v1.8.0+). Passed in both the linter and the language server."
         },
         "fortran.preferredCase": {
           "type": "string",
@@ -220,7 +273,34 @@
             "lowercase",
             "uppercase"
           ],
-          "description": "Specify the word case to use when suggesting autocomplete options (One of 'lowercase' or 'upercase')"
+          "description": "Specify the word case to use when suggesting autocomplete options."
+        },
+        "fortran.includePaths": {
+          "deprecationMessage": "fortran.includePaths has been renamed to fortran.linter.includePaths."
+        },
+        "fortran.gfortranExecutable": {
+          "deprecationMessage": "fortran.gfortranExecutable has been renamed to fortran.linter.compilerPath"
+        },
+        "fortran.linterEnabled": {
+          "deprecationMessage": "fortran.linterEnabled has been renamed to fortran.linter.compiler set to Disable to turn off."
+        },
+        "fortran.linterExtraArgs": {
+          "deprecationMessage": "fortran.linterExtraArgs has been renamed to fortran.linter.extraArgs"
+        },
+        "fortran.linterModOutput": {
+          "deprecationMessage": "fortran.linterModOutput has been renamed to fortran.linter.modOutput."
+        },
+        "fortran.provideSymbols": {
+          "deprecationMessage": "fortran.provideSymbols has been renamed to fortran.provide.symbols. By default the fortran-language-server symbols are used, to enable the built-in symbols turn on the Built-in option."
+        },
+        "fortran.symbols": {
+          "deprecationMessage": "fortran.symbols has been removed in favour of returning all symbols."
+        },
+        "fortran.provideHover": {
+          "deprecationMessage": "fortran.provideHover has been renamed to fortran.provide.hover. By default the fortran-language-server hover is used, to enable the built-in hover turn on the Built-in option."
+        },
+        "fortran.provideCompletion": {
+          "deprecationMessage": "fortran.provideCompletion has been renamed to fortran.provide.autocomplete. By default the fortran-language-server autocompletion is used, to enable the built-in autocompletion turn on the Built-in option."
         }
       }
     },

package.json

@@ -2,7 +2,7 @@
 import * as which from 'which';
 import * as vscode from 'vscode';
 
-import FortranLintingProvider from './features/linter-provider';
+import { FortranLintingProvider } from './features/linter-provider';
 import FortranHoverProvider from './features/hover-provider';
 import { FortranCompletionProvider } from './features/completion-provider';
 import { FortranDocumentSymbolProvider } from './features/document-symbol-provider';
@@ -11,58 +11,56 @@ import { LoggingService } from './services/logging-service';
 import * as pkg from '../package.json';
 import { LANG_SERVER_TOOL_ID } from './lib/tools';
 import { FortranFormattingProvider } from './features/formatting-provider';
+import { FortranLanguageServer } from './fortls-interface';
 import { EXTENSION_ID, FortranDocumentSelector, promptForMissingTool } from './lib/tools';
 
 // Make it global to catch errors when activation fails
 const loggingService = new LoggingService();
 
 export function activate(context: vscode.ExtensionContext) {
-  const extensionConfig = vscode.workspace.getConfiguration(EXTENSION_ID);
+  const config = vscode.workspace.getConfiguration(EXTENSION_ID);
+  const linterType = config.get<string>('linter.compiler');
+  const formatterType = config.get<string>('formatting.formatter');
+  const autocompleteType = config.get<string>('provide.autocomplete');
+  const hoverType = config.get<string>('provide.hover');
+  const symbolsType = config.get<string>('provide.symbols');
+  detectDeprecatedOptions();
 
   loggingService.logInfo(`Extension Name: ${pkg.displayName}`);
   loggingService.logInfo(`Extension Version: ${pkg.version}`);
+  loggingService.logInfo(`Linter set to: ${linterType}`);
+  loggingService.logInfo(`Formatter set to: ${formatterType}`);
+  loggingService.logInfo(`Autocomplete set to: ${autocompleteType}`);
+  loggingService.logInfo(`Hover set to: ${hoverType}`);
+  loggingService.logInfo(`Symbols set to: ${symbolsType}`);
 
-  if (extensionConfig.get('linterEnabled', true)) {
+  if (linterType !== 'Disabled') {
     const linter = new FortranLintingProvider(loggingService);
     linter.activate(context.subscriptions);
     vscode.languages.registerCodeActionsProvider(FortranDocumentSelector(), linter);
-    loggingService.logInfo('Linter is enabled');
-  } else {
-    loggingService.logInfo('Linter is not enabled');
   }
 
-  if (extensionConfig.get('formatter') !== 'Disabled') {
+  if (formatterType !== 'Disabled') {
     const disposable: vscode.Disposable = vscode.languages.registerDocumentFormattingEditProvider(
       FortranDocumentSelector(),
       new FortranFormattingProvider(loggingService)
     );
     context.subscriptions.push(disposable);
-    loggingService.logInfo('Formatting is enabled');
-  } else {
-    loggingService.logInfo('Formatting is disabled');
   }
 
-  if (extensionConfig.get('provideCompletion', true)) {
+  if (autocompleteType === 'Built-in') {
     const completionProvider = new FortranCompletionProvider(loggingService);
     vscode.languages.registerCompletionItemProvider(FortranDocumentSelector(), completionProvider);
-  } else {
-    loggingService.logInfo('Completion Provider is not enabled');
   }
 
-  if (extensionConfig.get('provideHover', true)) {
+  if (hoverType === 'Built-in') {
     const hoverProvider = new FortranHoverProvider(loggingService);
     vscode.languages.registerHoverProvider(FortranDocumentSelector(), hoverProvider);
-    loggingService.logInfo('Hover Provider is enabled');
-  } else {
-    loggingService.logInfo('Hover Provider is not enabled');
   }
 
-  if (extensionConfig.get('provideSymbols', true)) {
+  if (symbolsType === 'Built-in') {
     const symbolProvider = new FortranDocumentSymbolProvider();
     vscode.languages.registerDocumentSymbolProvider(FortranDocumentSelector(), symbolProvider);
-    loggingService.logInfo('Symbol Provider is enabled');
-  } else {
-    loggingService.logInfo('Symbol Provider is not enabled');
   }
 
   // Check if the language server is installed and if not prompt to install it
@@ -73,4 +71,32 @@ export function activate(context: vscode.ExtensionContext) {
               https://github.com/hansec/fortran-language-server`;
     promptForMissingTool(LANG_SERVER_TOOL_ID, msg, 'Python', loggingService);
   }
+
+  // Spawn the fortran-language-server
+  const fortls = new FortranLanguageServer(loggingService);
+  fortls.activate(context.subscriptions);
+}
+
+function detectDeprecatedOptions() {
+  const config = vscode.workspace.getConfiguration(EXTENSION_ID);
+  const oldArgs: string[] = [];
+  if (config.get('includePaths')) oldArgs.push('fortran.includePaths');
+  if (config.get('gfortranExecutable')) oldArgs.push('fortran.gfortranExecutable');
+  if (config.get('linterEnabled')) oldArgs.push('fortran.linterEnabled');
+  if (config.get('linterExtraArgs')) oldArgs.push('fortran.linterExtraArgs');
+  if (config.get('linterModOutput')) oldArgs.push('fortran.linterModOutput');
+  if (config.get('symbols')) oldArgs.push('fortran.symbols');
+  if (config.get('provideSymbols')) oldArgs.push('fortran.provideSymbols');
+  if (config.get('provideHover')) oldArgs.push('fortran.provideHover');
+  if (config.get('provideCompletion')) oldArgs.push('fortran.provideCompletion');
+
+  if (oldArgs.length !== 0) {
+    const err = vscode.window.showErrorMessage(
+      `Deprecated settings have been detected in your settings.
+       Please update your settings to make use of the new names. The old names will not work.`,
+      'Open Settings'
+    );
+    err.then(() => vscode.commands.executeCommand('workbench.action.openGlobalSettings'));
+    loggingService.logError(`The following deprecated options have been detected:\n${oldArgs}`);
+  }
 }

src/extension.ts

@@ -99,7 +99,8 @@ export class FortranDocumentSymbolProvider implements vscode.DocumentSymbolProvi
 
   getSymbolTypes() {
     const config = vscode.workspace.getConfiguration('fortran');
-    const symbolTypes = config.get<SymbolType[]>('symbols', ['subroutine', 'function']);
+    // It does not make much sense for this to be an input option
+    const symbolTypes: SymbolType[] = ['subroutine', 'function', 'variable'];
     return symbolTypes;
   }
 }