matlab.codeanalysis.validateConfiguration

Validate Code Analyzer configuration file

Since R2023a

Syntax

issuesTable = matlab.codeanalysis.validateConfiguration

issuesTable = matlab.codeanalysis.validateConfiguration(pathname)

Description

issuesTable = matlab.codeanalysis.validateConfiguration validates the Code Analyzer configuration file, codeAnalyzerConfiguration.json, in the current folder and returns a table containing any identified issues.

For more information about Code Analyzer configuration, see Customize Code Analyzer Checks Using Configuration File.

issuesTable = matlab.codeanalysis.validateConfiguration(pathname) validates the Code Analyzer configuration file in the folder or the codeAnalyzerConfiguration.json file specified by pathname.

Examples

Validate Configuration File

Validate the Code Analyzer configuration file in the resources folder of C:\MyCode.

issuesTable = matlab.codeanalysis.validateConfiguration("C:\MyCode")

issuesTable =

  1×9 table

                Location                Severity                                             Message                                               MessageID       LineStart    LineEnd    ColumnStart    ColumnEnd                        FullFilename                    
    ________________________________    ________    _________________________________________________________________________________________    ______________    _________    _______    ___________    _________    ____________________________________________________

    "codeAnalyzerConfiguration.json"    warning     "Check name "MyOwnCheck" not found, or "rule" field is missing to create a custom check."    UnknownCheckId       20          20            9            20        "C:\MyCode\resources\codeAnalyzerConfiguration.json"

Input Arguments

pathname — Configuration file location

string | scalar

Configuration file location, specified as a string scalar or character vector. The location can contain a partial or full path to a configuration file or folder containing a configuration file.

Example: "C:\MyCode\resources"

Example: "../codeAnalyzerConfiguration.json"

Output Arguments

issuesTable — Identified issues

table

Identified issues, returned as a table with these columns:

Column Name	Column Purpose
Location	Name of analyzed configuration file, which also functions as a hyperlink to the location of the issue in the configuration file.
Severity	Severity of the message, specified as error, warning, or info.
Message	Description of the issue
MessageID	Check identifier of issue
LineStart	Line number in the configuration file where issue begins
LineEnd	Line number in the configuration file where issue ends
ColumnStart	Column number in the configuration file where issue begins
ColumnEnd	Column number in the configuration file where issue ends
FullFilename	Full path to configuration file

Version History

Introduced in R2023a

R2024b: Output includes Severity column

The output table includes a column called Severity to show the severity of an issue, specified as error, warning, or info.

The ErrorMessage and ErrorID columns have been renamed to Message and MessageID respectively.