How to use the command 'mh_metric' (with examples)

The ‘mh_metric’ command is used to calculate and enforce code metrics for MATLAB or Octave code. It is a useful tool for analyzing the complexity and quality of code, helping developers to identify areas that need improvement and maintain good coding practices.

Use case 1: Print the code metrics for the specified files

Code:

mh_metric path/to/file1.m path/to/file2.m ...

Motivation:

This use case is useful when you want to analyze the code metrics for specific MATLAB or Octave files. By providing the paths to the files as arguments, the ‘mh_metric’ command will calculate and display the code metrics for those files.

Explanation:

• mh_metric: The command itself.
• path/to/file1.m path/to/file2.m ...: The paths to the MATLAB or Octave files for which you want to calculate the code metrics.

Example output:

File: path/to/file1.m
Metrics:
- Lines of code: 100
- Cyclomatic complexity: 20
- Halstead complexity: 50

File: path/to/file2.m
Metrics:
- Lines of code: 150
- Cyclomatic complexity: 25
- Halstead complexity: 60

Use case 2: Print the code metrics for the specified Octave files

Code:

mh_metric --octave path/to/file1.m path/to/file2.m ...

Motivation:

If you specifically want to calculate code metrics for Octave files, you can use this use case. By including the --octave flag, the ‘mh_metric’ command will treat the provided files as Octave files and calculate the metrics accordingly.

Explanation:

• mh_metric: The command itself.
• --octave: An option flag that specifies to treat the provided files as Octave files rather than MATLAB files.
• path/to/file1.m path/to/file2.m ...: The paths to the Octave files for which you want to calculate the code metrics.

Example output:

File: path/to/file1.m  [Octave]
Metrics:
- Lines of code: 100
- Cyclomatic complexity: 20
- Halstead complexity: 50

File: path/to/file2.m  [Octave]
Metrics:
- Lines of code: 150
- Cyclomatic complexity: 25
- Halstead complexity: 60

Use case 3: Print the code metrics for the specified directory recursively

Code:

mh_metric path/to/directory

Motivation:

This use case is helpful when you want to calculate the code metrics for all the files in a specified directory and its subdirectories. Instead of providing individual file paths, you can simply provide the path to the directory, and the ‘mh_metric’ command will calculate the metrics for all the MATLAB or Octave files within that directory.

Explanation:

• mh_metric: The command itself.
• path/to/directory: The path to the directory for which you want to calculate the code metrics recursively.

Example output:

Directory: path/to/directory
File: path/to/directory/file1.m
Metrics:
- Lines of code: 100
- Cyclomatic complexity: 20
- Halstead complexity: 50

File: path/to/directory/subdirectory/file2.m
Metrics:
- Lines of code: 150
- Cyclomatic complexity: 25
- Halstead complexity: 60

...

Use case 4: Print the code metrics for the current directory

Code:

mh_metric

Motivation:

If you want to calculate the code metrics for the current directory, you can use this use case. By not providing any file or directory paths, the ‘mh_metric’ command will automatically calculate the metrics for all the MATLAB or Octave files in the current directory.

Explanation:

• mh_metric: The command itself.

Example output:

Directory: current_directory
File: current_directory/file1.m
Metrics:
- Lines of code: 100
- Cyclomatic complexity: 20
- Halstead complexity: 50

File: current_directory/subdirectory/file2.m
Metrics:
- Lines of code: 150
- Cyclomatic complexity: 25
- Halstead complexity: 60

...

Use case 5: Print the code metrics report in HTML or JSON format

Code:

mh_metric --html|json path/to/output_file

Motivation:

Sometimes, you may want to generate a code metrics report in a specific format like HTML or JSON. This use case allows you to specify the desired output format by including either the --html or --json flag, and provide the path to the output file.

Explanation:

• mh_metric: The command itself.
• --html: An option flag that specifies to generate the code metrics report in HTML format.
• --json: An option flag that specifies to generate the code metrics report in JSON format.
• path/to/output_file: The path to the file where the code metrics report should be saved.

Example output:

• HTML:

The code metrics report is converted to HTML format and saved at the specified location.

• JSON:

The code metrics report is converted to JSON format and saved at the specified location.

Conclusion:

The ‘mh_metric’ command is a powerful tool for calculating and enforcing code metrics for MATLAB or Octave code. Whether you need to analyze specific files, a directory, or generate a report in a specific format, the ‘mh_metric’ command provides various options to meet your needs. By understanding and utilizing these different use cases, you can effectively assess the quality and complexity of your MATLAB or Octave code.