Swiftlint: Add ability to `autocorrect` a specified set of rules

[igorkotkovets]

Hello guys,

How about adding ability to run swiftlint autocorrect with specified set of rules? For example Xcode IDE automatically adds intended whitespaces if you press Enter.

So from my side it would be useful to resolve trailing_whitespace and vertical_whitespace issues automatically, by adding New Run Script phase and execute a command swiftlint autocorrect trailing_whitespace vertical_whitespace

Thanks in advance!

[marcelofabri]

You can change the Xcode behavior in this case:

(from this comment)

I'll keep it open as an enhancement though.

[sunshinejr]

I would actually love this feature. But wouldn't it be easier if we could use config values in e.g. .swiftlint.yml?

[hammadzz]

@sunshinejr I guess we could add a .swiftlint.yml that ignore all rules except trailing_whitespace and run autocorrect. That would work pretty well.

[sunshinejr]

I mean, whatever we need to do to make it work, I am all up for it :D

[nishigandhadoiphode]

ezs-MacBook-Pro:SwiftlintPods Nishigandha$ ./Pods/SwiftLint/swiftlint autocorrect
Loading configuration from '.swiftlint.yml'
Fatal error: Loading sourcekitd.framework/Versions/A/sourcekitd failed: file /Users/jsimard/Projects/SwiftLint/.build/checkouts/SourceKitten.git-6484296299232452758/Source/SourceKittenFramework/library_wrapper.swift, line 61
Illegal instruction: 4
ezs-MacBook-Pro:SwiftlintPods Nishigandha$

This is my error.When i try to do autocorrect then this comes to me. I searched alot for this error but i am not getting whats wrong with my implementation. Please help.

[marcelofabri]

@nishigandhadoiphode please file a new issue filling the issue template.

[Pe-te]

guess we could add a .swiftlint.yml that ignore all rules except trailing_whitespace and run autocorrect. That would work pretty well.

@hammadzz is there an easy way to create such a file? Unfrtunatelly this doesn't work:
`disabled_rules:

• all`

Would love the autocorrect parameter to correct only one rule, great idea!

[Pe-te]

With easy I mean a lot simpler than this! ;p

RULE=trailing_whitespace; ( echo "disabled_rules:"; swiftlint rules | grep -o -E '^\|[^|]*\| no' | cut -d" " -f1,2 | sed -e 's#|# -#' | grep -v "${RULE}" ) > ".swiftlint-only-${RULE}.yml" && swiftlint autocorrect --config ".swiftlint-only-${RULE}.yml" && rm ".swiftlint-only-${RULE}.yml"

[yasirmturk]

but this corrected all the pod files as well :D

[Pe-te]

@yasirmturk It did what? o_O

[yasirmturk]

fixed source code of all the Pod projects :P

[VivoEx]

@yasirmturk , You may need to specify the paths to exclude in your .yml file, the paths which you do not want to lint.. say,

excluded: # paths to ignore during linting. overridden by `included`.
  - Path/Pods

[Pe-te]

oh okay, I read/understood Podfiles, sorry

[yasirmturk]

this is what i did eventually and it has made my life so much easy 💯
create another file .swiftlint.auto.yml, which contains rules only i want to be auto-corrected and
edit swiftlint build phase script as follows

[VidyaRameshkumarEmis]

Yes, so did u mention the paths to exclude in your .swiftlint.auto.yml file ? if not, then it might have attempted to autocorrect all the files/folders in your swiftlint path.. for example if you have your pods folder in your swiftlint path then you would need to ask to exclude them.. Say for the same purpose mine would look something like below so autocorrect would not touch the excluded paths..

excluded: # paths to ignore during linting. overridden by `included`.
  - /ThirdPartyLibs
  - /Pods

disabled_rules: # rule identifiers to exclude from running
  - force_cast
  - todo

[yasirmturk]

yes i did and it runs perfectly..
.swiftlint.auto.yml is my own solution and the issue i mentioned was with the script that @Pe-te has written :)

[Pe-te]

Hehe, it worked on my project because Pods and Classes are two seperate folders here and I have the .swiftlint.yml only inside Classes and run swiftlint there. Maybe adding Pods as a default exclude would be a good option? Have you checked what it does to files in .svn and .git folders?

And I really wouldn't call that a script ... maybe a snippet ... it was more meant as insipiration for the developers. look how hard it is to run only one rule in autocorrect mode, please add this as a feature! puppy-eyes

[yhkaplan]

If anyone is interesting in one-off formatting for a single rule, I made a Swift script that runs a single rule from Swiftformat (not Swiftlint yet, sorry).

https://github.com/yhkaplan/swift-formatting-scripts/blob/master/format-only.swift

[Jeehut]

Hey everyone, I just want to inform you that I will be tackling this feature request now as I was kindly asked in this comment on the open source Corona-Warn-App in Germany to split my SwiftLint fixes up into smaller PRs and I was looking for fixing each rule one by one.

My approach will be going the direction suggested from @hammadzz to basically add a new option to the .swiftlint.yml file, I will name it limit_autocorrect_to and make it accept a list of rule identifiers. That way running swiftlint autocorrect should be restricted to just run autocorrect for these rules – everything else will be untouched.

I also considered introducing a more general enabled_rules that would take precedence over disabled_rules and opt_in_rules and just change the way SwiftLint works by default, then people could just provide a separate config file for the autocorrect command. But this seemed to be too much diagonal to the way SwiftLint was designed from the beginning (using the default set of rules) and also makes this specific use case require another file, which I think is an unnecessary hurdle.

I plan to finish this up within the next few hours, but let's see how it goes ... :)

[Jeehut]

Okay, forget what I just said, while implementing the feature I noticed that the alternative that I had considered (the enabled_rules method) is already implemented since 2016 (one year before this discussion even started) by @daniel-beard in https://github.com/realm/SwiftLint/pull/436 and released in version 0.8.0.

So, for anyone who is interested in running autocorrect for a specified set of rules, just use the approach outlined above in this comment from @yasirmturk.

Then in your separate configuration file for the autocorrection (e.g. .swiftlint.auto.yml), use the whitelist_rules option which is documented here in the README as following:

Acts as a whitelist, only the rules specified in this list will be enabled. Can not be specified alongside disabled_rules or opt_in_rules.

For example, your .swiftlint.auto.yml file might look something like this:

whitelist_rules:
  - comma
  - empty_parameters
  - trailing_comma
  - vertical_whitespace

trailing_comma:
  mandatory_comma: true

vertical_whitespace:
  max_empty_lines: 2

And you would run swiftlint autocorrect --config '.swiftlint.auto.yml' instead of just swiftlint autocorrect.

As you can see, with a separate config file & the whitelist_rules option, it is already possible to do this. Thus I think this issue can be closed. What do you think? @sunshinejr

Having this said, I have just posted https://github.com/realm/SwiftLint/pull/3236 as a documentation improvement that was suggested from @castus here to add the whitelist_rules option to the YAML example to make its existence more apparent to new users.

[jszumski]

Does using --config prevent you from using configuration inheritance in sub-directories with their own config files?

[yasirmturk]

Thanks @Jeehut but it would be great any way to have atleast a section for example

blacklist_autocorrect:
 - bla bla

so, anyone can still use the original .swiftlint.yml and just change the script to swiftlint autocorrect safely or there could be other approaches like

whitelist_autocorrect:
 - inherit <<special rule to inherit all whitelist rules if desired
 - additional_rule

in this case even the swiftline script can do the autocorrect job as well

[stale[bot]]

This issue has been automatically marked as stale because it has not had any recent activity. Please comment to prevent this issue from being closed. Thank you for your contributions!