Sample Configuration File

This code shows the contents of a sample configuration file. The codeAnalyzerConfiguration.json file uses JSON format, and // designates the text that follows as a comment.

{
// Configuration File Information

    "name": "Acme Corp Guideline",
    "description": "Internal MATLAB Coding Guideline",
    "author" : "Alex",
    "schemaVersion" : "1.0.0",
    "guidelineVersion" : "1.0.0",


// Base Configuration Settings
  
    "baseConfiguration" : "closestParentFolder",
   

// New and Modified Checks

    "checks": 
    {
        "MyFunctionCheck" : 
        {
           "rule": 
            {
               "template": "functionCall",
               "functionNames" : "evalin" 
            },
           "severity" : "error",
           "messageText" : "Do not use evalin.",
           "enabled" : true
        },
        "MyVariableCheck" : 
        {
           "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" : 
        { 
           "severity" : "error", 
           "limit" : 10, 
           "enabled": true 
        }, 
        "FCNOL" : 
        { 
           "severity" : "error",
           "messageText": "Too many outputs.",  
           "limit" : 15, 
           "enabled": true 
        },
        "AGROW" : 
        {
           "severity" : "info",
           "messageText" : "Growing array in a loop is not recommended",
           "enabled" : false
        }
    }
}

Configuration File Information

You can optionally include the following properties in the configuration file. These properties do not affect the configuration. Each property accepts a string containing the relevant information.

Base Configuration Settings

A configuration file can inherit the rules of a configuration file contained in the resources folder of a parent folder. The property "baseConfiguration" specifies what base configuration should be used and accepts these values:

Add Custom Checks for Existing Functions

You can configure the Code Analyzer to display a check when specific functions are used. To create a new check, you must assign a check ID that is a valid MATLAB identifier. For example, define "MyFunctionCheck" to check for an evalin function call.

The "MyFunctionCheck" check has these properties:

Add Custom Checks for Specified Variable Names

You can configure the Code Analyzer to display a check when specific variable names are used. To create a new check, you must assign a check ID that is a valid MATLAB identifier. For example, define "MyVariableCheck" to check for variables with the names size, error, or length.

The "MyVariableCheck" check has these properties:

Configure Maximum Input and Output Arguments

You can configure the Code Analyzer to limit the number of input and output arguments for a function. Use the check ID "FCNIL" to specify the maximum number of input arguments for a function. Use the check ID "FCNOL" to specify the maximum number of output arguments.

The "FCNIL" and "FCNOL" checks have these properties:

Configure Maximum Characters per Line, Lines in a Function, and Nested Control Statements

You can configure the maximum characters per line, lines in a function, and nested control statements. Use the check ID "FCNLL" to specify the maximum number of lines of code for a function. Use the check ID "LLMNC" to specify the maximum number of characters (including whitespaces) in a line. Use the check ID "MNCSN" to specify the maximum number of control statements, such as for and if, that can be nested.

The "FCNLL", "LLMNC", and "MNCSN" checks have these properties:

Modify Existing Code Analyzer Checks

You can use the configuration file to modify existing Code Analyzer checks. Use the check ID you want to modify as the check name. Then, specify the properties you want to modify and their new values. For example, to disable a check in the editor, specify "enabled" : false.

To identify the check ID for checks in a given file, use codeIssues. For a full list of configurable checks, see Index of Code Analyzer Checks.

The built-in Code Analyzer checks have these properties: