Check folder names
Check ID:
mathworks.jmaab_v6.ar_0002
Guideline: ar_0002: Usable characters for folder names
Description
Checks if folder names adhere to the following guideline standards.
Do not begin with a number.
Do not begin or end with an underscore.
Do not contain consecutive underscores.
Do not coincide with reserved MATLAB® words.
Contain only alphanumeric characters and underscores.
Note
Reserved MATLAB words include the following:
Built-in functions:
builtin
Functions in the MATLAB path: Functions List
Reserved Keywords (Embedded Coder)
nil
nan
inf
infinity
This check requires a Simulink® Check™ license.
Check Parameterization
This check contains sub-checks that correspond to sub IDs specified in the JMAAB modeling guidelines. You can use the Model Advisor Configuration Editor to specify which sub IDs (one or multiple) to execute.
For reference, the guideline sub ID(s) that are recommended for use by the JMAAB modeling standards organizations are:
JMAAB — a, b, c, d, e, f
This check is applicable to the model folder by default. Use the Additional folders to check input parameter to enter the paths for other folders you want to check. This check applies recursively to subfolders within the specified folders.
Results and Recommended Actions
Guideline Sub ID | Condition | Recommended Action |
---|---|---|
ar_0002_a: Characters allowed for folder names | One or more folders have invalid names. | Use only alphanumeric characters and underscores in folder names. |
ar_0002_b: Number at the beginning | One or more folder names begin with a number. | Use alphabetic characters at the beginning of folder names. |
ar_0002_c: Underscore at the beginning | One or more folder names begin with an underscore. | Use alphabetic characters at the beginning of folder names. |
ar_0002_d: Underscore at the end | One or more folder names end with an underscore. | Do not end folder names with underscores. |
ar_0002_e: Consecutive underscores | One or more folder names have consecutive underscores. | Do not use consecutive underscores in folder names. |
ar_0002_f: Single reserved MATLAB word | The folder name is a reserved MATLAB word. | Do not use reserved MATLAB words as folder names. |
Capabilities and Limitations
Use the input parameter Allow MATLAB package to allow creation of folder names starting with the special characters: "
+
" or "@
".Use the input parameter Check hidden folders to run the check on hidden folders.
Specify the additional folders you intend to check in the input parameter Additional folders to check. You can input multiple folder paths separated by commas in the following manner:
"path1","path2","path3"
and so on.Use the input parameter Exclude folders to exclude the folders from being checked. You can input multiple folder paths separated by commas in the following manner:
"path1","path2","path3"
and so on.Runs on library models.
Runs on nested sub directories.