CI should verify that files are appropriately formatted (UTF-8, newlines, whitespace...)

[kirthik]

We need a linter rule for catching this one.

Moving from Azure/azure-rest-api-specs#380

cc @lvh

[veronicagg]

is AutoRest doing this already? do we need to implement this in CI?

[dsgouda]

Wonder if this should be linterized or should AutoRest automatically format the file before processing. @olydis thoughts?

[fearthecowboy]

UTF-8 is all we produce.

We enforce LF line endings for certain extensions already, the rest are assumed to be CRLF. If there is one producing something not consistent with expectations, that can be updated.

G

[lvh]

@fearthecowboy The original linked issue (#380) shows a counterexample: re UTF-8 and LF/CRLF endings.

@veronicagg My suggestion for CI is mostly because the stuff you need to do to detect the problem is basically most of the work you need to do to get it in CI anyway, so I'd suggest doing it in CI to make sure that there are no regression instead of fixing it once :) The linked issue give some examples of commands you may want to run in CI; specifically, I'd suggest eclint and iconv.

I don't know what editor is popular among people who work on this but VS Code has a plugin for Editorconfig. https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig

[veronicagg]

@vishrutshah is this something you think could be added to CI?

[vishrutshah]

Based on the tool mentioned in the linked PR, Check is doable. I'd not prefer to correct those changes as part of the CI though.

@kirthik This should be moved back to the azure-rest-api-spec repo instead of autorest. Let me know if you think otherwise then i can reopen the previous issue and close this one.

[fearthecowboy]

reactivated in original repo