newline format

[ceuser1]

I use the command 'dotnet swagger tofile --output ..\clientlib\api.json $(OutputPath)$(AssemblyName).dll v1' as a post build command in my csproj file.

Currently the generated api.json file has LF as the newline character. Is it possible to make it CRLF?

[Havunen]

Can you explain why such functionality is needed?

[maxgruebneraeroqual]

Git thinks that CRLF/LF files are different. LF is the default for linux, and CRLF for windows.

If you're generating the files as part of a build on a windows system, where git is set to convert to CRLF on checkout (or the file is CRLF for whatever reason), the file is marked as changed, even if it's not.

It's a minor annoyance really. It would make sense if the swagger generation line ending matched the expected line ending type for the operating system the tool was run on, i.e. linux generates LF files, windows generates CRLF.

[martincostello]

We could maybe accept a PR to support this provided that we can pass the new line configurability through to whatever we use to generate the JSON in the first place. For example, System.Text.Json won't support this until .NET 9: dotnet/runtime#84117.

[Havunen]

One can also address the issue using gitattributes

[JordanBrobyn]

One can also address the issue using gitattributes

This looks like it may effect the EOL in the file but is there a solution to also apply to the generated summaries? Our summaries are writing as a string in the json which this gitattribute wont apply to.

For example

/// <summary>
/// Login providing username and password.
/// Request is rate limited.
/// <\summary>
/// <param name="model"></param>
/// <returns></returns>
[HttpPost("[action]")]
[AllowAnonymous]
[RateLimit]
public async Task<Result> Login([FromBody] UserLoginDTO model)
{
return await _accountService.Login(model);
}

Generates a swagger output in yaml as:

/api/Account/Login:
post:
tags:
- Account
summary: Login providing username and password\r\nRequest is rate limited.

Ideally we could have the clrf be consistent across Windows and OSX when generating as well.