Add "Check Code Portability" command to check the portability of loaded files

Author: pmoura

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## [0.89.0]
 
+* Add "Check Code Portability" command to check the portability of loaded files
 * Format Logtalk source files when saving them depending on the `editor.formatOnSave` setting
 
 ## [0.88.4]

README.md

@@ -2,7 +2,7 @@
 
 A VSCode extension that provides language support for Logtalk. Forked from the [original extension](https://github.com/arthwang/vsc-logtalk) by Arthur Wang.
 
-Requires **Logtalk 3.97.0** or later and a supported [Prolog backend](https://logtalk.org/download.html#requirements). As this extension uses supporting code that's part of the Logtalk distribution, use of the latest Logtalk version is strongly recommended.
+Requires **Logtalk 3.99.0** or later and a supported [Prolog backend](https://logtalk.org/download.html#requirements). As this extension uses supporting code that's part of the Logtalk distribution, use of the latest Logtalk version is strongly recommended.
 
 🙏 Sponsored by [Permion](https://permion.ai/) and [GitHub Sponsors](https://github.com/sponsors/pmoura).
 
@@ -184,6 +184,7 @@ Project (workspace) commands can be triggered from the command palette by typing
 |                    Open Logtalk | Opens Logtalk in an integrated terminal                            |
 |                            Make | Sub-menu with available make targets                               |
 |          Scan Project Dead Code | Recursively scans the workspace root folder for dead code          |
+|          Check Code Portability | Checks loaded code portability                                     |
 |         Compute Project Metrics | Recursively computes metrics for the workspace root folder         |
 |                       Profiling | Sub-menu with code profiling commands                              |
 |  Generate Project Documentation | Recursively generates documentation for the workspace root folder  |
@@ -198,6 +199,8 @@ The "Load Project" command looks for a `loader.lgt` or `loader.logtalk` file in
 
 The "Create Loader File" command creates a `loader.lgt` file from selected Logtalk files or from all Logtalk files in a selected directory. When multiple Logtalk files are selected in the explorer, it creates a loader file containing all selected files. When a directory is selected, it finds all `.lgt` and `.logtalk` files in that directory and also includes any `loader.lgt` files found in immediate subdirectories. The command filters only Logtalk files, removes duplicates, sorts them alphabetically, and prompts for confirmation before overwriting an existing `loader.lgt` file. The created file is automatically opened after creation.
 
+The "Check Code Portability" command reloads all files by calling `logtalk_make(force)` with the `portability` flag set to `warning`. But note that all linter warnings will be reported and added to the "Problems" pane, not just portability warnings.
+
 The "Scan Project Dead Code", "Compute Project Metrics", "Generate Project Documentation", and "Generate Project Diagrams" commands require that the project code is already loaded. Quick fixes are provided for some of the documentation and dead code linter warnings.
 
 The output of the "Run Project Testers" and "Run Project Doclets" commands is displayed in the "OUTPUT" pane "Logtalk Testers & Doclets" channel. The "Run Project Testers" command adds failed tests to the "PROBLEMS" pane.
@@ -217,6 +220,7 @@ These commands can be triggered from the editor/context menu via right-click in
 |        Open Parent File | Opens the file that loaded the active source file if any                         |
 |                    Make | Sub-menu with available make targets                                             |
 |          Scan Dead Code | Scans the active source file directory for dead code                             |
+|  Check Code Portability | Checks loaded code portability                                                   |
 |         Compute Metrics | Computes metrics for all files in the active source file directory               |
 |               Profiling | Sub-menu with code profiling commands                                            |
 |  Generate Documentation | Generates documentation for the active source file directory                     |
@@ -231,7 +235,7 @@ The "Load Directory" command looks for a `loader.lgt` or `loader.logtalk` file i
 
 The "Run Tests" and "Run Tests with Coverage" commands add failed tests to the "PROBLEMS" pane. Quick fixes are provided for some test definition warnings.
 
-The "Generate Documentation" and "Scan Dead Code" commands add linter warnings to the "PROBLEMS" pane. Quick fixes are provided for some of the warnings.
+The "Generate Documentation", "Scan Dead Code", and "Check Code Portability" commands add linter warnings to the "PROBLEMS" pane. Quick fixes are provided for some of the warnings.
 
 The output of the "Generate Documentation" and "Generate Diagrams" commands assume that the documentation and the diagrams will be browsed locally in VSCode (with the entry point being the main diagram, which can be opened using the "Open SVG in Viewer" command). The default output directories are `xml_docs` for documentation and `dot_dias` for diagrams. To generate documentation and diagrams for publication, define a _doclet_ and run it using the "Run Doclet" command.
 

package.json

@@ -148,6 +148,11 @@
                 "title": "Scan Dead Code",
                 "category": "Logtalk"
             },
+            {
+                "command": "logtalk.check.codePortability",
+                "title": "Check Code Portability",
+                "category": "Logtalk"
+            },
             {
                 "command": "logtalk.run.doclet",
                 "title": "Run Doclet",
@@ -496,6 +501,10 @@
                     "command": "logtalk.scan.deadCode",
                     "when": "!virtualWorkspace"
                 },
+                {
+                    "command": "logtalk.check.codePortability",
+                    "when": "!virtualWorkspace"
+                },
                 {
                     "command": "logtalk.compute.metrics",
                     "when": "!virtualWorkspace"
@@ -663,15 +672,20 @@
                     "group": "directory_2@1"
                 },
                 {
-                    "command": "logtalk.compute.metrics",
+                    "command": "logtalk.check.codePortability",
                     "when": "resourceLangId == logtalk && !virtualWorkspace",
                     "group": "directory_2@2"
                 },
                 {
-                    "submenu": "profilingsubmenu",
+                    "command": "logtalk.compute.metrics",
                     "when": "resourceLangId == logtalk && !virtualWorkspace",
                     "group": "directory_2@3"
                 },
+                {
+                    "submenu": "profilingsubmenu",
+                    "when": "resourceLangId == logtalk && !virtualWorkspace",
+                    "group": "directory_2@4"
+                },
                 {
                     "command": "logtalk.generate.documentation",
                     "when": "resourceLangId == logtalk && !virtualWorkspace",
@@ -740,15 +754,20 @@
                     "group": "project_2@1"
                 },
                 {
-                    "command": "logtalk.rcompute.metrics",
+                    "command": "logtalk.check.codePortability",
                     "when": "resourceLangId == logtalk && !virtualWorkspace",
                     "group": "project_2@2"
                 },
                 {
-                    "submenu": "profilingsubmenu",
+                    "command": "logtalk.rcompute.metrics",
                     "when": "resourceLangId == logtalk && !virtualWorkspace",
                     "group": "project_2@3"
                 },
+                {
+                    "submenu": "profilingsubmenu",
+                    "when": "resourceLangId == logtalk && !virtualWorkspace",
+                    "group": "project_2@4"
+                },
                 {
                     "command": "logtalk.rgenerate.diagrams",
                     "when": "resourceLangId == logtalk && !virtualWorkspace",

src/extension.ts

@@ -513,6 +513,7 @@ export async function activate(context: ExtensionContext) {
     { command: "logtalk.run.test",                  callback: (uri, object, test) => LogtalkTerminal.runTestViaProfile(uri, object, test, linter, testsReporter, testsExplorerProvider)},
     { command: "logtalk.run.doclet",                callback: uri  => LogtalkTerminal.runDoclet(uri, linter)},
     { command: "logtalk.scan.deadCode",             callback: uri  => LogtalkTerminal.scanForDeadCode(uri, deadCodeScanner)},
+    { command: "logtalk.check.codePortability",     callback: async uri  => LogtalkTerminal.checkPortability(uri, linter)},
     { command: "logtalk.generate.documentation",    callback: uri  => LogtalkTerminal.genDocumentation(uri, documentationLinter)},
     { command: "logtalk.generate.diagrams",         callback: uri  => LogtalkTerminal.genDiagrams(uri)},
     { command: "logtalk.open.parentFile",           callback: uri  => LogtalkTerminal.openParentFile(uri)},

src/features/terminal.ts

@@ -227,6 +227,7 @@ export default class LogtalkTerminal {
       ".vscode_xml_files_done",
       ".vscode_dot_files_done",
       ".vscode_dead_code_scanning_done",
+      ".vscode_portability_done",
       ".vscode_entity_definition_done",
       ".vscode_predicate_definition_done",
       ".vscode_declaration_done",
@@ -1735,6 +1736,58 @@ export default class LogtalkTerminal {
     window.showInformationMessage("Dead code scanning completed.");
   }
 
+  public static async checkPortability(uri: Uri, linter: LogtalkLinter) {
+    let logtalkUser: string = '';
+    // Check for Configurations
+    let section = workspace.getConfiguration("logtalk");
+    if (section) {
+      logtalkUser = jsesc(section.get<string>("user.path", "logtalk"));
+    } else {
+      throw new Error("configuration settings error: logtalk");
+    }
+    // Clear the Scratch Message File
+    let compilerMessagesFile = `${logtalkUser}/scratch/.messages`;
+    try {
+      await workspace.fs.delete(Uri.file(compilerMessagesFile), { useTrash: false });
+    } catch (err) {
+      // Ignore if file doesn't exist
+    }
+    // Create the Terminal
+    LogtalkTerminal.createLogtalkTerm();
+    const wdir = LogtalkTerminal.getFirstWorkspaceFolder();
+    if (!wdir) {
+      throw new Error('No workspace folder open');
+    }
+    const marker = Utils.normalizeFilePath(path.join(wdir, ".vscode_portability_done"));
+    let goals = `vscode::portability('${wdir}').\r`;
+    LogtalkTerminal.sendString(goals);
+    try {
+      await LogtalkTerminal.waitForFile(marker);
+    } finally {
+      await LogtalkTerminal.safelyDeleteFile(marker);
+    }
+    // Parse any compiler errors or warnings
+    try {
+      const content = await workspace.fs.readFile(Uri.file(compilerMessagesFile));
+      let lines = content.toString().split(/\r?\n/);
+      let message = '';
+      for (let line of lines) {
+        if (line.startsWith('% [ compiling ')) {
+          linter.clear(line);
+        } else {
+          message = message + line + '\n';
+          if(line == '*     ' || line == '!     ') {
+            linter.lint(message);
+            message = '';
+          }
+        }
+      }
+    } catch (err) {
+      // File doesn't exist or can't be read, ignore
+    }
+    window.showInformationMessage("Portability check completed.");
+  }
+
   /**
    * Parse tester output file and create diagnostics
    */

tsconfig.json

@@ -5,7 +5,11 @@
     "outDir": "out",
     "lib": ["es6", "dom"],
     "sourceMap": true,
-    "rootDir": "."
+    "rootDir": ".",
+    "strict": false,
+    "noImplicitAny": false,
+    "strictNullChecks": false,
+    "skipLibCheck": true
   },
   "exclude": ["node_modules", ".vscode-test", "typings"]
 }