SwiftLint icon indicating copy to clipboard operation
SwiftLint copied to clipboard

Added Swiftlint helper reference README.md

Open vikas171999 opened this issue 1 year ago • 3 comments

Added Swiftlint helper reference So users can better plan tasks

vikas171999 avatar Jan 21 '24 14:01 vikas171999

Please help me to understand what this "SwiftLint helper" is supposed to do.

Also bear in mind, that SwiftLint can be run from the command line with a different "reporter" selected. With the --reporter option you can pick from a list of reporters which allow you to print the list of violations in different formats.

SimplyDanny avatar Jan 21 '24 17:01 SimplyDanny

Please help me to understand what this "SwiftLint helper" is supposed to do.

Also bear in mind, that SwiftLint can be run from the command line with a different "reporter" selected. With the --reporter option you can pick from a list of reporters which allow you to print the list of violations in different formats.

Okay let me tell what exactly you can do with swiftlint helper -

  1. It is a GUI way of getting violation counts in your last build by using build logs. So need not to do linting for every file which takes time for bigger projects. For a better understanding let me give you an example. Let's say you just built the project having n number of swiftlint warnings now you wanted to know the violation counts so in this case if you use to run --reporter command in commandline it first starts linting of all files and creates a violation file in a required format whereas if you use "Swiftlint Helper" It will immediately show the result on GUI and gives you the option to export in CSV, txt and xlsx format.

  2. With Swiftlint Helper you need not to do linting of files again if you decided at any moment that you want to export in any other format. So it is like export your logs once and trasform list of violation to any provided type.

Screenshot 2024-01-22 at 10 17 10 PM
  1. At the time of exporting logs XCode also gives option to Filter logs by issues, error or all . So at that time let's say if you want to get error counts or warning counts only then you can export filtered logs. And then SwiftLint Helper will give you filtered results.

  2. With Swiftlint Helper you can also compare the multiple build logs for analysing work very quickly.

So basically it helps in speeding up things. I believe these advantages are sufficient. if not let me know I can also create a tutorial video for you. Also How to use manual is already there in Swiftlint Helper

vikas171999 avatar Jan 22 '24 16:01 vikas171999

Hello @SimplyDanny can you please review this PR again. and let me know if any change needed

vikas171999 avatar Mar 07 '24 11:03 vikas171999