mathworks / mathworks/MATLAB-extension-for-vscode

Feature Request - More Code Formatting Authority / Options

Open
#7 13 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
435
Forks
40
PR merge metrics
No merged PRs in 30d

Description

It would be incredibly useful for teams to be able to enforce code style guidelines a la something like clang-format. Additionally, features like those provided in clang-tidy for variable/function/class naming conventions would help teams to produce more uniform MATLAB codebases with minimal manual effort.

A simpler start to this could just include a "comfortable" vs. "compact" preference on auto formatting:
Comfortable: matlab_function(arg1, arg2, arg3);
Compact: matlab_function(arg1,arg2,arg3);

or
Comfortable: var = x * y;
Compact: var=x*y;

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the extension's existing MATLAB auto-formatting behavior and how VS Code settings are exposed. Define the scope for comfortable versus compact formatting and clang-format/clang-tidy-like naming rules; done requires an agreed, testable set of configurable formatting and naming options.

Written by the indexing model from the issue text.

Assessment

Tech stack
matlab, typescript, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.