Unclear “Xcode scheme”/“Run script phase” Readme Instructions

[capnslipp]

New Issue Checklist

• Updated SwiftLint to the latest version
• I searched for existing GitHub issues

Describe the bug

The current README.md's setup instructions instruct the user to ”Integrate SwiftLint into an Xcode scheme to get warnings and errors displayed in the IDE. Just add a new "Run Script Phase" with:”.  I'm not sure what I'm supposed to do here.

The Scheme editor in Xcode doesn't have an option for Run Script Phase, only New Run Script Action.  Also, the instruction don't specify whether this should be a Pre-action or a Post-action.

Alternatively, the instructions may have meant “Integrate SwiftLint into an Xcode target”, in which case the instructions should be updated to reflect that.  (Targets and Schemes are distinctly different concepts in Xcode.)

I'm going to assume the latter for now and hope it works, simply based on the fact that Target scripts tend to be a more commonplace solution than Phase scripts.  However, I'd like some term-fixing for the sake of clarity in the readme— it should be either:

1. ”Integrate SwiftLint into an Xcode target to get warnings and errors displayed in the IDE. Just add a new "Run Script Phase" with:”, or
2. ”Integrate SwiftLint into an Xcode scheme to get warnings and errors displayed in the IDE. Just add a new Build Pre-action "Run Script Action" with:”

Complete output when running SwiftLint, including the stack trace and command used

Not relevant— this is an issue about the Markdown-formatted documentation.

Environment

Not relevant— this is an issue about the Markdown-formatted documentation.  Environment is the website at https://github.com/realm/SwiftLint/ (technically, https://github.com/realm/SwiftLint/blob/master/README.md).

[christiankm]

Good catch. Could certainly be improved.
I'll create a pull request now to correct this.

[capnslipp]

@christiankm Awesome, thanks!

May I also suggest specifying where in the build phase list the SwiftLint phase should go (e.g. before Compile Source, after Compile Source but before Link Binary, etc.). There have been a number of common Xcode build errors that have cropped up in the past when Apple drops a new Xcode version that are usually solved by having build phases in a sensical order. I imagine you know what order is “most correct” better than I do.

[marcelofabri]

A PR improving the instructions would be lovely!

[stale]

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!

[capnslipp]

#3290 looks good to me; can we merge this?

[jpsim]

I'll make some small edits to that PR and merge.

[christiankm]

I'll make some small edits to that PR and merge.

Sounds wonderful, thank you!

[jpsim]

67165f7