Q# Formatter

[ScottCarda-MS]

Let's use this issue to collect feedback and gather ideas about implementing a formatter for Q# to help standardize a consistent coding style across Q# code.

Formatter Rules to Implement

Beta Give feedback

1. Correct Indentation Formatter Indentation and Delimiter Logic #1289
2. Correct Brace Style Formatter Indentation and Delimiter Logic #1289
3. Correct spacing around operators Basic Q# Formatter #1172
4. Correct spacing around type-annotation colon Basic Q# Formatter #1172
5. Correct spacing around parentheses, brackets, and commas (sequences) Formatter Indentation and Delimiter Logic #1289
6. Remove unnecessary newlines
7. Remove trailing commas in sequences with more than one element will be handled by the Linter
8. Remove duplicate semicolons will be handled by the Linter

Tasks

Beta Give feedback

1. Decide on data structures for formatter
2. Format document on save Basic Q# Formatter #1172
3. Format code snippets Format on Document Range #1275
4. Format on typing
5. Format in Playground Enable Formatter Playground #1307
6. Format Samples/Libraries Formatter: Remove Unauthoritative Newlines #1303
7. Add format of Samples/Libraries to build pipeline Check Samples and Libraries for Correct Format in Pipeline #1329
8. Use indentation style specified by VsCode (or other endpoint)
9. Support formatting around unary - and + not doable with this version of the formatter
10. Investigate removal of unauthoritative newlines Formatter: Remove Unauthoritative Newlines #1303