Merge pull request #154 from ImperialCollegeLondon/dev/small-improvements

dev: Small improvements

Author: mfacchinelli

.github/workflows/package.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Set up MATLAB
         uses: matlab-actions/[email protected]
         with:
-          release: R2024b
+          release: R2025a
       - name: Load Environment Variables
         uses: aarcangeli/[email protected]
       - name: Validate version with tag

.github/workflows/test.yml

@@ -15,7 +15,7 @@ jobs:
     name: Run MATLAB Tests
     strategy:
       matrix:
-        release: ["R2024a", "R2024b"]
+        release: ["R2024a", "R2024b", "R2025a"]
     runs-on: windows-latest
     steps:
       - name: Check out repository
@@ -63,9 +63,14 @@ jobs:
           use-actions-summary: 'false'
       - name: Report coverage
         uses: 5monkeys/cobertura-action@master
-        if: matrix.release == 'R2024b'
+        if: matrix.release == 'R2025a'
         with:
           path: 'artifacts/coverage.xml'
           minimum_coverage: 80
           skip_covered: true
           report_name: Coverage Report (${{ matrix.release }})
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v3
+        if: matrix.release == 'R2025a'
+        with:
+          sarif_file: artifacts/issues.sarif

app/DataVisualization.m

@@ -242,7 +242,7 @@ function exportButtonPushed(app)
 
                     variableName = app.createMissionSpecificVariable();
 
-                    if evalin("base", compose("exist(""%s"", ""var"")", variableName))
+                    if evalin("base", compose("exist(""%s"", ""var"")", variableName)) %#ok<EVALIN>
 
                         selectedOption = uiconfirm(app.UIFigure, compose("Variable <code>%s</code> already exists in the MATLAB Workspace.", variableName) + ...
                             " Would you like to overwrite it?", "Variable Already Exists", Interpreter = "html");

buildfile.m

@@ -1,22 +1,29 @@
 function plan = buildfile()
 % BUILDFILE File invoked by automated build.
 
-    project = matlab.project.currentProject();
+    % Create a plan from task functions.
+    plan = buildplan();
 
-    if isempty(project) || ~isequal(project.Name, "MAG Data Visualization")
+    % Get current project.
+    if isMATLABReleaseOlderThan("R2025a")
 
-        project = matlab.project.loadProject("MAGDataVisualization.prj");
-        restore = onCleanup(@() project.close());
-    end
+        project = matlab.project.currentProject();
 
-    % Create a plan from task functions.
-    plan = buildplan();
+        if isempty(project) || ~isequal(project.Name, "MAG Data Visualization")
+
+            project = matlab.project.loadProject("MAGDataVisualization.prj");
+            restoreProject = onCleanup(@() project.close());
+        end
+    else
+        project = plan.Project;
+    end
 
     % Add the "check" task to identify code issues.
     sourceFolders = ["app", "src"];
 
     plan("check") = matlab.buildtool.tasks.CodeIssuesTask(sourceFolders, ...
-        IncludeSubfolders = true);
+        IncludeSubfolders = true, ...
+        Results = fullfile("artifacts/issues.sarif"));
 
     % Add the "test" task to run tests.
     testFolders = ["tests/system", "tests/unit"];

resources/codeAnalyzerConfiguration.json

@@ -0,0 +1,115 @@
+{
+    // Configuration File Information
+    "name": "MAG Lab Guidelines",
+    "description": "MAG Lab MATLAB style guidelines",
+    "author": "Michele Facchinelli",
+    "schemaVersion": "1.1.0",
+    "guidelineVersion": "1.0.0",
+
+    // New and Modified Checks
+    "checks":
+    {
+        // ======================================
+        // Enable additional Code Analyzer checks
+        // ======================================
+        "EVALIN":
+        {
+            "rule":
+            {
+                "template": "functionCall",
+                "functionNames": "evalin"
+            },
+            "severity": "error",
+            "messageText": "Do not use evalin.",
+            "enabled": true
+        },
+        "VARNAME":
+        {
+            "rule":
+            {
+                "template": "variableName",
+                "variableNames": ["size", "error", "length", "max", "isa", "nargin" , "numel" , "nargout" ,"isequal" , "zeros" , "true" ,"false" ,"fullfile" ,"find", "get"]
+            },
+            "severity": "warning",
+            "messageText": "Avoid using function names for variables.",
+            "enabled": true
+        },
+        "LLMNC":
+        {
+            // Disallow very long lines (too many characters)
+            "severity": "error",
+            "limit": 1000,
+            "enabled": true
+        },
+        "FCNOL":
+        {
+            // Disallow too many outputs
+            "severity": "error",
+            "messageText": "Too many outputs.",
+            "limit": 15,
+            "enabled": true
+        },
+        // =================================================
+        // Increase severity of default Code Analyzer checks
+        // =================================================
+        "GVMIS":
+        {
+            // Do not use global variables
+            "severity": "error"
+        },
+        "EVLCS":
+        {
+            // "eval" family of functions is slow and unclear
+            "severity": "error"
+        },
+        "NOANS":
+        {
+            // Do not use "ans" as a variable
+            "severity": "error"
+        },
+        "CHAIN":
+        {
+            // Chained logical operations like "a > b > c" are usually a bug
+            //     For scalars, it should be: "(a > b) && (b > c)"
+            //     For arrays, it should be: "(a > b) & (b > c)"
+            "severity": "error"
+        }
+    },
+
+    // Naming Conventions
+    "naming":
+    {
+        // ============================================================
+        // Enable naming conventions for different types of identifiers
+        // ============================================================
+        "property": {
+            "casing": "UpperCamelCase"
+        },
+        "function": {
+            "casing": "lowerCamelCase"
+        },
+        "class": {
+            "casing": "UpperCamelCase"
+        },
+        "method": {
+            "casing": ["lowercase", "lowerCamelCase"],
+            "regularExpression": "^([a-z]+|[a-z]+([A-Z][a-z0-9]*)*)$"
+        },
+        "localFunction": {
+            "casing": "lowerCamelCase"
+        },
+        "nestedFunction": {
+            "casing": "lowerCamelCase"
+        },
+        "event": {
+            "casing": "UpperCamelCase"
+        },
+        "enumeration": {
+            "casing": "UpperCamelCase",
+            "regularExpression": "^([A-Z][a-z0-9]+)$"
+        },
+        "variable": {
+            "casing": ["lowercase", "lowerCamelCase"]
+        }
+    }
+}

resources/project/AOtCj9zIoakl7xWTZ7zlU9inEno/6KiXbw0I0Ubp8m3bL4fUImy_M8Id.xml renamed to resources/project/-h2L0hF035doqVvcUhcvKfD_LcU/3j8csAofpexFJlNRCUUrYl1Iybgd.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Info location="+validator" type="File"/>

resources/project/-h2L0hF035doqVvcUhcvKfD_LcU/3j8csAofpexFJlNRCUUrYl1Iybgp.xml

@@ -1,2 +1,2 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<Info location="Type.m" type="File"/>
+<Info location="psd.m" type="File"/>