Merge pull request #683 from fortran-lang/gnikit/issue680

feat: initialise linter for projects

Author: gnikit

CHANGELOG.md

@@ -9,6 +9,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Added
 
+- Added new settings for disabling Linter initialization and display of initialization Diagnostics
+  `fortran.linter.initialize` and `fortran.experimental.keepInitDiagnostics`
+- Added commands for Initializing, Cleaning build artefacts and Clearing the Diagnostics from the Linter
+- Added support for storing build artefacts in a separate cache directory
+  ([#614](https://github.com/fortran-lang/vscode-fortran-support/issues/614))
+- Added a naive initialization for Fortran source files present in the workspace.
+  The implementation cannot deduce build order so it can partially work
+  ([#680](https://github.com/fortran-lang/vscode-fortran-support/issues/680))
 - Added User Interface tests for program installation
 - Added option to disable Release Notes from being displayed
   ([#675](https://github.com/fortran-lang/vscode-fortran-support/issues/675))
@@ -38,6 +46,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 
+- Changed the activation events of the extension to include the `onCommand` for all register commands
 - Changed glob resolution module to `glob` from `fast-glob` due to bug #43
   ([#681](https://github.com/fortran-lang/vscode-fortran-support/issues/681))
 - Changed how Python packages are installed for unittesting for performance

package.json

@@ -52,7 +52,15 @@
   },
   "activationEvents": [
     "onLanguage:FortranFreeForm",
-    "onLanguage:FortranFixedForm"
+    "onLanguage:FortranFixedForm",
+    "onCommand:fortran.analysis.restartLanguageServer",
+    "onCommand:fortran.analysis.rescanLinter",
+    "onCommand:fortran.analysis.cleanLinterDiagnostics",
+    "onCommand:fortran.analysis.cleanLinterFiles",
+    "onCommand:fortran.analysis.initLinter",
+    "onCommand:fortran.analysis.showWhatsNew",
+    "onCommand:fortran.build.run",
+    "onCommand:fortran.build.debug"
   ],
   "main": "./dist/extension.js",
   "extensionDependencies": [
@@ -231,6 +239,12 @@
             "markdownDescription": "Compiler used for linting support.",
             "order": 0
           },
+          "fortran.linter.initialize": {
+            "type": "boolean",
+            "default": true,
+            "markdownDescription": "Attempt to initialize the linter by mock-compiling all files in the workspace.",
+            "order": 5
+          },
           "fortran.linter.compilerPath": {
             "type": "string",
             "default": "",
@@ -257,7 +271,7 @@
           "fortran.linter.modOutput": {
             "type": "string",
             "default": "",
-            "markdownDescription": "Global output directory for .mod files generated due to linting `-J<linter.modOutput>`. Can resolve internal variables with `~`, `${workspaceFolder}`, `${env}`, `${config}`, `${file}`, `${fileDirname}`, `${fileBasenameNoExtension}`.",
+            "markdownDescription": "Output directory for .mod files generated due to linting `-J<linter.modOutput>`. By default this is an internal VS Code path unique to each workspace. Can resolve internal variables with `~`, `${workspaceFolder}`, `${env}`, `${config}`, `${file}`, `${fileDirname}`, `${fileBasenameNoExtension}`.",
             "order": 40
           },
           "fortran.linter.fypp.enabled": {
@@ -307,7 +321,7 @@
               "std",
               "gfortran5"
             ],
-            "markdownDescription": "ine numbering marker format,  currently std`, `cpp` and `gfortran5` are supported, where `std` emits `#line` pragmas similar to standard tools, 'cpp' produces line directives as emitted by GNU cpp, and `gfortran5` cpp line directives with a workaround for a bug introduced in GFortran 5. Default: `cpp`.",
+            "markdownDescription": "Line numbering marker format,  currently std`, `cpp` and `gfortran5` are supported, where `std` emits `#line` pragmas similar to standard tools, 'cpp' produces line directives as emitted by GNU cpp, and `gfortran5` cpp line directives with a workaround for a bug introduced in GFortran 5. Default: `cpp`.",
             "order": 120
           },
           "fortran.linter.fypp.extraArgs": {
@@ -526,6 +540,19 @@
           }
         }
       },
+      {
+        "id": "experimental",
+        "title": "Experimental",
+        "order": 500,
+        "properties": {
+          "fortran.experimental.keepInitDiagnostics": {
+            "type": "boolean",
+            "default": true,
+            "markdownDescription": "Keep (and show) all diagnostics generated from the initialization of the Linter, not just from opened files.",
+            "order": 0
+          }
+        }
+      },
       {
         "id": "deprecated",
         "title": "Deprecated Options",
@@ -581,7 +608,22 @@
       {
         "category": "Fortran",
         "command": "fortran.analysis.rescanLinter",
-        "title": "Rescan Linter paths"
+        "title": "Rescan Linter Include paths"
+      },
+      {
+        "category": "Fortran",
+        "command": "fortran.analysis.initLinter",
+        "title": "Initialize Fortran Linter"
+      },
+      {
+        "category": "Fortran",
+        "command": "fortran.analysis.cleanLinterFiles",
+        "title": "Clean Linter generated files"
+      },
+      {
+        "category": "Fortran",
+        "command": "fortran.analysis.cleanLinterDiagnostics",
+        "title": "Clean All Linter Diagnostics"
       },
       {
         "category": "Fortran",
@@ -615,6 +657,24 @@
           "title": "Rescan Linter paths",
           "when": "!virtualWorkspace && shellExecutionSupported"
         },
+        {
+          "category": "Fortran",
+          "command": "fortran.analysis.initLinter",
+          "title": "Initialize Fortran Linter",
+          "when": "!virtualWorkspace && shellExecutionSupported"
+        },
+        {
+          "category": "Fortran",
+          "command": "fortran.analysis.cleanLinterFiles",
+          "title": "Clean Linter generated files",
+          "when": "!virtualWorkspace && shellExecutionSupported"
+        },
+        {
+          "category": "Fortran",
+          "command": "fortran.analysis.cleanLinterDiagnostics",
+          "title": "Clean All Linter Diagnostics",
+          "when": "!virtualWorkspace && shellExecutionSupported"
+        },
         {
           "category": "Fortran",
           "command": "fortran.analysis.showWhatsNew",
@@ -662,7 +722,7 @@
     "webpack": "webpack --mode production",
     "pretest": "npm run compile-dev && tsc -p tsconfig.test.json",
     "test": "npm run test:unit && npm run test:integration && npm run test:ui",
-    "test:ui": "extest setup-and-run -i out/test/ui/*.js -m test/ui/.mocharc.js",
+    "test:ui": "extest setup-and-run -i out/test/ui/*.js -m test/ui/.mocharc.js -s .vscode-test -e .vscode-test/extensions",
     "test:unit": "node ./out/test/unitTest/runTest.js",
     "test:integration": "node ./out/test/integration/runTest.js",
     "test:grammar-free": "vscode-tmgrammar-snap -s source.fortran.free -g ./syntaxes/fortran_free-form.tmLanguage.json \"./test/fortran/syntax/**/*{.f90,F90}\"",

src/extension.ts

@@ -47,8 +47,9 @@ export async function activate(context: vscode.ExtensionContext) {
     })
   );
   // Linter is always activated but will only lint if compiler !== Disabled
-  const linter = new FortranLintingProvider(logger);
-  linter.activate(context.subscriptions);
+  const linterCache = path.join(context.storageUri.fsPath);
+  const linter = new FortranLintingProvider(logger, linterCache);
+  context.subscriptions.push(...(await linter.activate()));
   vscode.languages.registerCodeActionsProvider(FortranDocumentSelector(), linter);
 
   if (formatterType !== 'Disabled') {

src/features/commands.ts

@@ -4,6 +4,9 @@
 
 export const RestartLS = 'fortran.analysis.restartLanguageServer';
 export const RescanLint = 'fortran.analysis.rescanLinter';
+export const CleanLintDiagnostics = 'fortran.analysis.cleanLinterDiagnostics';
+export const CleanLintFiles = 'fortran.analysis.cleanLinterFiles';
+export const InitLint = 'fortran.analysis.initLinter';
 export const WhatsNew = 'fortran.analysis.showWhatsNew';
 export const BuildRun = 'fortran.build.run';
 export const BuildDebug = 'fortran.build.debug';