├── .gitignore
├── .vscode
└── launch.json
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE.txt
├── README.md
├── extension.js
├── formatter
├── matlab_formatter.py
├── test.m
└── test_post_formatter.m
├── images
├── example.gif
└── icon.png
├── package.json
└── vsc-extension-quickstart.md
/.gitignore:
--------------------------------------------------------------------------------
1 | .vscode/
2 | *.vsix
3 |
--------------------------------------------------------------------------------
/.vscode/launch.json:
--------------------------------------------------------------------------------
1 | {
2 | "version": "0.2.0",
3 | "configurations": [
4 | {
5 | "name": "Run Extension",
6 | "type": "extensionHost",
7 | "request": "launch",
8 | "runtimeExecutable": "${execPath}",
9 | "args": [
10 | "--extensionDevelopmentPath=${workspaceFolder}"
11 | ]
12 | }
13 | ]
14 | }
--------------------------------------------------------------------------------
/.vscodeignore:
--------------------------------------------------------------------------------
1 | .vscode/**
2 | .vscode-test/**
3 | test/**
4 | .gitignore
5 | jsconfig.json
6 | vsc-extension-quickstart.md
7 | .eslintrc.json
8 |
--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Change Log
2 |
3 | ### 2.11.0
4 | important security update:
5 | remove options `pythonPath` and `formatterPath`
6 |
7 | ### 2.10.5
8 | bugfix: comments before multiline statement
9 |
10 | ### 2.10.4
11 | add option to customize indentation of matrices/cells
12 |
13 | ### 2.10.3
14 | bugfix: formatting of strings
15 |
16 | ### 2.10.2
17 | add support for spmd
18 |
19 | ### 2.10.1
20 | bugfix: default value addSpaces
21 |
22 | ### 2.10.0
23 | * add option to customize wrapping of operators with spaces
24 | * add option to switch of formatter for selected lines via comment `% formatter ignore N`
25 |
26 | ### 2.9.2
27 | bugfix: unary minus at start of line
28 |
29 | ### 2.9.1
30 | feature: extend indent mode to `classdef`
31 |
32 | ### 2.9.0
33 | feature: add support for block comments
34 |
35 | ### 2.8.12
36 | bugfix: `if` statement with attached parenthesis
37 |
38 | ### 2.8.11
39 | * bugfix: semicolon after `end`
40 | * bugfix: add warning in case of mismatching `begin` and `end` statements
41 |
42 | ### 2.8.10
43 | bugfix: handle strings containing quotes
44 |
45 | ### 2.8.9
46 | bugfix: handle empty files correctly
47 |
48 | ### 2.8.8
49 | * bugfix: operator/assignment issue, e.g., `+=`
50 | * feature: indentation modes (thanks to Arturo Mendoza Quispe for adding this feature)
51 |
52 | ### 2.8.7
53 | bugfix: comments at end of line starting an `if`/`for`/... block
54 |
55 | ### 2.8.6
56 | add support for inline try;catch;end block
57 |
58 | ### 2.8.5
59 | bugfix: python path
60 |
61 | ### 2.8.4
62 | bugfixes:
63 | * fix formatting of expression clear
64 | * indentation of multiline statements with comments
65 |
66 | ### 2.8.3
67 | bugfix: comma-less vectors (again...)
68 |
69 | ### 2.8.2
70 | bugfix:
71 | issue with comments containing quotes
72 |
73 | performance:
74 | precompile regular expressions
75 |
76 | ### 2.8.1
77 | bugfixes:
78 | * brackets in strings and comments
79 | * multiline array at beginning of line
80 |
81 | ### 2.8.0
82 | features:
83 | * option to set custom path for formatter
84 | * support multiline cell arrays
85 |
86 | bugfix: error with multiple spaces after `for`/`if`/etc.
87 |
88 | ### 2.7.1
89 | bugfix: fix formatting issues with imports
90 |
91 | ### 2.7.0
92 | add support for arguments and enumeration
93 |
94 | ### 2.6.0
95 | features:
96 | * option to set custom python path
97 | * option to choose whether (for/if/...) blocks shall be wrapped with empty lines
98 |
99 | bugfix: whitespaces (yet again)
100 |
101 | ### 2.5.2
102 | bugfix: yet another attempt to fix all the spaces between expressions
103 |
104 | ### 2.5.1
105 | bugfix: keep spaces between expressions
106 |
107 | ### 2.5.0
108 | features:
109 | * pipe python error to vs-code error message (credits to AlexanderLieret)
110 | * add support for utf-8 (credits to wuyudi)
111 |
112 | bugfixes:
113 | * correct handling of non-comma-separated vectors and matrices
114 | * correct treatment of identifiers with names containing 'end'
115 |
116 | ### 2.4.12
117 | bugfix: correct formatting for strings containing quotes
118 |
119 | ### 2.4.11
120 | bugfix: correct line break - again
121 |
122 | ### 2.4.10
123 | bugfix: correct line break
124 |
125 | ### 2.4.9
126 | bugfix: correct formatting of unary minus
127 |
128 | ### 2.4.8
129 | bugfix: ignore ellipsis in comments
130 |
131 | ### 2.4.7
132 | bugfix: remove additional spaces in rational numbers and scientific notation e.g 1/7 or 1.7e42
133 |
134 | ### 2.4.6
135 | bugfix: correct formatting of identifiers ending on decimal
136 |
137 | ### 2.4.5
138 | bugfix: exclude non-comma-separated vectors from formatting to prevent negative entries from being converted to subtractions
139 |
140 | ### 2.4.4
141 | bugfix: correct indentation for multiline matrices
142 |
143 | ### 2.4.3
144 | bugfix: undo changes from 2.4.2 because they lead to problems with other unicode-characters (e.g. greek letters)
145 |
146 | ### 2.4.2
147 | bugfix: better support for chinese comments
148 |
149 | ### 2.4.0
150 | feature: Add indentation after linebreak (`...`)
151 |
152 | ### 2.3.0
153 | feature: Add support for object oriented Matlab code
154 |
155 | ### 2.2.3
156 | bugfix: support braces after control keyword e.g. `if()`
157 |
158 | ### 2.2.2
159 | * bugfix: quoting of shell command
160 | * bugfix: implement formatting of doublequote-strings
161 |
162 | ### 2.2.1
163 | Remove trailing whitespaces at lineend
164 |
165 | ### 2.2.0
166 | Call python script relative from extension.js -> Remove now obsolete setting `path`
167 |
168 | ### 2.1.2
169 | Bugfix: add `parfor` control sequence
170 |
171 | ### 2.1.1
172 | Improve matrix formatting
173 |
174 | ### 2.1.0
175 | * Feature: Add better formatting for matrices
176 |
177 | * Bugfix: Remove unwanted newlines after block-introducing comment
178 |
179 | ### 2.0.0
180 | Rewrite the formatter in an object oriented way to implement new features more easily.
181 |
182 | ### 1.2.1
183 | Bugfix: whitespace after string
184 |
185 | ### 1.2.0
186 | Feature: Add support for one-line control sequence (if, for, while)
187 |
188 | ### 1.1.8
189 | Bugfix: Correct indenting of try-catch block
190 |
191 | ### 1.1.7
192 | Bugfix: Don't break words into block-start-keywords
193 |
194 | ### 1.1.6
195 | Change default formatter-path to it's default windows location
196 |
197 | ### 1.1.5
198 | Bugfix: implement support for combined dot-operator + assignment (e.g. .+=)
199 |
200 | ### 1.1.4
201 | Bugfix: implement support for more combined operators
202 | Thanks to davidxujiayang for finding this bug and providing a solution!
203 |
204 | ### 1.1.3
205 | Bugfix: include last line when formatting
206 | Thanks to fasiha for finding the bug!
207 |
208 | ### 1.1.2
209 | Bugfix: enable variable indentwidth for format selection
210 |
211 | ### 1.1.1
212 | Add compatibility for python 3.6
213 |
214 | ### 1.1.0
215 | New Features:
216 | * format selection
217 | * variable indent width → setting: `matlab-formatter.indentwidth`
218 |
219 | ### 1.0.1
220 | Bugfix: Removed a remaining debug output that corrupted the output file
221 |
222 | ### 1.0.0
223 | Initial release of matlab-formatter
224 |
--------------------------------------------------------------------------------
/LICENSE.txt:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
676 |
677 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # matlab-formatter README
2 |
3 | Indent and format MATLAB code.
4 | Also usable as standalone without VScode.
5 |
6 | 
7 |
8 | ## Requirements
9 | - python 3.6
10 |
11 | ## Extension Settings
12 | * `matlab-formatter.indentwidth`: Number of spaces used for indentation.
13 | * `matlab-formatter.separateBlocks`: Control whether newlines should be added before and after blocks such as for, if, while and so on.
14 | * `matlab-formatter.indentMode`: Chose smart indentation mode: indent all functions, indent only nested functions, or don't indent inside any function.
15 | * `matlab-formatter.addSpaces`: Chose which operators should be wrapped with spaces: all operators, all but power (`^`, `.^`) or don't wrap any operators.
16 | * `matlab-formatter.matrixIndent`: Chose how matrices should be indented. Either keep all rows aligned or use only one level of indentation.
17 |
18 | ## Additional Options
19 | * The formatter can be switched off for selected lines by adding the comment `formatter ignore N`. For the next `N` lines, only the indentation will be fixed. Other than that, they will not be altered.
20 |
--------------------------------------------------------------------------------
/extension.js:
--------------------------------------------------------------------------------
1 | /*
2 | This file is part of matlab - formatter - vscode
3 | Copyright(C) 2019 - 2023 Benjamin "Mogli" Mann
4 |
5 | This program is free software: you can redistribute it and / or modify
6 | it under the terms of the GNU General Public License as published by
7 | the Free Software Foundation, either version 3 of the License, or
8 | (at your option) any later version.
9 |
10 | This program is distributed in the hope that it will be useful,
11 | but WITHOUT ANY WARRANTY; without even the implied warranty of
12 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
13 | GNU General Public License for more details.
14 |
15 | You should have received a copy of the GNU General Public License
16 | along with this program.If not, see < http: //www.gnu.org/licenses/>.
17 | */
18 |
19 | 'use strict';
20 | Object.defineProperty(exports, "__esModule", { value: true });
21 | const vscode = require("vscode");
22 | const cp = require("child_process");
23 | const stream = require('stream');
24 | const os = require("os");
25 | var channel = null;
26 | const fullRange = doc => doc.validateRange(new vscode.Range(0, 0, Number.MAX_VALUE, Number.MAX_VALUE));
27 | const MODE = { language: 'matlab' };
28 |
29 | class MatlabFormatter {
30 | constructor() {
31 | this.machine_os = os.platform();
32 | console.log(this.machine_os);
33 | this.py = '';
34 | if (this.machine_os == 'win32') {
35 | this.py = 'python ';
36 | }
37 | this.formatter = '"'+ __dirname + '/formatter/matlab_formatter.py"';
38 | }
39 |
40 | formatDocument(document, range) {
41 | return new Promise((resolve, reject) => {
42 | this.format(document, range).then((res) => {
43 | return resolve(res);
44 | });
45 |
46 | });
47 | }
48 |
49 | format(document, range) {
50 | return new Promise((resolve, reject) => {
51 | let indentwidth = " --indentWidth=" + vscode.workspace.getConfiguration('matlab-formatter')['indentwidth'];
52 | let separateBlocks = " --separateBlocks=" + vscode.workspace.getConfiguration('matlab-formatter')['separateBlocks'];
53 | let indentMode = " --indentMode=" + vscode.workspace.getConfiguration('matlab-formatter')['indentMode'];
54 | let addSpaces = " --addSpaces=" + vscode.workspace.getConfiguration('matlab-formatter')['addSpaces'];
55 | let matrixIndent = " --matrixIndent=" + vscode.workspace.getConfiguration('matlab-formatter')['matrixIndent'];
56 | let filename = ' -';
57 | let start = " --startLine=" + (range.start.line + 1);
58 | let end = " --endLine=" + (range.end.line + 1);
59 | var p = cp.exec(this.py + " " + this.formatter + " " + filename + indentwidth + separateBlocks + indentMode + addSpaces + matrixIndent + start + end, (err, stdout, stderr) => {
60 | if (stdout != '') {
61 | let toreplace = document.validateRange(new vscode.Range(range.start.line, 0, range.end.line + 1, 0));
62 | var edit = [vscode.TextEdit.replace(toreplace, stdout)];
63 | if (stderr != '') {
64 | vscode.window.showWarningMessage('formatting warning:\n'+stderr);
65 | }
66 | return resolve(edit);
67 | }
68 | vscode.window.showErrorMessage('formatting failed:\n'+stderr);
69 | return resolve(null);
70 | });
71 | var stdinStream = new stream.Readable();
72 | stdinStream.push(document.getText());
73 | stdinStream.push(null);
74 | stdinStream.pipe(p.stdin);
75 | });
76 | }
77 | }
78 |
79 | exports.MatlabFormatter = MatlabFormatter;
80 |
81 | class MatlabDocumentRangeFormatter {
82 | constructor() {
83 | this.formatter = new MatlabFormatter();
84 | }
85 | provideDocumentFormattingEdits(document, options, token) {
86 | return this.formatter.formatDocument(document, fullRange(document));
87 | }
88 | provideDocumentRangeFormattingEdits(document, range, options, token) {
89 | return this.formatter.formatDocument(document, range);
90 | }
91 | }
92 |
93 | function activate(context) {
94 | channel = vscode.window.createOutputChannel('matlab-formatter');
95 | const formatter = new MatlabDocumentRangeFormatter();
96 | context.subscriptions.push(vscode.languages.registerDocumentFormattingEditProvider(MODE, formatter));
97 | context.subscriptions.push(vscode.languages.registerDocumentRangeFormattingEditProvider(MODE, formatter));
98 | }
99 | exports.activate = activate;
100 | // this method is called when your extension is deactivated
101 | function deactivate() {
102 | }
103 | exports.deactivate = deactivate;
104 | //# sourceMappingURL=extension.js.map
105 |
--------------------------------------------------------------------------------
/formatter/matlab_formatter.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python3
2 |
3 | '''
4 | This file is part of matlab-formatter-vscode
5 | Copyright(C) 2019-2021 Benjamin "Mogli" Mann
6 |
7 | This program is free software: you can redistribute it and/or modify
8 | it under the terms of the GNU General Public License as published by
9 | the Free Software Foundation, either version 3 of the License, or
10 | (at your option) any later version.
11 |
12 | This program is distributed in the hope that it will be useful,
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 | GNU General Public License for more details.
16 |
17 | You should have received a copy of the GNU General Public License
18 | along with this program. If not, see .
19 |
20 | '''
21 |
22 | import re
23 | import sys
24 |
25 |
26 | class Formatter:
27 | # control sequences
28 | ctrl_1line = re.compile(r'(\s*)(if|while|for|try)(\W\s*\S.*\W)((end|endif|endwhile|endfor);?)(\s+\S.*|\s*$)')
29 | fcnstart = re.compile(r'(\s*)(function|classdef)\s*(\W\s*\S.*|\s*$)')
30 | ctrlstart = re.compile(r'(\s*)(if|while|for|parfor|try|methods|properties|events|arguments|enumeration|spmd)\s*(\W\s*\S.*|\s*$)')
31 | ctrl_ignore = re.compile(r'(\s*)(import|clear|clearvars)(.*$)')
32 | ctrlstart_2 = re.compile(r'(\s*)(switch)\s*(\W\s*\S.*|\s*$)')
33 | ctrlcont = re.compile(r'(\s*)(elseif|else|case|otherwise|catch)\s*(\W\s*\S.*|\s*$)')
34 | ctrlend = re.compile(r'(\s*)((end|endfunction|endif|endwhile|endfor|endswitch);?)(\s+\S.*|\s*$)')
35 | linecomment = re.compile(r'(\s*)%.*$')
36 | ellipsis = re.compile(r'.*\.\.\..*$')
37 | blockcomment_open = re.compile(r'(\s*)%\{\s*$')
38 | blockcomment_close = re.compile(r'(\s*)%\}\s*$')
39 | block_close = re.compile(r'\s*[\)\]\}].*$')
40 | ignore_command = re.compile(r'.*formatter\s+ignore\s+(\d*).*$')
41 |
42 | # patterns
43 | p_string = re.compile(r'(.*?[\(\[\{,;=\+\-\*\/\|\&\s]|^)\s*(\'([^\']|\'\')+\')([\)\}\]\+\-\*\/=\|\&,;].*|\s+.*|$)')
44 | p_string_dq = re.compile(r'(.*?[\(\[\{,;=\+\-\*\/\|\&\s]|^)\s*(\"([^\"])*\")([\)\}\]\+\-\*\/=\|\&,;].*|\s+.*|$)')
45 | p_comment = re.compile(r'(.*\S|^)\s*(%.*)')
46 | p_blank = re.compile(r'^\s+$')
47 | p_num_sc = re.compile(r'(.*?\W|^)\s*(\d+\.?\d*)([eE][+-]?)(\d+)(.*)')
48 | p_num_R = re.compile(r'(.*?\W|^)\s*(\d+)\s*(\/)\s*(\d+)(.*)')
49 | p_incr = re.compile(r'(.*?\S|^)\s*(\+|\-)\s*(\+|\-)\s*([\)\]\},;].*|$)')
50 | p_sign = re.compile(r'(.*?[\(\[\{,;:=\*/\s]|^)\s*(\+|\-)(\w.*)')
51 | p_colon = re.compile(r'(.*?\S|^)\s*(:)\s*(\S.*|$)')
52 | p_ellipsis = re.compile(r'(.*?\S|^)\s*(\.\.\.)\s*(\S.*|$)')
53 | p_op_dot = re.compile(r'(.*?\S|^)\s*(\.)\s*(\+|\-|\*|/|\^)\s*(=)\s*(\S.*|$)')
54 | p_pow_dot = re.compile(r'(.*?\S|^)\s*(\.)\s*(\^)\s*(\S.*|$)')
55 | p_pow = re.compile(r'(.*?\S|^)\s*(\^)\s*(\S.*|$)')
56 | p_op_comb = re.compile(r'(.*?\S|^)\s*(\.|\+|\-|\*|\\|/|=|<|>|\||\&|!|~|\^)\s*(<|>|=|\+|\-|\*|/|\&|\|)\s*(\S.*|$)')
57 | p_not = re.compile(r'(.*?\S|^)\s*(!|~)\s*(\S.*|$)')
58 | p_op = re.compile(r'(.*?\S|^)\s*(\+|\-|\*|\\|/|=|!|~|<|>|\||\&)\s*(\S.*|$)')
59 | p_func = re.compile(r'(.*?\w)(\()\s*(\S.*|$)')
60 | p_open = re.compile(r'(.*?)(\(|\[|\{)\s*(\S.*|$)')
61 | p_close = re.compile(r'(.*?\S|^)\s*(\)|\]|\})(.*|$)')
62 | p_comma = re.compile(r'(.*?\S|^)\s*(,|;)\s*(\S.*|$)')
63 | p_multiws = re.compile(r'(.*?\S|^)(\s{2,})(\S.*|$)')
64 |
65 | def cellIndent(self, line, cellOpen:str, cellClose:str, indent):
66 | # clean line from strings and comments
67 | pattern = re.compile(fr'(\s*)((\S.*)?)(\{cellOpen}.*$)')
68 | line = self.cleanLineFromStringsAndComments(line)
69 | opened = line.count(cellOpen) - line.count(cellClose)
70 | if opened > 0:
71 | m = pattern.match(line)
72 | n = len(m.group(2))
73 | indent = (n+1) if self.matrixIndent else self.iwidth
74 | elif opened < 0:
75 | indent = 0
76 | return (opened, indent)
77 |
78 | def multilinematrix(self, line):
79 | tmp, self.matrix = self.cellIndent(line, '[', ']', self.matrix)
80 | return tmp
81 |
82 | def cellarray(self, line):
83 | tmp, self.cell = self.cellIndent(line, '{', '}', self.cell)
84 | return tmp
85 |
86 | # indentation
87 | ilvl = 0
88 | istep = []
89 | fstep = []
90 | iwidth = 0
91 | matrix = 0
92 | cell = 0
93 | isblockcomment = 0
94 | islinecomment = 0
95 | longline = 0
96 | continueline = 0
97 | iscomment = 0
98 | separateBlocks = False
99 | ignoreLines = 0
100 |
101 | def __init__(self, indentwidth, separateBlocks, indentMode, operatorSep, matrixIndent):
102 | self.iwidth = indentwidth
103 | self.separateBlocks = separateBlocks
104 | self.indentMode = indentMode
105 | self.operatorSep = operatorSep
106 | self.matrixIndent = matrixIndent
107 |
108 | def cleanLineFromStringsAndComments(self, line):
109 | split = self.extract_string_comment(line)
110 | if split:
111 | return self.cleanLineFromStringsAndComments(split[0]) + ' ' + \
112 | self.cleanLineFromStringsAndComments(split[2])
113 | else:
114 | return line
115 |
116 | # divide string into three parts by extracting and formatting certain
117 | # expressions
118 |
119 | def extract_string_comment(self, part):
120 | # string
121 | m = self.p_string.match(part)
122 | m2 = self.p_string_dq.match(part)
123 | # choose longer string to avoid extracting subexpressions
124 | if m2 and (not m or len(m.group(2)) < len(m2.group(2))):
125 | m = m2
126 | if m:
127 | return (m.group(1), m.group(2), m.group(4))
128 |
129 | # comment
130 | m = self.p_comment.match(part)
131 | if m:
132 | self.iscomment = 1
133 | return (m.group(1) + ' ', m.group(2), '')
134 |
135 | return 0
136 |
137 | def extract(self, part):
138 | # whitespace only
139 | m = self.p_blank.match(part)
140 | if m:
141 | return ('', ' ', '')
142 |
143 | # string, comment
144 | stringOrComment = self.extract_string_comment(part)
145 | if stringOrComment:
146 | return stringOrComment
147 |
148 | # decimal number (e.g. 5.6E-3)
149 | m = self.p_num_sc.match(part)
150 | if m:
151 | return (m.group(1) + m.group(2), m.group(3), m.group(4) + m.group(5))
152 |
153 | # rational number (e.g. 1/4)
154 | m = self.p_num_R.match(part)
155 | if m:
156 | return (m.group(1) + m.group(2), m.group(3), m.group(4) + m.group(5))
157 |
158 | # incrementor (++ or --)
159 | m = self.p_incr.match(part)
160 | if m:
161 | return (m.group(1), m.group(2) + m.group(3), m.group(4))
162 |
163 | # signum (unary - or +)
164 | m = self.p_sign.match(part)
165 | if m:
166 | return (m.group(1), m.group(2), m.group(3))
167 |
168 | # colon
169 | m = self.p_colon.match(part)
170 | if m:
171 | return (m.group(1), m.group(2), m.group(3))
172 |
173 | # dot-operator-assignment (e.g. .+=)
174 | m = self.p_op_dot.match(part)
175 | if m:
176 | sep = ' ' if self.operatorSep > 0 else ''
177 | return (m.group(1) + sep, m.group(2) + m.group(3) + m.group(4), sep + m.group(5))
178 |
179 | # .power (.^)
180 | m = self.p_pow_dot.match(part)
181 | if m:
182 | sep = ' ' if self.operatorSep > 0.5 else ''
183 | return (m.group(1) + sep, m.group(2) + m.group(3), sep + m.group(4))
184 |
185 | # power (^)
186 | m = self.p_pow.match(part)
187 | if m:
188 | sep = ' ' if self.operatorSep > 0.5 else ''
189 | return (m.group(1) + sep, m.group(2), sep + m.group(3))
190 |
191 | # combined operator (e.g. +=, .+, etc.)
192 | m = self.p_op_comb.match(part)
193 | if m:
194 | # sep = ' ' if m.group(3) == '=' or self.operatorSep > 0 else ''
195 | sep = ' ' if self.operatorSep > 0 else ''
196 | return (m.group(1) + sep, m.group(2) + m.group(3), sep + m.group(4))
197 |
198 | # not (~ or !)
199 | m = self.p_not.match(part)
200 | if m:
201 | return (m.group(1) + ' ', m.group(2), m.group(3))
202 |
203 | # single operator (e.g. +, -, etc.)
204 | m = self.p_op.match(part)
205 | if m:
206 | # sep = ' ' if m.group(2) == '=' or self.operatorSep > 0 else ''
207 | sep = ' ' if self.operatorSep > 0 else ''
208 | return (m.group(1) + sep, m.group(2), sep + m.group(3))
209 |
210 | # function call
211 | m = self.p_func.match(part)
212 | if m:
213 | return (m.group(1), m.group(2), m.group(3))
214 |
215 | # parenthesis open
216 | m = self.p_open.match(part)
217 | if m:
218 | return (m.group(1), m.group(2), m.group(3))
219 |
220 | # parenthesis close
221 | m = self.p_close.match(part)
222 | if m:
223 | return (m.group(1), m.group(2), m.group(3))
224 |
225 | # comma/semicolon
226 | m = self.p_comma.match(part)
227 | if m:
228 | return (m.group(1), m.group(2), ' ' + m.group(3))
229 |
230 | # ellipsis
231 | m = self.p_ellipsis.match(part)
232 | if m:
233 | return (m.group(1) + ' ', m.group(2), ' ' + m.group(3))
234 |
235 | # multiple whitespace
236 | m = self.p_multiws.match(part)
237 | if m:
238 | return (m.group(1), ' ', m.group(3))
239 |
240 | return 0
241 |
242 | # recursively format string
243 | def format(self, part):
244 | m = self.extract(part)
245 | if m:
246 | return self.format(m[0]) + m[1] + self.format(m[2])
247 | return part
248 |
249 | # compute indentation
250 | def indent(self, addspaces=0):
251 | indnt = ((self.ilvl+self.continueline)*self.iwidth + addspaces)*' '
252 | return indnt
253 |
254 | # take care of indentation and call format(line)
255 | def formatLine(self, line):
256 |
257 | if (self.ignoreLines > 0):
258 | self.ignoreLines -= 1
259 | return (0, self.indent() + line.strip())
260 |
261 | # determine if linecomment
262 | if re.match(self.linecomment, line):
263 | self.islinecomment = 2
264 | else:
265 | # we also need to track whether the previous line was a commment
266 | self.islinecomment = max(0, self.islinecomment-1)
267 |
268 | # determine if blockcomment
269 | if re.match(self.blockcomment_open, line):
270 | self.isblockcomment = float("inf")
271 | elif re.match(self.blockcomment_close, line):
272 | self.isblockcomment = 1
273 | else:
274 | self.isblockcomment = max(0, self.isblockcomment-1)
275 |
276 | # find ellipsis
277 | self.iscomment = 0
278 | strippedline = self.cleanLineFromStringsAndComments(line)
279 | ellipsisInComment = self.islinecomment == 2 or self.isblockcomment
280 | if re.match(self.block_close, strippedline) or ellipsisInComment:
281 | self.continueline = 0
282 | else:
283 | self.continueline = self.longline
284 | if re.match(self.ellipsis, strippedline) and not ellipsisInComment:
285 | self.longline = 1
286 | else:
287 | self.longline = 0
288 |
289 | # find comments
290 | if self.isblockcomment:
291 | return(0, line.rstrip()) # don't modify indentation in block comments
292 | if self.islinecomment == 2:
293 | # check for ignore statement
294 | m = re.match(self.ignore_command, line)
295 | if m:
296 | if m.group(1) and int(m.group(1)) > 1:
297 | self.ignoreLines = int(m.group(1))
298 | else:
299 | self.ignoreLines = 1
300 | return (0, self.indent() + line.strip())
301 |
302 | # find imports, clear, etc.
303 | m = re.match(self.ctrl_ignore, line)
304 | if m:
305 | return (0, self.indent() + line.strip())
306 |
307 | # find matrices
308 | tmp = self.matrix
309 | if self.multilinematrix(line) or tmp:
310 | return (0, self.indent(tmp) + self.format(line).strip())
311 |
312 | # find cell arrays
313 | tmp = self.cell
314 | if self.cellarray(line) or tmp:
315 | return (0, self.indent(tmp) + self.format(line).strip())
316 |
317 | # find control structures
318 | m = re.match(self.ctrl_1line, line)
319 | if m:
320 | return (0, self.indent() + m.group(2) + ' ' + self.format(m.group(3)).strip() + ' ' + m.group(4) + ' ' + self.format(m.group(6)).strip())
321 |
322 | m = re.match(self.fcnstart, line)
323 | if m:
324 | offset = self.indentMode
325 | self.fstep.append(1)
326 | if self.indentMode == -1:
327 | offset = int(len(self.fstep) > 1)
328 | return (offset, self.indent() + m.group(2) + ' ' + self.format(m.group(3)).strip())
329 |
330 | m = re.match(self.ctrlstart, line)
331 | if m:
332 | self.istep.append(1)
333 | return (1, self.indent() + m.group(2) + ' ' + self.format(m.group(3)).strip())
334 |
335 | m = re.match(self.ctrlstart_2, line)
336 | if m:
337 | self.istep.append(2)
338 | return (2, self.indent() + m.group(2) + ' ' + self.format(m.group(3)).strip())
339 |
340 | m = re.match(self.ctrlcont, line)
341 | if m:
342 | return (0, self.indent(-self.iwidth) + m.group(2) + ' ' + self.format(m.group(3)).strip())
343 |
344 | m = re.match(self.ctrlend, line)
345 | if m:
346 | if len(self.istep) > 0:
347 | step = self.istep.pop()
348 | elif len(self.fstep) > 0:
349 | step = self.fstep.pop()
350 | else:
351 | print('There are more end-statements than blocks!', file=sys.stderr)
352 | step = 0
353 | return (-step, self.indent(-step*self.iwidth) + m.group(2) + ' ' + self.format(m.group(4)).strip())
354 |
355 | return (0, self.indent() + self.format(line).strip())
356 |
357 | # format file from line 'start' to line 'end'
358 | def formatFile(self, filename, start, end):
359 | # read lines from file
360 | wlines = rlines = []
361 |
362 | if filename == '-':
363 | with sys.stdin as f:
364 | rlines = f.readlines()[start-1:end]
365 | else:
366 | with open(filename, 'r', encoding='UTF-8') as f:
367 | rlines = f.readlines()[start-1:end]
368 |
369 | # take care of empty input
370 | if not rlines:
371 | rlines = ['']
372 |
373 | # get initial indent lvl
374 | p = r'(\s*)(.*)'
375 | m = re.match(p, rlines[0])
376 | if m:
377 | self.ilvl = len(m.group(1))//self.iwidth
378 | rlines[0] = m.group(2)
379 |
380 | blank = True
381 | for line in rlines:
382 | # remove additional newlines
383 | if re.match(r'^\s*$', line):
384 | if not blank:
385 | blank = True
386 | wlines.append('')
387 | continue
388 |
389 | # format line
390 | (offset, line) = self.formatLine(line)
391 |
392 | # adjust indent lvl
393 | self.ilvl = max(0, self.ilvl + offset)
394 |
395 | # add newline before block
396 | if (self.separateBlocks and offset > 0 and
397 | not blank and not self.islinecomment):
398 | wlines.append('')
399 |
400 | # add formatted line
401 | wlines.append(line.rstrip())
402 |
403 | # add newline after block
404 | if self.separateBlocks and offset < 0:
405 | wlines.append('')
406 | blank = True
407 | else:
408 | blank = False
409 |
410 | # remove last line if blank
411 | while wlines and not wlines[-1]:
412 | wlines.pop()
413 |
414 | # take care of empty output
415 | if not wlines:
416 | wlines = ['']
417 |
418 | # write output
419 | for line in wlines:
420 | print(line)
421 |
422 |
423 | def main():
424 | options = dict(startLine=1, endLine=None, indentWidth=4,
425 | separateBlocks=True, indentMode='',
426 | addSpaces='', matrixIndent='')
427 |
428 | indentModes = dict(all_functions=1, only_nested_functions=-1, classic=0)
429 | operatorSpaces = dict(all_operators=1, exclude_pow=0.5, no_spaces=0)
430 | matrixIndentation = dict(aligned=1, simple=0)
431 |
432 | if len(sys.argv) < 2:
433 | usage = 'usage: matlab_formatter.py filename [options...]\n'
434 | opt = ' OPTIONS:\n'
435 | for key in options:
436 | val = options[key]
437 | key_type = re.match(r'\', str(type(val))).group(1)
438 | key_type = key_type.replace('NoneType', 'int')
439 | opt += ' --%s=%s\n' % (key, key_type)
440 |
441 | print('%s%s' % (usage, opt), file=sys.stderr)
442 |
443 | else:
444 | for arg in sys.argv[2:]:
445 | key, value = arg.split('=')
446 | if any(char.isdigit() for char in value):
447 | value = int(value)
448 | elif value.lower() == 'true':
449 | value = True
450 | elif value.lower() == 'false':
451 | value = False
452 | options[key.strip().strip('-')] = value
453 |
454 | indent = options['indentWidth']
455 | start = options['startLine']
456 | end = options['endLine']
457 | sep = options['separateBlocks']
458 | mode = indentModes.get(options['indentMode'], indentModes['all_functions'])
459 | opSp = operatorSpaces.get(options['addSpaces'], operatorSpaces['exclude_pow'])
460 | matInd = matrixIndentation.get(options['matrixIndent'], matrixIndentation['aligned'])
461 |
462 | formatter = Formatter(indent, sep, mode, opSp, matInd)
463 | formatter.formatFile(sys.argv[1], start, end)
464 |
465 |
466 | if __name__ == '__main__':
467 | main()
468 |
--------------------------------------------------------------------------------
/formatter/test.m:
--------------------------------------------------------------------------------
1 | import util.*
2 | % ADD CORRECT INDENTATION
3 | function foo = myFun(a, b, c)
4 | % ADD SPACES BETWEEN EXPRESSIONS
5 |
6 | if a == '{' || a == '[' % bla
7 | N = norm(a .* b - c)
8 | % REMOVE ADDITIONAL SPACES
9 | foo = -N * a(3) / N
10 | % TREAT RATIONAL NUMBERS AND NEGATIVES AS SINGLE EXPRESSION
11 | r = 42/0.8e15
12 | d += 4.7e11
13 | neg = -r
14 | end
15 |
16 | try something; catch e; end; % bla
17 | % bla
18 | for k = 1:N
19 | % ADD INDENTATION AFTER LINE BREAK
20 | k++
21 |
22 | % comment
23 | t = a * k ...
24 | +b .* k^2 ... % comment
25 | +c * k^3
26 | vectorofstrings = ['α' 'β' 'γ'];
27 | vectorofstrings = ['α', 'β', 'γ'];
28 | vectorofstuff = ['foo' -dead('beef', 3.14, bar) -foo('bar', '42')]
29 |
30 | if (norm(t)) % ADD NEWLINE BEFORE AND AFTER BLOCK
31 | fprintf('Hello world \n');
32 | end;
33 |
34 | end
35 |
36 | % INDENT MATRICES SPLIT OVER MULTIPLE LINES
37 | M = [1 -2 3;
38 | 4 5 -6;
39 | -7 8 9] % REMOVE ADDITIONAL NEWLINES
40 |
41 | cellWithLongName = {1
42 | [2 3]'
43 | {1 M 'three'}};
44 |
45 | % exclude the next N (default=1) nonempty lines of code from formatting
46 | % formatter ignore N
47 | this=a *very* ill ^ formated+ loc
48 |
49 | end
50 |
--------------------------------------------------------------------------------
/formatter/test_post_formatter.m:
--------------------------------------------------------------------------------
1 | clear
2 |
3 | %{
4 | block comment
5 | %}
6 | for (i = 1:5)
7 |
8 | if (1 == 1)
9 | i = i + 1
10 | end
11 |
12 | end
13 |
14 | tmp = sprintf( ...
15 | 'Test strings: %s %s %s', ...
16 | "Apple", ... Apple
17 | "Banana", ... Banana
18 | "Pear" ... Pear
19 | );
20 |
--------------------------------------------------------------------------------
/images/example.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/affenwiesel/matlab-formatter-vscode/43d722441dc6fcc41b1048010610c6ffe2087755/images/example.gif
--------------------------------------------------------------------------------
/images/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/affenwiesel/matlab-formatter-vscode/43d722441dc6fcc41b1048010610c6ffe2087755/images/icon.png
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "matlab-formatter",
3 | "displayName": "matlab-formatter",
4 | "description": "format matlab code",
5 | "version": "2.11.0",
6 | "publisher": "AffenWiesel",
7 | "engines": {
8 | "vscode": "^1.20.0"
9 | },
10 | "repository": {
11 | "type": "git",
12 | "url": "https://github.com/affenwiesel/matlab-formatter-vscode"
13 | },
14 | "categories": [
15 | "Other"
16 | ],
17 | "keywords": [
18 | "matlab"
19 | ],
20 | "activationEvents": [
21 | "onLanguage:matlab"
22 | ],
23 | "main": "./extension",
24 | "icon": "images/icon.png",
25 | "contributes": {
26 | "configuration": {
27 | "title": "Matlab-formatter configuration",
28 | "type": "object",
29 | "properties": {
30 | "matlab-formatter.indentwidth": {
31 | "type": "integer",
32 | "default": 4,
33 | "description": "number of spaces used for indentation"
34 | },
35 | "matlab-formatter.separateBlocks": {
36 | "type": "boolean",
37 | "default": true,
38 | "description": "add newlines before and after blocks (for, if, etc.)"
39 | },
40 | "matlab-formatter.indentMode": {
41 | "type": "string",
42 | "enum": [
43 | "all_functions",
44 | "only_nested_functions",
45 | "classic"
46 | ],
47 | "enumDescriptions": [
48 | "Add indentation inside all functions and classdefs",
49 | "Only add indentation inside nested functions and class-methods",
50 | "No indentation of functions and classes (not recommended)"
51 | ],
52 | "default": "all_functions",
53 | "description": "indentation mode"
54 | },
55 | "matlab-formatter.addSpaces": {
56 | "type": "string",
57 | "enum": [
58 | "all_operators",
59 | "exclude_pow",
60 | "no_spaces"
61 | ],
62 | "enumDescriptions": [
63 | "Wrap all operators with spaces.",
64 | "Wrap all operators with spaces, except ^ and .^",
65 | "Don't wrap any operators with spaces. (not recommended)"
66 | ],
67 | "default": "all_operators",
68 | "description": "Wrapping of operators with spaces."
69 | },
70 | "matlab-formatter.matrixIndent": {
71 | "type": "string",
72 | "enum": [
73 | "aligned",
74 | "simple"
75 | ],
76 | "enumDescriptions": [
77 | "Keep rows of a matrix aligned.",
78 | "Use simpe indentation for matrices"
79 | ],
80 | "default": "aligned",
81 | "description": "Indentation of matrices"
82 | }
83 | }
84 | },
85 | "languages": [
86 | {
87 | "id": "matlab",
88 | "aliases": [
89 | "MATLAB"
90 | ]
91 | }
92 | ],
93 | "capabilities": {
94 | "documentFormattingProvider": "true",
95 | "documentRangeFormattingProvider": "true"
96 | }
97 | },
98 | "scripts": {
99 | "postinstall": "node ./node_modules/vscode/bin/install",
100 | "test": "node ./node_modules/vscode/bin/test"
101 | },
102 | "devDependencies": {
103 | "typescript": "^2.6.1",
104 | "vscode": "^1.1.6",
105 | "eslint": "^4.11.0",
106 | "@types/node": "^7.0.43",
107 | "@types/mocha": "^2.2.42"
108 | },
109 | "__metadata": {
110 | "id": "16f49f82-0071-4930-b6b5-b3e3ccd5fb0d",
111 | "publisherDisplayName": "AffenWiesel",
112 | "publisherId": "c3404b57-de97-47d7-8f81-b4955a94cc2e"
113 | }
114 | }
--------------------------------------------------------------------------------
/vsc-extension-quickstart.md:
--------------------------------------------------------------------------------
1 | # Welcome to your VS Code Extension
2 |
3 | ## What's in the folder
4 | * This folder contains all of the files necessary for your extension.
5 | * `package.json` - this is the manifest file in which you declare your extension and command.
6 | The sample plugin registers a command and defines its title and command name. With this information
7 | VS Code can show the command in the command palette. It doesn’t yet need to load the plugin.
8 | * `extension.js` - this is the main file where you will provide the implementation of your command.
9 | The file exports one function, `activate`, which is called the very first time your extension is
10 | activated (in this case by executing the command). Inside the `activate` function we call `registerCommand`.
11 | We pass the function containing the implementation of the command as the second parameter to
12 | `registerCommand`.
13 |
14 | ## Get up and running straight away
15 | * Press `F5` to open a new window with your extension loaded.
16 | * Run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `Hello World`.
17 | * Set breakpoints in your code inside `extension.js` to debug your extension.
18 | * Find output from your extension in the debug console.
19 |
20 | ## Make changes
21 | * You can relaunch the extension from the debug toolbar after changing code in `extension.js`.
22 | * You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
23 |
24 | ## Explore the API
25 | * You can open the full set of our API when you open the file `node_modules/vscode/vscode.d.ts`.
26 |
27 | ## Run tests
28 | * Open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Launch Tests`.
29 | * Press `F5` to run the tests in a new window with your extension loaded.
30 | * See the output of the test result in the debug console.
31 | * Make changes to `test/extension.test.js` or create new test files inside the `test` folder.
32 | * By convention, the test runner will only consider files matching the name pattern `**.test.js`.
33 | * You can create folders inside the `test` folder to structure your tests any way you want.
34 |
--------------------------------------------------------------------------------