Add configuration option fail_on_warnings

[Jeehut]

This is a naive fix for #22. I tested this by installing my fork via Mint and it worked. I'm not sure if this is complete though, as I didn't write any tests or check if this also works as command line argument directly (I just tested via configuration file).

[ileitch]

Thanks for adding this! Mostly good, just a few wording changes.

Also please do test the command line argument, and add an entry to the CHANGELOG.

[ileitch]

Awesome thanks, could you add a changelog entry too?

[Jeehut]

I'm testing the command line argument at the moment and will add a CHANGELOG entry if no issues arise. Stay tuned ...

[Jeehut]

Do the command line arguments matter if there's a configuration file already? Cause it didn't work in my project when running periphery scan --strict with this configuration file:

project: NewProjectTemplate.xcodeproj
schemes: [App]
targets: [App, Tests, UITests]
report_exclude:
  - App/Generated/SwiftGen/*.swift
  - App/SupportingFiles/*.swift
retain_public: false
quiet: true

Running periphery scan with this configuration works though:

project: NewProjectTemplate.xcodeproj
schemes: [App]
targets: [App, Tests, UITests]
report_exclude:
  - App/Generated/SwiftGen/*.swift
  - App/SupportingFiles/*.swift
retain_public: false
strict: true
quiet: true

[ileitch]

Ah yes, you need to populate the configuration for command-line options. You'll need to do this in both ScanCommand and ScanSyntaxCommand, e.g:

https://github.com/peripheryapp/periphery/blob/master/Sources/PeripheryKit/Frontend/Commands/ScanCommand.swift#L48

[Jeehut]

Makes sense, I added it as suggested to both. Testing now ... will report once done.

Please note that I already added a CHANGELOG entry and used the conventions from the SwiftGen project (see their CHANGELOG) and the SwiftLint project (theirs) here, too since there's none yet. Feel free to change the structure if you want to use a different style, I just thought since this open sourced very recently you might not have thought about one yet.

[Jeehut]

Yes, it works both with periphery scan --strict and periphery scan-syntax --strict ..
Should be ready to merge! 🎉

[ileitch]

CHANGELOG format looks good 👍

[Jeehut]

@ileitch Thanks for reviewing and merging so quickly. 👍

Unfortunately the CHANGELOG doesn't seem to render like in the linked documents, where everything is on one line, but here it uses mutiple lines ... dunno why, but can be fixed over time, shouldn't be a huge problem. 😅

[ileitch]

Yep no worries, thanks for the submission!