feat(formatter): add monaco formatter for mdc

[adamdehaven]

Adds a monaco-editor formatting provider, along with updated usage instructions and unit tests.

[adamdehaven]

@farnabaz I have this working in my downstream project and have added it to the playground in this PR.

Let me know if I can make any updates or scenarios I didn't account for

[farnabaz]

Thanks @adamdehaven, This is great.
I tested it in the playground, but formatted does not run automatically while typing. Am I missing something?

I tried with putting editor.getAction('editor.action.formatDocument').run() in the editor, but in this case formatted will run once on load.

[adamdehaven]

I tested it in the playground, but formatted does not run automatically while typing. Am I missing something?

Ah yep @farnabaz I forgot to register the formatOnType provider 😅

I have updated the formatter, playground example, and the docs to configure formatOnType.

When typing in the playground, it will auto-format whenever you enter a newline \n character. Since this impacts the editor's default indentation (e.g. keeping you at the same level as you type) I added a parameter isFormatOnType: boolean to the formatter function so that the result respects this indentation rule when typing and formats as expected when formatting the entire document.

[adamdehaven]

I'm doing a little more refactoring to improve the formatting in some use cases, e.g. multiline strings, etc. so I changed the PR back to draft until I push a few optimizations.

Should be ready for review - give it a try in the Playground and let me know

[farnabaz]

Perfect 👍

One thing about the README.
Let's separate the use of highlighter and formatter in README to imply that they can be used separately.

[adamdehaven]

One thing about the README. Let's separate the use of highlighter and formatter in README to imply that they can be used separately.

Done.

Also added this note:

Note

Since the format provider utilizes spaces for indention, we will also configure the editor to insert spaces for tabs.