Matlab code format one click beautification artifact

MBeautifier It's based on MATLAB Open source one click beautification of source code m Code formatter . It can be directly in MATLAB Use in editor , And can be configured according to user habits .MBeautifier Supported by Matlab The minimum version is R2013b.

MBeautifier The original download address of ：https://github.com/davidvarga/MBeautifier

Readers who are inconvenient to download can send keywords in the background of the official account ：MBeautifier, You can get the download link of Baidu online disk .

MBeautifier It's based on M-Script Lightweight of MATLAB Source code formatter , But directly in MATLAB Use in editor .

characteristic ：

• Fill operators and keywords with spaces

• Configurable indent characters and levels . Use MATLAB The intelligent indent function of the editor

• remove / Add consecutive blank lines

• Insert missing element delimiters in matrix and cell array initialization （ comma ）

• Insert missing consecutive symbolic rows in matrix and cell array initialization

• In-lining Continuous line

• format MATLAB The current page of the editor or only in MATLAB Select an option in the editor or file

• And everything above can be in one XML Configuration in file

Deployment and configuration

Just download zip Extract the file to a specific directory , And then put MBeautifier Add root of to MATLAB route .

To configure Configuration

You can edit MBeautifier\resources\settings\MBeautyConfigurationRules.xml File to modify the configuration .

Configuration rules

At present, three configuration rules have been implemented ：Operator padding rule、Keyword padding rule and Special rule.

Operator fill rule

Every OperatorPaddingRule Represents the formatting rules for a single operator , By a key 、 The string that should be replaced and the string used for replacement .

<OperatorPaddingRule>
  <Key>NotEquals</Key>
  <ValueFrom>~=</ValueFrom>
  <ValueTo> ~= </ValueTo>
</OperatorPaddingRule>

The example above shows “ It's not equal to ” Rules for operators .

ValueFrom Node storage operators ~=,

ValueTo The node stores the expected format ： Operators should be preceded and followed by white-space character .

Keyword filling rules

Every KeyworPaddingRule Represents the format rules for a single keyword , And by the keyword itself and the required on the right white-space The filled values consist of .

<KeyworPaddingRule>
<Keyword>properties</Keyword>
<RightPadding>1</RightPadding>
</KeyworPaddingRule>

The above example shows the keywords “properties” The rules of .RightPadding The node stores the expected amount of right padding ： Keyword should be preceded by a blank character .

Be careful ： Not all keywords are listed - Only those that control the filling of meaningful keywords .

Special rules

These rules are basically MBeautifier Switches for certain functions . For details, see the... Of the compressed package README.md file ,

Usage method , Enter directly on the command line to use

At present, four methods are supported ：

• stay MATLAB Perform formatting on the currently active page of the editor . command ：MBeautify.formatCurrentEditorPage(). By default , The file will not be saved , But it will still open and modify in the editor . You can choose to use MBeautify.formatCurrentEditorPage(true) Syntax saves formatted files .

• Yes MATLAB The editor performs formatting on the currently selected text of the active page . command ：MBeautify.formatEditorSelection(). under these circumstances , There is also an optional save mechanism as described above .（ I don't know why the running time of this function is long after the actual measurement , Not recommended ）

• Format the file . command ：MBeautify.formatFile(file). It can be done with （1） Use with one parameter ： Input file is formatted , And in MATLAB Keep the editor open , Not saved ;（2） The two parameters are MBeautify.formatFile(file, outFile)： If possible , Save the formatted file to the specified output file . The output can be the same as the input .file You need an absolute path

  

• Perform formatting on multiple files in the directory . command ：MBeautify.formatFiles(directory, fileFilter). The first parameter is the absolute path to the directory , The second parameter is a wildcard expression （ be used for dir command ）, Used to filter files in the target directory . The file will be formatted in-place（ Cover ）.