SwiftLint icon indicating copy to clipboard operation
SwiftLint copied to clipboard

update to specify the proper active directory to docs

Open netskink opened this issue 2 years ago • 9 comments

This in reference to this issue

netskink avatar Oct 03 '23 23:10 netskink

I think these steps are already covered by this section, aren't they?

SimplyDanny avatar Oct 16 '23 18:10 SimplyDanny

No that is why I'm adding it to that section. Please search on Xcode select in that section and show me where it's mentioned.

netskink avatar Oct 16 '23 20:10 netskink

xcode-select isn't something specific for SwiftLint. It's the common way to switch between Xcode toolchains. Thus, we don't need to explain.

The section I mentioned definitely relates to it. The point is that Xcode must be installed; nothing more. SwiftLint looks for SourceKit at the locations listed there. xcode-select isn't needed at all. You may just set $XCODE_DEFAULT_TOOLCHAIN_OVERRIDE, $TOOLCHAIN_DIR or $TOOLCHAINS to make SwiftLint find special Xcodes at exotic locations.

That said, what might be left for the README is the fact that a full Xcode must be installed (preferably) at a default location. But this applies to all installation methods and should at most be mentioned there.

SimplyDanny avatar Oct 22 '23 18:10 SimplyDanny

Very good. Is these environment variables specified in the docs? If not would it be wise to specify?

netskink avatar Oct 22 '23 19:10 netskink

Very good. Is these environment variables specified in the docs? If not would it be wise to specify?

Yes, they are here.

SimplyDanny avatar Oct 22 '23 19:10 SimplyDanny

In the section titled "working with multiple swift versions"?

netskink avatar Oct 22 '23 19:10 netskink

In the section titled "working with multiple swift versions"?

Yes.

SimplyDanny avatar Oct 22 '23 20:10 SimplyDanny

So I only have one swift version installed. That section is a long way off from the initial installation instructions. Not to mention the section you referenced is not explicit to provide the correct procedure.

With that said do you still feel the documentation does not need to be modified?

After all this is a tool to make higher quality code and one aspect is that code be simplified and easier to understand, right?

netskink avatar Oct 22 '23 20:10 netskink

After all this is a tool to make higher quality code and one aspect is that code be simplified and easier to understand, right?

Yes, and one aspect of high quality is to avoid redundancy. I just want to make sure the README contains the relevant points but not more.

If you think the section is too far away from the "Installation" section, link to it from there or move it. Fine with me, if you mention xcode-select as a tool to change default Xcode installations. I really wouldn't do more here though.

SimplyDanny avatar Nov 06 '23 20:11 SimplyDanny