Local setting of SwiftLint

[RayZhao1998]

Now the Github Action's lint is strict mode but not local. Should we open strict mode local too?

And do we need adding a SwiftLint pre-commit hook to check before commit?

[lukepistrol]

As already said on Discord, my opinion:

Locally I'd prefer to not have strict mode enabled since it's more convenient to test/implement things without fixing small syntax inconsistencies. Once you are ready to commit you should then resolve all the warnings.

But I'm open to other's opinions.

[0xWDG]

I think it is a good idea, to set the local environment to strict.
Otherwise people will create a PR, and SwiftLint will fail, but not locally.

while in development you can always use:

• // swiftlint:disable RULENAME, // swiftlint:enable RULENAME
• // swiftlint:disable:next RULENAME
• // swiftlint:disable:previous RULENAME
• // swiftlint:disable all
• // swiftlint:enable all

Maybe it's a good idea to implement something like remove_todos.sh to check for // swiftlint:disable all, or // swiftlint:disable things, in case people forget them.

personally i think // swiftlint:disable RULENAME is placed intended, // swiftlint:disable all can never be intended.

[lukepistrol]

Good point. I agree

[RayZhao1998]

What about adding a pre-commit hook to forbid commit if swiftlint --strict failed and keep local environment normal?

[0xWDG]

What about adding a pre-commit hook to forbid commit if swiftlint --strict failed and keep local environment normal?

Yes and no,
If you make the local environment strict, then you'll see the errors in Xcode, otherwise only in the terminal.
personally i like it more if i see the errors in Xcode instead of the terminal.

[lukepistrol]

A agree with @wdg. I think no one will commit a build containing errors. And even if so we still have the workflow as a safe guard.