[formatter] Comment to let formatter ignore contents

[sharpchen]

Summary of the new feature

A common feature of formatter is to ignore formatting for rest of lines/range of lines with special comments.
I propose this feature because formatting rules in pssa are rather bold, you can't get a finer control on the style, so ignoring certain part can save my code from being messed up.

# ignore a range of lines

# pssa: ignore format start
echo foo
echo bar
# pssa: ignore format end

# ignore the rest of lines

# pssa: ignore format
echo foo

Proposed technical implementation details (optional)

What is the latest version of PSScriptAnalyzer at the point of writing

I don't know, I use powershell-editor-services

[bergmeister]

Can you elaborate more on use cases please @sharpchen ? Is it as workaround for formatter bugs to avoid them affecting rest of script? Just for your awareness, many formatting rules count indentation levels and braces so within an ignore block, you'd need to stay at same indentation and brace depth.

[sharpchen]

many formatting rules count indentation levels and braces so within an ignore block, you'd need to stay at same indentation and brace depth.

I understand that. This proposal was originally inspired by https://github.com/JohnnyMorganz/StyLua#ignoring-parts-of-a-file

Ignoring rest of lines isn't a proper idea, sorry about that.
I think it make sense for ignoring next line/scope, if we have a proper syntax tree behind.
Ignoring a range might be ambiguous to user though, I guess we can "ignore from next line to the end of current scope" when user specified a wrong "end"?

stylua does the similar in different phrasing:

Note that ignoring cannot cross scope boundaries - once a block is exited, formatting is re-enabled.