miss_hit-matlab-styler

A MATLAB Class Wrapper for MISS_HIT (Currently only mh_style is supported)

Install

• Install the brilliant MISS_HIT (Python3 is required).
• Download and save the MISS_HIT.m file in your MATLAB search path.

Usage

The usage of this wrapper is rather simple. Please refer to MISS_HIT Style Checker for a detailed documentation regarding the styler.

Default

Execute MISS_HIT.mh_style() or MISS_HIT.mh_style in MATLAB command window and the code in the active editor will be automatically formatted (but not saved):

% in matlab command window
MISS_HIT.mh_style()
% or
MISS_HIT.mh_style

miss_hit.cfg or .miss_hit is regarded as a valid configuration in your project as described in Setting up configuration in your project.

Run with Options

You can pass CLI arguments as a character array to the function:

% in matlab command window
MISS_HIT.mh_style('--tab_width 2 --ignore-config --fix')

When nothing is passed to the function (in default case), --fix is automatically added. To explicitly discard all options, run MISS_HIT.mh_style('').

A detailed list of valid options can be acquired in MATLAB command window:

% in matlab command window
MISS_HIT.mh_style('-h')

or in shell:

# in shell
mh_style -h

Add as Shortcuts

You can add MISS_HIT.mh_style to your favorite commands and pin it on the quick access tool bar. For convenience, I wrote a simple function to do this for you:

% in matlab command window
MISS_HIT.add_to_quick_access(@MISS_HIT.mh_style)

And then you can format your code by simply clicking the icon on the upright corner in the tool bar or use the keyboard shortcut alt + 1.

Acknowledgement

• florianschanda/miss_hit