Use String instead of StaticString to be more inline with swift-log behaviour

[antranapp]

I am wrapping DiagnosticsLogger inside a LogHandler from swift-log package so that I can use swift-log as the main logger for my app.

But currently, Diagnostics is using StaticString for #file, #line, #function in the log method

swift-log is using String instead of StaticString for #file, #line, #function

I think, changing StaticString to String would make it more interoperable with swift-log and provides more flexibility to integrate with other libraries as well.

[wetransferplatform]

	Messages
📖	View more details on Bitrise
📖	DiagnosticsTests: Executed 30 tests (0 failed, 0 retried, 0 skipped) in 0.511 seconds

Code Coverage Report

Name	Coverage
Diagnostics	75.23%	⚠️

Generated by 🚫 Danger Swift against a6c1075

[BasThomas]

Thanks for your contribution, @antranapp! I'm inclined to agree with this change, but I do wonder why swift-log chose to go this route. Do you know more about that? Or a concrete example where we'd want to "override" a file or function reference?

[antranapp]

Hi @BasThomas, I found this issue explaining why swift-log uses String instead of StaticString

For my use case, I am wrapping DiagnosticsLogger inside a LogHandler provided by swift-log: https://github.com/antranapp/DebugPane_Diagnostics/blob/master/Sources/DebugPane_Diagnostics/DiagnosticsLogHandler.swift

The LogHandler protocol requires the parameters to be String instead of StaticString

With this, I can automatically get all the log that I handle globally inside my app.

[BasThomas]

Awesome, thanks for that!

I wonder if we should treat this as a breaking change — if any packages depend on this one, and expect a StaticString, that may be breaking. Would it be possible in any way to have these as overloads until we'd cut a version 4.0?

[AvdLee]

This has been requested before! #108 introduced it, but it's not a necessary requirement. I guess we can directly change it back to String and just release as 4.0.0 release since it's indeed breaking.

[BasThomas]

4.0 it is then 😊

[AvdLee]

I'll have a look at CI to make this PR green in the upcoming days!

[wetransferplatform]

Congratulations! 🎉 This was released as part of Release 4.0.0 🚀

Generated by GitBuddy