maxchuquimia
commented
3 years ago Hahaha... okay, we can do this 💪
I find it better to be as explicit as possible about these rules because things change between versions and this has caused trouble with multiple devs in the past. I like something like this for SwlftLint....:
opt_in_rules:
- closure_spacing
- overridden_super_call
- redundant_nil_coalescing
- prohibited_super_call
- explicit_init
- unused_import
- empty_parameters
- attributes
- closure_end_indentation
- collection_alignment
- trailing_comma
- convenience_type
- empty_collection_literal
- empty_count
- empty_enum_arguments
- empty_string
- extension_access_modifier
- file_name_no_space
- implicit_getter
- implicit_return
- joined_default_parameter
- modifier_order
- multiline_arguments
- multiline_literal_brackets
- multiple_closures_with_trailing_closure
- operator_usage_whitespace
- pattern_matching_keywords
- prefer_self_type_over_type_of_self
- unneeded_parentheses_in_closure_argument
- multiline_arguments_brackets
- multiline_function_chains
disabled_rules:
- file_length
- line_length
- type_body_length
- identifier_name
- type_name
- for_where
- todo
- nesting
- duplicate_enum_cases
- force_unwrapping
- force_cast
- trailing_whitespace
- function_body_length
- cyclomatic_complexity
- weak_delegate
custom_rules:
customrule_case_let:
regex: "case +\\.[A-Za-z0-9]*\\([^\n]*?(let )"
message: "Move 'let' to directly after 'case'"
capture_group: 1
customrule_force_vertical_alignment_with_whitespace:
regex: "[^ ]( {2,20})[:=]"
message: "Unexpected whitespace - reconsider spacing!"
capture_group: 1
customrule_string_contentsof:
regex: "String\\(contentsOf:"
message: "This could make a synchronous API call - reconsider or use String(contentsOfFile:) for loading local files"
customrule_init_nscoder:
regex: "required init[^\n]*: NSCoder\\) \\{(\n +[fp]| \\S+\"| precon)"
message: "Simplify to 'required init?(coder: NSCoder) { fatalError() }'"
capture_group: 1
customrule_blank_line_opening_class:
regex: "(class|extension) [A-Z][^{\n]*\\{[^\n}]*\n^[^\n]"
message: "Insert blank line after class/extension opening '{'"
# This is a bit of a cheeky one as it's only checking top-level classes.. but should still work as a teaching mechanism
customrule_blank_line_closing_class:
regex: " *(class|extension) [A-Z][^\n]*\n(\n [^\n]*|\n)+?\\}\n(\\})"
message: "Insert blank line before class/extension closing '}'"
capture_group: 3
included: # paths to include during linting. `--path` is ignored if present.
excluded: # paths to ignore during linting. Takes precedence over `included`.
- vendor
- "*.h"
- "*.m"
- .build
- Tests/SampleProjects
large_tuple:
warning: 5
trailing_comma:
mandatory_comma: true
multiline_arguments:
first_argument_location: next_line
(I'm a massive fan of blank lines at the top and bottom of extensions... they are pretty much taking over classes these days)
And for SwiftFormat:
--swiftversion 5
# format
--ifdef no-indent
--allman false
--elseposition same-line
--guardelse same-line
--wrapcollections before-first
--wraparguments before-first
--wrapparameters before-first
# file options
--exclude Tests/SampleProjects, .build
# rules
--enable AnyObjectProtocol,blankLinesAroundMark,blankLinesBetweenScopes,consecutiveBlankLines,consecutiveSpaces,duplicateImports,emptyBraces,hoistPatternLet,leadingDelimiters,linebreakAtEndOfFile,linebreaks,modifierOrder,preferKeyPath,redundantBackticks,redundantBreak,redundantExtensionACL,redundantFileprivate,redundantGet,redundantInit,redundantLet,redundantLetError,redundantNilInit,redundantObjc,redundantParens,redundantPattern,redundantSelf,redundantVoidReturnType,semicolons,spaceAroundBraces,spaceAroundBrackets,spaceAroundComments,spaceAroundGenerics,spaceAroundOperators,spaceAroundParens,spaceInsideBraces,spaceInsideBrackets,spaceInsideComments,spaceInsideGenerics,spaceInsideParens,strongOutlets,strongifiedSelf,todos,trailingSpace,typeSugar,void,wrap,wrapAttributes,isEmpty
--disable wrapMultilineStatementBraces,redundantReturn,sortedImports,numberFormatting,unusedArguments,andOperator,blankLinesAtEndOfScope,blankLinesAtStartOfScope,initCoderUnavailableIf you prefer, I can go through and make these changes over the weekend - regarding automation, we may as well do it properly from the start (we can have a pre-build phase in the scheme that prints warnings to a file before building, that way it's clear before committing that there are outstanding style guide issues).
rogerluan
Description
This PR is a proposal to lint the project, but not necessarily using the rules that I've applied myself.
I decided to lint the project because I noticed some code style weirdness that I have a personal preference to fix 🙈 and that are easy enough for a linter to resolve. So I decided to run 3 linters:
It's important to notice that I ran them in the order I've written above: first SwiftLint, the SwiftFormat, then manual. This is important because SwiftLint default rule set undoes some of the changes executed by SwiftFormat's default rule set (namely trailing commas in multiline dictionaries/sequences, in this particular project).
If you agree with this proposal, we can merge it as is and then add customization config files for each of the linters, and eventually perhaps automate the linting process somehow. Also, if this gets approved, then I can lint #7 as well 😊