CHANGELOG.md

Master

Breaking

• None.

Enhancements

• Validate implicit subscript getter in implicit_getter rule when using Swift 4.1.
  Marcelo Fabri #898

Bug Fixes

• None.

0.25.1: Lid Locked

This is the last release to support building with Swift 3.2 and Swift 3.3. The next release will require Swift 4.0 or higher to build.

Breaking

• None.

Enhancements

• Add LowerACLThanParent rule.
  Keith Smiley #2136

• Add UIOffsetMake to legacy_constructor rule.
  Nealon Young #2126

• Add a new excluded config parameter to the explicit_type_interface rule to exempt certain types of variables from the rule.
  Rounak Jain #2028

• Add empty_string opt-in rule to validate against comparing strings to "" instead of using .isEmpty.
  Davide Sibilio

• Add untyped_error_in_catch opt-in rule to warn against declaring errors without an explicit type in catch statements instead of using the implicit error variable.
  Daniel Metzing #2045

• Add all keyword for use in disable / enable statement: // swiftlint:disable all. It allows disabling SwiftLint entirely, in-code, for a particular section.
  fredpi #2071

• Adds --force-exclude option to lint and autocorrect commands, which will force SwiftLint to exclude files specified in the config excluded even if they are explicitly specified with --path.
  Ash Furrow #2051

• Adds discouraged_optional_collection opt-in rule to encourage the use of empty collections instead of optional collections.
  Ornithologist Coder #1885

• Add 4.1.0, 4.1.1 and 4.2.0 to Swift version detection.
  Norio Nomura #2143

• Support building with Swift 4.1.
  Norio Nomura #2038

Bug Fixes

• Fixes an issue with the yoda_condition rule where the severity would always display as a warning, and the reason would display as the severity type.
  Twig

• Fix TODOs lint message to state that TODOs should be resolved instead of avoided.
  Adonis Peralta #150

• Fix some cases where colon rule wouldn't autocorrect dictionary literals.
  Marcelo Fabri #2050

• Fix linux crash on sources with surrogate pair emojis as variable names.
  Cyril Lashkevich

• Make legacy_constructor rule more reliable, especially for autocorrecting.
  Marcelo Fabri #2098

• Fix colon rule autocorrect when preprocessor macros are present.
  Marcelo Fabri #2099

• Fix crash when saving cache if there're entries referring to the same path but with different capitalization.
  Marcelo Fabri #2032

• Fix several rules (empty_enum_arguments, explicit_init empty_parentheses_with_trailing_closure, joined_default_parameter, redundant_optional_initialization, redundant_void_return and unused_closure_parameter) rules autocorrection inside functions or other declarations.
  Marcelo Fabri

• Fix redundant_void_return rule autocorrect when preprocessor macros are present.
  John Szumski #2115

• Fix issue where the autocorrect done message used the plural form of "files" even if only 1 file changed.
  John Szumski

• Fix false positives in attributes rule when using Swift 4.1.
  Marcelo Fabri #2125 #2141

0.25.0: Cleaning the Lint Filter

Breaking

• None.

Enhancements

• Adds discouraged_optional_boolean opt-in rule to discourage the use of optional booleans.
  Ornithologist Coder #2011

Bug Fixes

• Fix some cases where colon rule wouldn't be autocorrected.
  Manabu Nakazawa

• Fix false positives in explicit_acl rule when declaring functions and properties in protocols or implementing deinit.
  Marcelo Fabri #2014

• Fix false negatives in unneeded_parentheses_in_closure_argument rule when using _ as one of the closure arguments.
  Marcelo Fabri #2017

• Fix several rules that use attributes when linting with a Swift 4.1 toolchain.
  Marcelo Fabri #2019

• Don't trigger violations in let_var_whitespace rule when using local variables when linting with a Swift 4.1 toolchain.
  Marcelo Fabri #2021

• Improve type_name rule violations to be positioned on the type name.
  Marcelo Fabri #2021

• Use SourceKit to validate associatedtype and typealias in type_name rule when linting with Swift 4.1.
  Marcelo Fabri #2021

• Fix some cases where violations would still be triggered when using the  ignores_function_declarations configuration of line_length rule.
   Manabu Nakazawa

• Fix false positive in empty_enum_arguments rule when using closures.
  Marcelo Fabri #2041

• Fix false positives in force_unwrapping rule when declaring functions that return implicitly unwrapped collections (for example [Int]! or [AnyHashable: Any]!).
  Marcelo Fabri #2042

• Fix directories with a .swift suffix being treated as files.
  Jamie Edge #1948

0.24.2: Dented Tumbler

Breaking

• None.

Enhancements

• None.

Bug Fixes

• No longer log if the indentation key isn't set in the configuration file.
  JP Simard #1998

0.24.1: Dented Tumbler

Breaking

• None.

Enhancements

• Invalidate cache when Swift patch version changes.
  Norio Nomura

• Add private_action opt-in rule which warns against public @IBAction methods.
  Ornithologist Coder #1931

• Add yoda_condition opt-in rule which warns when Yoda conditions are used. That is, when the constant portion of the expression is on the left side of a conditional statement.
  Daniel Metzing #1924

• Indentation can now be specified via a configuration file.
  Noah McCann RubenSandwich #319

• Add required_enum_case opt-in rule which allows enums that conform to protocols to require one or more cases. Useful for result enums.
  Donald Ritter

• Add discouraged_object_literal opt-in rule which encourages initializers over object literals.
  Ornithologist Coder #1987

• Adds prefixed_toplevel_constant opt-in rule which encourages top-level constants to be prefixed by k.
  Ornithologist Coder #1907

• Added explicit_acl opt-in rule to enforce explicit access control levels.
  Josep Rodriguez #1822

Bug Fixes

• Fix false positives in control_statement rule when methods with keyword names are used.
  Marcelo Fabri #1946

• Fix false positives in for_where rule when pattern matching (if case) is used.
  Marcelo Fabri #1968

• Fix false positives in unused_closure_parameter rule when closure is wrapped in parentheses.
  JP Simard #1979

0.24.0: Timed Dry

Breaking

• SwiftLint now requires Xcode 9 and Swift 3.2+ to build.
  Marcelo Fabri

• Remove SwiftExpressionKind.other.
  Marcelo Fabri

Enhancements

• Add sorted_first_last opt-in rule to encourage using min() or max() over sorted().first or sorted().last.
  Tom Quist #1932

• Add quick_discouraged_focused_test opt-in rule which warns against focused tests in Quick tests.
  Ornithologist Coder #1905

• Add override_in_extension opt-in rule that warns against overriding declarations in an extension.
  Marcelo Fabri #1884

• Add [f,x]{describe, context, itBehavesLike} to quick_discouraged_call rule.
  Ornithologist Coder #1903

• Add quick_discouraged_pending_test opt-in rule which warns against pending tests in Quick tests.
  Ornithologist Coder #1909

• Speed up equality tests for [Rule] and Configuration values.
  JP Simard

• Make Configuration conform to Hashable.
  JP Simard

• Speed up reading cached results by about 200%.
  JP Simard

• Add catch to the statements checked by the control_statement rule.
  JP Simard

• Make sorted_imports correctable.
  Samuel Susla JP Simard #1822

• Make sorted_imports only validate within "groups" of imports on directly adjacent lines.
  Samuel Susla JP Simard #1822

Bug Fixes

• Extend first_where and contains_over_first_not_nil rules to also detect cases where calls to filter and first are parenthesized.
  Tom Quist

• Correct equality tests for Configuration values. They previously didn't account for warningThreshold or cachePath.
  JP Simard

• Fix false positive in multiline_parameters rule when parameter is a closure with default value.
  Ornithologist Coder #1912

• Fix caching on Linux.
  JP Simard

• Fix crashes due to races.
  JP Simard

• Fix String.characters deprecation warnings when compiling with Swift 4.0.2.
  JP Simard

0.23.1: Rewash: Forgotten Load Edition

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix false positive in array_init rule when using a map that doesn't take a closure.
  Marcelo Fabri #1878

• superfluous_disable_command rule can now be disabled as expected when using // swiftlint:disable superfluous_disable_command.
  Marcelo Fabri #1890

0.23.0: Permanent Press Cycle

Breaking

• None.

Enhancements

• Fix csv reporter to output records with new lines.
  atetlaw

• Add contains_over_first_not_nil rule to encourage using contains over first(where:) != nil.
  Samuel Susla #1514

• Add fallthrough rule that flags usage of fallthrough.
  Marcelo Fabri #1834

• Improve colon rule to catch violations in dictionary types (e.g. [String: Int]), when using Any and on function calls.
  Marcelo Fabri #1074 #1389

• Add switch_case_alignment rule to validate that case and default statements are vertically aligned with their enclosing switch statement.
  Austin Lu

• Add array_init opt-in rule to validate that Array(foo) should be preferred over foo.map({ $0 }).
  Marcelo Fabri #1271

• Truncate long configuration console descriptions to fit in the console window when running swiftlint rules.
  JP Simard #1002

• Add multiline_arguments opt-in rule that warns to either keep all the arguments of a function call on the same line, or one per line.
  Marcel Jackwerth

• Add unneeded_break_in_switch rule to validate that no extra breaks are added in switch statements.
  Marcelo Fabri #1870

• Add literal_expression_end_indentation opt-in rule to validate that array and dictionary literals ends have the same indentation as the line that started them.
  Marcelo Fabri #1435

Bug Fixes

• Improve how opening_brace rule reports violations locations.
  Marcelo Fabri #1811

• Fix false negatives in unneeded_parentheses_in_closure_argument rule when using capture lists.
  Marcelo Fabri #1817

• Fix handling of attributes (lazy, objc, etc.) for the let_var_whitespace rule.
  David Catmull #1770 #1812

• Fix false positives in for_where rule when using if var inside for.
  Marcelo Fabri #1838

• Fix false positive in class_delegate_protocol rule when using Swift 4.0.1.
  Marcelo Fabri #1856

• Print multi-line configuration values in a single line when running swiftlint rules to avoid breaking the table format.
  JP Simard #1002

• Ignore SwiftLint commands (swiftlint:(disable|enable)) in file_header rule, making it work better with superfluous_disable_command rule.
  Marcelo Fabri #1810

• Fix false negatives in generic_type_name, identifier_name and type_name rules when using allowed_symbols.
  Marcelo Fabri

0.22.0: Wrinkle-free

Breaking

• Nested configurations will now be merged with parent configurations rather than replace them outright.
  Stéphane Copin JP Simard #676

Enhancements

• Add is_disjoint rule to encourage using Set.isDisjoint(with:) over Set.intersection(_:).isEmpty.
  JP Simard

• Add xctfail_message rule to enforce XCTFail calls to include a description of the assertion.
  Ornithologist Coder #1370

• Add joined_default_parameter correctable opt-in rule to discourage explicit usage of the default separator.
  Ornithologist Coder #1093 #1757

• Files with extensions other than .swift can now be used as arguments to --file when linting or autocorrecting.
  Marcelo Fabri #1721

• Allow ()?, Void?, ()!, and Void! as return types in redundant_void_return rule.
  Ryan Booker #1761

• Add single_test_class opt-in rule to validate that test files only contain a single QuickSpec or XCTestCase subclass.
  Ornithologist Coder #1779

• Produce an error when a // swiftlint:disable command does not silence any violations.
  JP Simard #1102

• Add quick_discouraged_call opt-in rule to discourage calls and object initialization inside 'describe' and 'context' block in Quick tests.
  Ornithologist Coder #1781

• Invalidate cache when Swift version changes.
  Marcelo Fabri

• Add pattern_matching_keywords opt-in rule to enforce moving let and var keywords outside tuples in a switch.
  Marcelo Fabri #202

• Add explicit_enum_raw_value opt-in rule to allow refactoring the Swift API without breaking the API contract.
  Mazyod #1778

• Add no_grouping_extension opt-in rule to disallow the use of extensions for code grouping purposes within the same file.
  Mazyod #1767

• Improve syntactic_sugar violation message to be type-specific.
  Marcelo Fabri #1803

• Add multiple_closures_with_trailing_closure rule that disallows trailing closure syntax when passing more than one closure argument to a function.
  Erik Strottmann #1801

Bug Fixes

• Fix false positive on force_unwrapping rule when declaring local variable with implicity unwrapped type.
  Otávio Lima #1710

• Fix the warning message and autocorrection of vertical_whitespace rule to display the maximum empty lines allowed if max_empty_lines is greater than 1.
  Hossam Ghareeb #1763

• Fix for the wrong configuration being used when using --path and a configuration exists in a parent directory.
  Marcelo Fabri #1744

• Fix false positive on unused_enumerated rule with complex variable bindings.
  Marcelo Fabri #1787

• Fix incorrect violations and autocorrections on unneeded_parentheses_in_closure_argument rule that were generated in some cases (mainly when using chained method calls with closures).
  Marcelo Fabri

0.21.0: Vintage Washboard

Breaking

• Xcode 8.3 or later and Swift 3.1 or later are required to build.
  Norio Nomura

Enhancements

• Rules are now categorized as lint, idiomatic, style, metrics or performance. Currently this is just used for documentation purposes when you run swiftlint rules or swiftlint generate-docs.
  Marcelo Fabri

• Add rules documentation generation.
  Marcelo Fabri #1078

• Add private_over_fileprivate correctable rule to check for top-level usages of fileprivate and recommend private instead. This is in line with SE-0169's goal "for fileprivate to be used rarely". There is a also a new strict_fileprivate opt-in rule that will mark every fileprivate as a violation (especially useful with Swift 4).
  Jose Cheyo Jimenez Marcelo Fabri #1469 #1058

• Add let_var_whitespace opt-in rule to enforce that let/var declarations should be separated from other statements by a single blank line.
  Uncommon #1461

• Improve performance when linting and correcting on Linux, matching macOS behavior.
  JP Simard #1577

• Don't trigger implicit_getter violations when attributes (such as mutating or @inline) are present.
  Marcelo Fabri #1309 #1589

• Add --use-tabs option to AutoCorrectOptions, enabling formatting using tabs over spaces.
  Cody Winton #1327

• Improve autocorrect performance by running it in parallel.
  Marcelo Fabri #1578

• Support building with Xcode 9 beta 3 in Swift 3.2 mode.
  JP Simard

• Add support for optional error severity level configuration.
  Jamie Edge Marcelo Fabri #1647

• Add unneeded_parentheses_in_closure_argument opt-in correctable rule that warns against using parentheses around argument declarations in closures.
  Marcelo Fabri #1483

• Add --disabled flag to swiftlint rules to print only rules that are not enabled in the configuration.
  Marcelo Fabri

• Add ignore_comment_only_lines boolean configuration option to file_length rule. With the option enabled, file_length will ignore lines which have only comments.
  Samuel Susla #1165

• Improve file_header rule description.
  Marcelo Fabri #1492

• Add trailing_closure opt-in rule that validates that trailing closure syntax should be used whenever possible.
  Marcelo Fabri #54

• Shebang (#!) in the beginning of a file is now ignored by all rules.
  Marcelo Fabri #1294

• Add block_based_kvo rule that enforces the usage of the new block based KVO API added when linting with Swift 3.2 or later.
  Marcelo Fabri #1714

• Make file_header rule ignore doc comments.
  Marcelo Fabri #1719

• Allow using environment variables in a configuration file in the form of ${SOME_VARIABLE}. The variables will be expanded when the configuration is first loaded.
  Marcelo Fabri #1512

• Treat yes, no, on and off as strings (and not booleans) when loading configuration files.
  Marcelo Fabri #1424

• Add discouraged_direct_init rule that discourages direct initialization of certain types.
  Ornithologist Coder #1306

Bug Fixes

• Fix false positive on redundant_discardable_let rule when using while statements.
  Marcelo Fabri #1669

• Fix all custom rules not being applied when any rule is configured incorrectly.
  Jamie Edge #1586

• Fix crash when using --config with a relative path and --path with a file.
  Marcelo Fabri #1694

• Fix mark rule corrections generating invalid code in some cases.
  Marcelo Fabri #1029

• Fix false positive in empty_enum_arguments rule when using wildcards and where clauses.
  Marcelo Fabri #1722

• Fix false positive in large_tuple rule when using throwing closure.
  Liquidsoul

• Make vertical_parameter_alignment more robust, fixing false positives and detecting previously missed violations.
  JP Simard #1488

0.20.1: More Liquid Fabric Softener

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix typo in FatalErrorMessageRule.
  Alexander Lash

• Don't trigger an extension_access_modifier violation when all extension members are open, as open extension is not supported by Swift.
  Marcelo Fabri #1629

• Don't trigger a vertical_parameter_alignment_on_call violation when trailing closures are used.
  Marcelo Fabri #1635

• Make vertical_parameter_alignment_on_call more flexible when multiline parameters are used.
  Marcelo Fabri #1630 #1643

• Use the directory's .swiftlint.yml when --path is used.
  Marcelo Fabri #1631

0.20.0: Liquid Fabric Softener

Breaking

• None.

Enhancements

• Detect more violations of force_unwrapping when using subscripts.
  Otávio Lima

• Match (Void) as return type in the void_return rule.
  Anders Hasselqvist

• Add multiline_parameters opt-in rule that warns to either keep all the parameters of a method or function on the same line, or one per line.
  Ornithologist Coder

• Update function_parameter_count rule to ignore overridden methods.
  Markus Gasser #1562

• Skip files with valid cache & no violations when auto correcting.
  Marcelo Fabri #1554

• Don't trigger violations from the private_unit_test rule when a method has parameters.
  Marcelo Fabri #1532

• Don't trigger violations from the discarded_notification_center_observer rule when the observer is being returned from a function that is not marked as @discardableResult.
  Marcelo Fabri #1525

• Add extension_access_modifier opt-in rule validating that if all the declarations in a given extension have the same Access Control Level, the ACL keyword should be applied to the top-level extension.
  Marcelo Fabri #1546

• Add vertical_parameter_alignment_on_call opt-in rule that validates that parameters are vertically aligned on a method call.
  Marcelo Fabri #1037

• Add code_literal and image_literal boolean configuration options to object_literal rule. They allow to only check for one or the other literal type instead of both together.
  Cihat Gündüz #1587

Bug Fixes

• Fix false positive in empty_enum_arguments rule when calling methods.
  Marcelo Fabri #1597

• Fix crash in unused_closure_parameter rule when using unicode identifiers.
  Woo-Sik Byun Marcelo Fabri

• Fix two false positives in force_unwrapping rule.
  Otávio Lima #614 #977 #1614

• Fix custom rules not working correctly with comment commands.
  JP Simard #1558

• Fix incorrectly using configuration files named .swiftlint.yml when they are located in the same directory as a differently-named, user-provided custom configuration file.
  JP Simard #1531

• Fix empty_count rule false positive in words that include "count".
  Marcelo Fabri #1622

• Use validates_start_with_lowercase key when decoding configurations for generic_type_name, identifier_name and type_name rules. This key was used on the docs, but internally validates_start_lowercase was used.
  Marcelo Fabri #1626

0.19.0: Coin-Operated Machine

Breaking

• Remove support for Swift 2.
  Marcelo Fabri #1453

• Remove missing_docs and valid_docs rules since they were already disabled.
  Marcelo Fabri #1453

• Add modificationDate(forFileAtPath:) function requirement to LintableFileManager protocol.
  Victor Pimentel

• Several breaking changes to LinterCache.
  Victor Pimentel JP Simard

• Remove Configuration.hash property.
  Victor Pimentel

• Rename ConditionalReturnsOnNewline struct to ConditionalReturnsOnNewlineRule to match rule naming conventions.
  JP Simard

Enhancements

• Cache linter results for files unmodified since the previous linter run.
  Victor Pimentel JP Simard Marcelo Fabri #1184 #1550

• Add opt-in configurations to generic_type_name, identifier_name and type_name rules to allow excluding non-alphanumeric characters and names that start with uppercase.
  Javier Hernández #541

• Adds support for excluded in custom rules to exclude files.
  Nigel Flack #1437

• Make trailing_comma rule autocorrectable.
  Samuel Susla Jeremy David Giesbrecht #1326

• Added no_extension_access_modifier opt-in rule to disallow access modifiers completely, à la SE-0119.
  Jose Cheyo Jimenez #1457

• Add lowercase and missing colon checks to the mark rule.
  Jason Moore

• Improve violation reason wording in function_body_length, large_type, and type_body_length rules.   ultimatedbz

• Add explicit_top_level_acl opt-in rule that validates that all top level declarations should explicitly be marked with an Access Control Level (private, fileprivate, internal, public or open).
  J. Cheyo Jimenez Marcelo Fabri #58

• Add implicit_return opt-in rule that warns against using the return keyword when it can be omitted inside closures.
  Marcelo Fabri #1194

• Add option to unused_optional_binding rule to ignore try? in guard statements.
  Sega-Zero #1432

• Add empty_enum_arguments correctable rule that warns against using silent associated values inside a case.
  Marcelo Fabri #1425 #1549

• Remove file.zip from the Pods directory when installing SwiftLint via CocoaPods.
  Hesham Salman #1507

• Add protocol_property_accessors_order correctable rule that validates that the order of accessors is get set when declaring variables in protocols.
  Marcelo Fabri #1504

• Make Region & Command structs conform to Equatable.
  JP Simard

• Make closure_spacing a CorrectableRule.
  J. Cheyo Jimenez

Bug Fixes

• emoji and checkstyle reporter output report sorted by file name.
  norio-nomura #1429

• Prevent false positive in shorthand_operator rule.
  sammy-SC #1254

• Fix typo in DiscardedNotificationCenterObserverRule.
  Spencer Kaiser

• Fix empty_parameters rule with Swift 3.
  Marcelo Fabri #1460

• Prevent triggering redundant_optional_initialization rule on a lazy var since it needs initialization.
  Marcelo Fabri #1334

• Fix ignores_case_statements key in cyclomatic_complexity description.
  Jeff Blagdon #1434

• Fall back to reporting violations on line 1 if no line was provided for the violation's location, ensuring Xcode always displays the warning or error.
  rjhodge JP Simard #1520

• Fix crash or incorrect violation location with strings including multi-byte unicode characters.
  Marcelo Fabri #1006

• Fix false positive in syntactic_sugar rule when using nested types named Optional, ImplicitlyUnwrappedOptional, Array or Dictionary.
  Marcelo Fabri #1508

• Fix false positives in prohibited_super_call & overridden_super_call rules where calls to super were done in nested scopes such as defer blocks.
  JP Simard #1301

• Fix non-root configurations logging configuration warnings more than once.
  JP Simard #949

• Fix some overlapping // swiftlint commands not being applied.
  JP Simard #1388

0.18.1: Misaligned Drum

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Compile releases in the 'Release' configuration rather than 'Debug'.

0.18.0: Misaligned Drum

Breaking

• Replace YamlSwift with Yams. SwiftLint no longer includes YamlSwift. If your project implicitly depends on YamlSwift, you need to modify it to depend on YamlSwift explicitly.
  norio-nomura #1412

• Yams interprets YAML more strictly than YamlSwift, so if your YAML configurations previously worked with SwiftLint but didn't fully conform to the YAML 1.2 standard, you'll need to fix those validation errors. For example:

  custom_rules:
    wrong_regex:
      name: "wrong regex"
      regex: "((assert|precondition)\(false)" # '\' in "" means escape sequence
    strict_regex:
      name: "strict regex"
      regex: '((assert|precondition)\(false)' # Use single quotes

Enhancements

• Support compiling with Xcode 8.3 and Swift 3.1.
  Keith Smiley

• Fix false positives on for_where rule and skip violation on complex conditions.
  Marcelo Fabri #1387

• Print YAML configuration errors in locatable format compatible with Xcode's Issue Navigator.
  

Bug Fixes

• Fix --lenient enforcement not being applied to all violations.
  aaroncrespo #1391

• Fix false positives in unused_optional_binding rule.
  Daniel Rodríguez Troitiño #1376

• Fix false positives in redundant_discardable_let rule.
  Jeremy David Giesbrecht #1415

0.17.0: Extra Rinse Cycle

Breaking

• variable_name rule (VariableNameRule) is now identifier_name (IdentifierNameRule) as it validates other identifiers as well.
  Marcelo Fabri #663

• Fix sorted_imports rule to sort ignoring case.
  Keith Smiley #1185

• Temporarily disable cache when linting. This will be re-enabled in a future version after important cache-related issues have been addressed.
  Marcelo Fabri

Enhancements

• Add implicitly_unwrapped_optional opt-in rule that warns against using implicitly unwrapped optionals, except cases when this IUO is an IBOutlet.
  Siarhei Fedartsou #56

• Performance improvements to generic_type_name, redundant_nil_coalescing, mark, first_where and vertical_whitespace rules.
  Marcelo Fabri

• Add discarded_notification_center_observer rule that warns when the result of NotificationCenter.addObserver(forName:object:queue:using:) is not stored so it can be removed later.
  Marcelo Fabri #1062

• Add notification_center_detachment rule that warns against an object removing itself from NotificationCenter in an unsafe location.
  Marcelo Fabri #1061

• Accept AnyObject and NSObjectProtocol in class_delegate_protocol.
  Jon Shier #1261

• Add ignores_function_declarations and ignores_comments as options to LineLengthRule.
  Michael L. Welles #598 #975

• Add for_where rule that validates that where is used in a for loop instead of a single if expression inside the loop.
  Marcelo Fabri #1228

• unused_enumerated rule now warns when only the index is being used. You should use .indices instead of .enumerated() in this case.
  Marcelo Fabri #1278

• Add ignores_case_statements as option to CyclomaticComplexityRule.
  Michael L. Welles #1298

• Add correctable redundant_discardable_let rule that warns when let _ = foo() is used to discard a result from a function instead of _ = foo().
  Marcelo Fabri #1232

• Accept global and local variables in implicit_getter rule.
  Marcelo Fabri

• Add --enabled (or -e) switch to the rules CLI command, to only display enabled rules.
  Natan Rolnik #1270

• Now nesting rule can be configured with a type and statement level.
  Hayashi Tatsuya #1318

• Add explicit_type_interface opt-in rule that validates that the properties have an explicit type interface.
  Kim de Vos

• Add --lenient CLI option to lint command. Facilitates running a lint task that doesn't fail a pipeline of other tasks.
  aaroncrespo #1322

• Add fatal_error_message opt-in rule that validates that fatalError() calls have a message.
  Kim de Vos #1348

Bug Fixes

• Fix crashes when accessing cached regular expressions when linting in parallel.
  JP Simard #1344

• Fix a false positive on large_tuple rule when using closures.
  Marcelo Fabri #1234

• Fix force_unwrap false positive for bool negation.
  Aaron McTavish #918

• Fix false positive and wrong correction on number_separator rule.
  Marcelo Fabri #1242

• Retain closure parameter types when they are specified during autocorrect.
  Allen Zeng #1175

• Fix redundant_void_return matches if return type starts with Void~.
  Hayashi Tatsuya

• Ignore unused_closure_parameter rule on closures that are called inline.
  Marcelo Fabri #1161

• Disable valid_docs and missing_docs rules when running in Swift 2.3 or later as they have not been updated to work with those versions of Swift. Both rules are now opt-in because of this.
  JP Simard #728

• Fix false positive on large_tuple rule when using generics inside a tuple.
  Marcelo Fabri #1257

• Make ASTRule default implementation to navigate through the substructure even if its children are from a different kind. This fixes some violations not being reported in some contexts.
  Marcelo Fabri #1237

• Reimplement switch_case_on_newline rule to be an ASTRule and be more reliable, fixing some false negatives and false positives.
  Marcelo Fabri #1268

• Fix closure_end_indentation rule false positive when using single-line closures.
  Marcelo Fabri #1216

• Fix todo rule messages when the comment is not on a new line.
  Marcelo Fabri #1304

• Fix false negative on unused_closure_parameter rule.
  Hayashi Tatsuya

• Fix checkstyle report format.
  Yuki Oya

0.16.1: Commutative Fabric Sheets

Breaking

• None.

Enhancements

• Improve unused_optional_binding rule on tuples check.
  Rafael Machado

• Update variable_name to ignore overrides.
  Aaron McTavish #1169

• Update number_separator rule to allow for specifying minimum length of fraction.
  Bjarke Søndergaard #1200

• Update legacy_constant rule to support CGFloat.pi and Float.pi.
  Aaron McTavish #1198

Bug Fixes

• Fix false positives on shorthand_operator rule.
  Marcelo Fabri #1156 #1163

• Fix false positive on redundant_optional_initialization rule.
  Marcelo Fabri #1159

• Fix false positive on operator_usage_whitespace rule with decimal literals in exponent format.
  Marcelo Fabri #1153

• Fix excluded configuration not excluding files.
  Marcelo Fabri #1166

• Disable commutative operations on shorthand_operator rule.
  Marcelo Fabri #1182 #1183 #1211

• Fix crash when running in a Sandboxed environment, which also fixes Homebrew distribution. Set the SWIFTLINT_SWIFT_VERSION environment variable to either 2 or 3 to force that operation mode, bypassing the Swift version determined from SourceKit.
  JP Simard

0.16.0: Maximum Energy Efficiency Setting

Breaking

• Several API breaking changes were made to conform to the Swift 3 API Design Guidelines. We apologize for any inconvenience this may have caused.

Enhancements

• Speed up linting by caching linter results across invocations.
  Marcelo Fabri #868

• Speed up linting by processing multiple files and rules concurrently.
  JP Simard #1077

• Make many operations in SwiftLintFramework safe to call in multithreaded scenarios, including accessing Linter.styleViolations.
  JP Simard #1077

• Permit unsigned and explicitly-sized integer types in valid_ibinspectable
  Daniel Duan

• Make nimble_operator rule correctable.
  Vojta Stavik

• Add vertical_parameter_alignment rule that checks if parameters are vertically aligned for multi-line function declarations.
  Marcelo Fabri #1033

• Add more helpful reason strings to TrailingCommaRule.
  Matt Rubin

• Add class_delegate_protocol rule that warns against protocol declarations that aren't marked as : class or @objc.
  Marcelo Fabri #1039

• Add correctable redundant_optional_initialization rule that warns against initializing optional variables with nil.
  Marcelo Fabri #1052

• redundant_nil_coalescing rule is now correctable.
  Marcelo Fabri

• Make number_separator rule correctable.
  Marcelo Fabri

• empty_parentheses_with_trailing_closure rule is now correctable.
  Marcelo Fabri

• Add correctable redundant_void_return rule that warns against explicitly adding -> Void to functions.
  Marcelo Fabri #1066

• Add an opt-in rule that enforces alphabetical sorting of imports.
  Scott Berrevoets #900

• type_name rule forces enum values to be UpperCamelCase again when used with Swift 2.3.
  Marcelo Fabri #1090

• Make weak_delegate rule ignore computed properties.
  Rafael Machado #1089

• Add object_literal opt-in rule that warns against using image and color inits that can be replaced for #imageLiteral or #colorLiteral in Swift 3.
  Marcelo Fabri #1060

• Now number_separator rule can be configured with a minimum length.
  Marcelo Fabri #1109

• Add compiler_protocol_init rule that flags usage of initializers declared in protocols used by the compiler such as ExpressibleByArrayLiteral that shouldn't be called directly. Instead, you should use a literal anywhere a concrete type conforming to the protocol is expected by the context.
  Marcelo Fabri #1096

• Add large_tuple configurable rule that validates that tuples shouldn't have too many members.
  Marcelo Fabri #1065

• Add generic_type_name rule that validates generic constraint type names.
  Marcelo Fabri #51

• Update vertical_whitespace rule to allow configuration of the number of consecutive empty lines before a violation using max_empty_lines. The default value is still 1 line.
  Aaron McTavish #769

• Add check to ignore urls in line_length rule when ignores_urls configuration is enabled.
  Javier Hernández #384

• Add shorthand_operator rule that validates that shorthand operators should be used when possible.
  Marcelo Fabri #902

• Allow specifying a swiftlint_version configuration key which will log a warning if the current running version of SwiftLint is different than this value.
  JP Simard #221

• Add internal support for deprecated rule aliases.
  Marcelo Fabri #973

• Add unused_optional_binding rule that will check for optional bindings not being used.
  Rafael Machado #1116

Bug Fixes

• Ignore close parentheses on vertical_parameter_alignment rule.
  Marcelo Fabri #1042

• syntactic_sugar rule now doesn't flag declarations that can't be fixed.
  Marcelo Fabri #928

• Fix false positives on closure_parameter_position and unused_closure_parameter rules with Swift 2.3.
  Marcelo Fabri #1019

• Fix crash on trailing_comma rule with Swift 2.3.
  Marcelo Fabri #921

• Fix out of range exception in AttributesRule.
  JP Simard #1105

• Fix variable_name and type_name rules on Linux.
  Marcelo Fabri

• Fix linting directories with names ending with .swift.
  JP Simard

• Fix running swiftlint version when building with Swift Package Manager.
  Marcelo Fabri #1045

• Fix false positive on vertical_parameter_alignment rule when breaking line in a default parameter declaration.
  Marcelo Fabri #1129

0.15.0: Hand Washable Holiday Linens 🎄

Breaking

• line_length rule now has a default value of 120 for warnings.
  Marcelo Fabri #1008

Enhancements

• Add closure_end_indentation opt-in rule that validates closure closing braces according to these rules:

  • If the method call has chained breaking lines on each method (. is on a new line), the closing brace should be vertically aligned with the ..
  • Otherwise, the closing brace should be vertically aligned with the beginning of the statement in the first line.

  Marcelo Fabri #326

• operator_usage_whitespace rule is now correctable.
  Marcelo Fabri

• implicit_getter and mark rule performance improvements.
  Marcelo Fabri

• HTML reports now display a relative path to files.
  Jamie Edge

• colon rule now validates colon position in dictionaries too. You can disable this new validation with the apply_to_dictionaries configuration.
  Marcelo Fabri #603

• Add first_where opt-in rule that warns against using .filter { /* ... */ }.first in collections, as .first(where: { /* ... */ }) is often more efficient.
  Marcelo Fabri #1005

Bug Fixes

• FunctionParameterCountRule also ignores generic initializers.
  Mauricio Hanika

• Grammar checks.
  Michael Helmbrecht

• Fix the validity and styling of the HTML reporter.
  Jamie Edge

• Fix false positive in empty_parentheses_with_trailing_closure rule.
  Marcelo Fabri #1021

• Fix false positive in switch_case_on_newline when switching over a selector.
  Marcelo Fabri #1020

• Fix crash in closure_parameter_position rule.
  Marcelo Fabri #1026

• Fix false positive in operator_usage_whitespace rule when using image literals.
  Marcelo Fabri #1028

0.14.0: Super Awesome Retractable Drying Rack

Breaking

• SwiftLint now requires Xcode 8.x and Swift 3.x to build. APIs have not yet been adapted to conform to the Swift 3 API Design Guidelines but will shortly.
  JP Simard Norio Nomura

Enhancements

• Now builds and passes most tests on Linux using the Swift Package Manager with Swift 3. This requires libsourcekitdInProc.so to be built and located in /usr/lib, or in another location specified by the LINUX_SOURCEKIT_LIB_PATH environment variable. A preconfigured Docker image is available on Docker Hub by the ID of norionomura/sourcekit:302.
  JP Simard Norio Nomura #732

• Add dynamic_inline rule to discourage combination of @inline(__always) and dynamic function attributes.
  Daniel Duan

• Add number_separator opt-in rule that enforces that underscores are used as thousand separators in large numbers.
  Marcelo Fabri #924

• Add file_header opt-in rule that warns when a file contains a copyright comment header, such as the one Xcode adds by default.
  Marcelo Fabri #844

• FunctionParameterCountRule now ignores initializers.
  Denis Lebedev #544

• Add EmojiReporter: a human friendly reporter.
  Michał Kałużny

• Add redundant_string_enum_value rule that warns against String enums with redundant value assignments.
  Marcelo Fabri #946

• Add attributes opt-in rule which validates if an attribute (@objc, @IBOutlet, @discardableResult, etc) is in the right position:

  • If the attribute is @IBAction or @NSManaged, it should always be on the same line as the declaration
  • If the attribute has parameters, it should always be on the line above the declaration
  • Otherwise:
    • if the attribute is applied to a variable, it should be on the same line
    • if it's applied to a type or function, it should be on the line above
    • if it's applied to an import (the only option is @testable import), it should be on the same line. You can also configure what attributes should be always on a new line or on the same line as the declaration with the always_on_same_line and always_on_line_above keys.

  Marcelo Fabri #846

• Add empty_parentheses_with_trailing_closure rule that checks for empty parentheses after method call when using trailing closures.
  Marcelo Fabri #885

• Add closure_parameter_position rule that validates that closure parameters are in the same line as the opening brace.
  Marcelo Fabri #931

• type_name rule now validates typealias and associatedtype too.
  Marcelo Fabri #49 #956

• Add ProhibitedSuperRule opt-in rule that warns about methods calling to super that should not, for example UIViewController.loadView().
  Aaron McTavish #970

• Add correctable void_return rule to validate usage of -> Void over -> ().
  Marcelo Fabri JP Simard #964

• Add correctable empty_parameters rule to validate usage of () -> over Void -> .
  Marcelo Fabri #573

• Add operator_usage_whitespace opt-in rule to validate that operators are surrounded by a single whitespace when they are being used.
  Marcelo Fabri #626

• Add unused_closure_parameter correctable rule that validates if all closure parameters are being used. If a parameter is unused, it should be replaced by _.
  Marcelo Fabri JP Simard #982

• Add unused_enumerated rule that warns against unused indexes when using .enumerated() on a for loop, e.g. for (_, foo) in bar.enumerated().
  Marcelo Fabri #619

Bug Fixes

• Fix weak_delegate rule reporting a violation for variables containing but not ending in delegate.
  Phil Webster

• Fix weak_delegate rule reporting a violation for variables in protocol declarations.
  Marcelo Fabri #934

• Fix trailing_comma rule reporting a violation for commas in comments.
  Marcelo Fabri #940

• Fix XML reporters not escaping characters.
  Fabian Ehrentraud #968

• Fix specifying multiple rule identifiers in comment commands.
  JP Simard #976

• Fix invalid CSS in HTML reporter template.
  Aaron McTavish #981

• Fix crash when correcting statement_position rule when there are multi-byte characters in the file.
  Marcelo Fabri

0.13.2: Light Cycle

Breaking

• None.

Enhancements

• TrailingCommaRule now only triggers when a declaration is multi-line when using mandatory_comma: true.
  Marcelo Fabri #910 #911

Bug Fixes

• Fix MarkRule reporting a violation for // MARK: -, which is valid.
  JP Simard #778

0.13.1: Heavy Cycle

Breaking

• None.

Enhancements

• Add ImplicitGetterRule to warn against using get on computed read-only properties.
  Marcelo Fabri #57

• Add WeakDelegateRule rule to enforce delegate instance variables to be marked as weak.
  Olivier Halligon

• Add SyntacticSugar rule that enforces that shorthanded syntax should be used when possible, for example [Int] instead of Array<Int>.
  Marcelo Fabri #319

• Allow specifying multiple rule identifiers in comment commands. For example, // swiftlint:disable:next force_cast force_try. Works with all command types (disable/enable) and modifiers (next, this, previous or blank).
  JP Simard #861

• Add NimbleOperatorRule opt-in rule that enforces using operator overloads instead of free matcher functions when using Nimble.
  Marcelo Fabri #881

• closure_spacing rule now accepts empty bodies with a space.
  Marcelo Fabri #875

• Add TrailingCommaRule to enforce/forbid trailing commas in arrays and dictionaries. The default is to forbid them, but this can be changed with the mandatory_comma configuration.
  Marcelo Fabri #883

• Add support for fileprivate in PrivateOutletRule and PrivateUnitTestRule.
  Marcelo Fabri #781 #831

• Make MarkRule correctable.
  kohtenko

Bug Fixes

• Rule out a few invalid @IBInspectable cases in valid_ibinspectable.
  Daniel Duan

• Fix a few edge cases where malformed MARK: comments wouldn't trigger a violation.
  JP Simard #805

• Now lints single files passed to --path even if this file is excluded from the configuration file (.swiftlint.yml).
  JP Simard

• Fixed error severity configuration in colon rule.
  Marcelo Fabri #863

• switch_case_on_newline rule should ignore trailing comments.
  Marcelo Fabri #874

• switch_case_on_newline rule shouldn't trigger on enums.
  Marcelo Fabri #878

• Fix regex bug in Comma Rule causing some violations to not be triggered when there were consecutive violations in the same expression.
  Savio Figueiredo #872

0.13.0: MakeYourClothesCleanAgain

Breaking

• None.

Enhancements

• Add ignores_comment configuration for trailing_whitespace rule.
  Javier Hernández #576

• Added HTML reporter, identifier is html.
  Johnykutty Mathew

• Add SuperCallRule opt-in rule that warns about methods not calling to super.
  Angel G. Olloqui #803

• Add RedundantNilCoalesingRule opt-in rule that warns against ?? nil.
  Daniel Beard #764

• Added opt-in rule to makes closure expressions spacing consistent.
  J. Cheyo Jimenez #770

• Adds allow_private_set configuration for the private_outlet rule.
  Rohan Dhaimade

• Swift 2.3 support.
  Norio Nomura, Syo Ikeda

• Color literals count as single characters to avoid unintentional line length violations.
  Jonas #742

• Add SwitchCaseOnNewlineRule opt-in rule that enforces a newline after case pattern: in a switch.
  Marcelo Fabri #681

• Add ValidIBInspectableRule rule that checks if @IBInspectable declarations are valid. An @IBInspectable is valid if:

  • It's declared as a var (not let)
  • Its type is explicit (not inferred)
  • Its type is one of the supported types

  Marcelo Fabri #756

• Add ExplicitInitRule opt-in rule to discourage calling init directly.
  Matt Taube #715

Bug Fixes

• Fixed whitespace being added to TODO messages.
  W. Bagdon #792

• Fixed regex bug in Vertical Whitespace Rule by using SourceKitten instead. The rule now enabled by default again (no longer opt-in).
  J. Cheyo Jimenez #772

• Correctable rules no longer apply corrections if the rule is locally disabled.
  J. Cheyo Jimenez
  #601

• Fixed regex bug in Mark Rule where MARK could not be used with only a hyphen but no descriptive text: // MARK: -.
  Ruotger Deecke #778

• Fixed: Private unit test rule not scoped to test classes.
  Fixed: Private unit test rule config is ignored if regex is missing.
  Cristian Filipov #786

• Fixed: ConditionalReturnsOnNewline now respects severity configuration.
  Rohan Dhaimade #783

• Fixed: ConditionalReturnsOnNewline now checks if return is a keyword, avoiding false positives.
  Marcelo Fabri #784

• ForceUnwrappingRule did not recognize force unwraps in return statements using subscript.
  Norio Nomura #813

0.12.0: Vertical Laundry

Breaking

• Fixed: SwiftLint assumes paths in the YAML config file are relative to the current directory even when --path is passed as an argument.
  Cristian Filipov

Enhancements

• Add --enable-all-rules CLI option to lint command to facilitate running all rules, even opt-in and disabled ones, ignoring whitelist_rules.
  JP Simard #1170

Bug Fixes

• Made Vertical Whitespace Rule added in 0.11.2 opt-in due to performance issues.
  JP Simard #772

0.11.2: Communal Clothesline

This release has seen a phenomenal uptake in community contributions!

Breaking

• None.

Enhancements

• Add MarkRule rule to enforce // MARK syntax.
  Krzysztof Rodak #749

• Add PrivateOutletRule opt-in rule to enforce @IBOutlet instance variables to be private.
  Olivier Halligon

• Add content of the todo statement to message.
  J. Cheyo Jimenez #478

• Add LegacyNSGeometryFunctionsRule rule. Add NSSize, NSPoint, and NSRect constants and constructors to existing rules.
  David Rönnqvist

• Added Vertical Whitespace Rule.
  J. Cheyo Jimenez #548

• Removed ConditionalBindingCascadeRule.
  J. Cheyo Jimenez #701

• Allow setting flexible_right_spacing configuration for the colon rule.
  Shai Mishali #730

• Add Junit reporter.
  Matthew Ellis

• LeadingWhitespaceRule is now auto correctable.
  masters3d

• Add included regex for custom rules to control what files are processed.
  bootstraponline #689

• Add rule to check for private unit tests (private unit tests don't get run by XCTest).
  Cristian Filipov

• Add configuration for setting a warning threshold.
  woodhamgh 696

• Adds 'ConditionalReturnsOnNewLineRule' rule.
  Rohan Dhaimade

• Made - returns: doc optional for initializers.
  Mohpor #557

Bug Fixes

• Fixed CustomRule Regex.
  J. Cheyo Jimenez #717 #726

• Allow disabling custom rules in code.
  J. Cheyo Jimenez #515

• Fix LegacyConstructorRule when using variables instead of numbers.
  Sarr Blaise #646

• Fix force_unwrapping false positive inside strings.
  Daniel Beard #721

0.11.1: Cuddles... Or Else!

Breaking

• None.

Enhancements

• Added statement_mode configuration to the statement_position rule. The
  default mode keeps the current SwiftLint behavior of keeping else and catch statements on the same line as the closing brace before them. The uncuddled_elseconfiguration requires the else and catch to be on a new line with the same leading whitespace as the brace.
  Mike Skiba #651

Bug Fixes

• Remove extraneous argument label added in LegacyCGGeometryFunctionsRule autocorrect.
  Sarr Blaise 643

0.11.0: Laundromat Format

Breaking

• Now type_name allows lowercase enum values to match the Swift API Design Guidelines.
  Jorge Bernal #654

• Embedding frameworks needed by swiftlint was moved from SwiftLintFramework Xcode target to the swiftlint target. The SwiftLintFramework.framework product built by the SwiftLintFramework target no longer contains unnecessary frameworks or multiple copies of the Swift libraries.
  Norio Nomura

Enhancements

• Add --format option to autocorrect command which re-indents Swift files much like pasting into Xcode would. This option isn't currently configurable, but that can change if users request it.
  JP Simard

• Improve error messages for invalid configuration files.
  Brian Hardy

• Added the user-configurable option ignores_empty_lines to the trailing_whitespace rule. It can be used to control whether the TrailingWhitespaceRule should report and correct whitespace-indented empty lines. Defaults to false. Added unit tests.
  Reimar Twelker

Bug Fixes

• Fix false positive in conditional binding cascade violation.
  Norio Nomura #642

• Another conditional binding fix, this time for enum that has two parameters or an if statement with two case tests.
  Andrew Rahn #667

• Fix regression in CommaRule ignoring violations when the comma is followed by a comment.
  Norio Nomura #683

0.10.0: laundry-select edition

Breaking

• None.

Enhancements

• Now libclang.dylib and sourcekitd.framework are dynamically loaded at runtime by SourceKittenFramework to use the versions included in the Xcode version specified by xcode-select -p or custom toolchains.
  Norio Nomura #167

• Add LegacyCGGeometryFunctionsRule rule.
  Sarr Blaise #625

• SwiftLint no longer crashes when SourceKitService crashes.
  Norio Nomura

• Rewrite conditional_binding_cascade rule.
  Norio Nomura #617

• Add autocorrect for ReturnArrowWhitespaceRule.
  Craig Siemens

Bug Fixes

• Failed to launch swiftlint when Xcode.app was placed at non standard path.
  Norio Nomura #593

• ClosingBraceRule no longer triggers across line breaks.
  Josh Friend #592

• LegacyConstantRule and LegacyConstructorRule failed to autocorrect.
  Norio Nomura #623

0.9.2: Multiple Exhaust Codes

Breaking

• None.

Enhancements

• Return different exit codes to distinguish between types of errors:

  • 0: No errors, maybe warnings in non-strict mode
  • 1: Usage or system error
  • 2: Style violations of severity "Error"
  • 3: No style violations of severity "Error", but violations of severity "warning" with --strict
    JP Simard #166

• VariableNameRule now accepts symbols starting with more than one uppercase letter to allow for names like XMLString or MIMEType.
  Erik Aigner #566

Bug Fixes

• Avoid overwriting files whose contents have not changed.
  Neil Gall #574

• Fix CommaRule mismatch between violations and corrections.
  Norio Nomura #466

• Fix more false positives in ForceUnwrappingRule.
  Norio Nomura #546 #547

0.9.1: Air Duct Cleaning

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix force unwrap rule missed cases with quotes.
  Norio Nomura #535

• Fix issues with nested .swiftlint.yml file resolution.
  Norio Nomura #543

0.9.0: Appliance Maintenance

Breaking

• Linter.reporter has been removed and Configuration.reporterFromString(_:) has been renamed to a free function: reporterFromString(_:).
  JP Simard

• _ConfigProviderRule & ConfigurableRule have been removed and their requirements have been moved to Rule.
  JP Simard

• Configuration(path:optional:silent) has been changed to Configuration(path:rootPath:optional:quiet:).
  JP Simard

• The static function Configuration.rulesFromDict(_:ruleList:) has been moved to an instance method: RuleList.configuredRulesWithDictionary(_:).
  JP Simard

• The rules parameter in the Configuration initializer has been renamed to configuredRules.
  JP Simard

• Removed a large number of declarations from the public SwiftLintFramework API. This is being done to minimize the API surface area in preparation of a 1.0 release. See #507 for a complete record of this change.
  JP Simard #479

• All instances of the abbreviation "config" in the API have been expanded to "configuration". The --config command line parameter and use_nested_configs configuration key are unaffected.
  JP Simard

• The use_nested_configs configuration key has been deprecated and its value is now ignored. Nested configuration files are now always considered.
  JP Simard

Enhancements

• swiftlint lint now accepts an optional --reporter parameter which overrides existing reporter values in the configuration file. Choose between xcode (default), json, csv or checkstyle.
  JP Simard #440

• swiftlint rules now shows a configuration description for all rules.
  JP Simard

• lint and autocorrect commands now accept a --quiet flag that prevents status messages like 'Linting ' & 'Done linting' from being logged.
  JP Simard #386

• All top-level keys in a configuration file that accept an array now also accept a single value.
  e.g. included: Source is equivalent to included:\n - Source.
  JP Simard #120

• Improve performance of FunctionParameterCountRule.
  Norio Nomura

• Improve performance of ColonRule.
  Norio Nomura

Bug Fixes

• Fix case sensitivity of keywords for valid_docs.
  Ankit Aggarwal #298

• Fixed inconsistencies between violations & corrections in StatementPositionRule.
  JP Simard #466

• A warning will now be logged when invalid top-level keys are included in the configuration file.
  JP Simard #120

• Fixed LegacyConstructorRule from correcting legacy constructors in string literals.
  JP Simard #466

• Fixed an issue where variable_name or type_name would always report a violation when configured with only a warning value on either min_length or max_length.
  JP Simard #522

0.8.0: High Heat

Breaking

• Setting only warning on SeverityLevelsConfig rules now disables the error value.
  Robin Kunde #409

• enabled_rules has been renamed to opt_in_rules.
  Daniel Beard

Enhancements

• Add whitelist_rules rule whitelists in config files.
  Daniel Beard #256

• Improve performance of ColonRule, LineLengthRule & syntaxKindsByLine.
  Norio Nomura

• Add command to display rule description: swiftlint rules <rule identifier>.
  Tony Li #392

• Add FunctionParameterCountRule.
  Denis Lebedev #415

• Measure complexity of nested functions separately in CyclomaticComplexityRule.
  Denis Lebedev #424

• Added exception for multi-line if/guard/while conditions to allow opening brace to be on a new line in OpeningBraceRule.
  Scott Hoyt #355

• The rules command now prints a table containing values for: identifier, opt-in, correctable, enabled in your config & configuration.
  JP Simard #392

• Reduce maximum memory usage.
  Norio Nomura

Bug Fixes

• Fix more false positives in ValidDocsRule.
  diogoguimaraes #451

• Fix trailing_newline autocorrect to handle more than one violation per line.
  Daniel Beard #465

• Fix complexity measurement for switch statements in CyclomaticComplexityRule.
  Denis Lebedev #461

0.7.2: Appliance Manual

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Fix several false positives in ValidDocsRule.
  diogoguimaraes #375

0.7.1: Delicate Cycle

Breaking

• None.

Enhancements

• Improve performance of MissingDocsRule.
  Norio Nomura

• Added CustomRules.
  Scott Hoyt
  #123

• Added opt-in ForceUnwrappingRule to issue warnings for all forced unwrappings.
  Benjamin Otto #55

Bug Fixes

• Fix several false positives in ValidDocsRule.
  diogoguimaraes #375

0.7.0: Automatic Permanent Press

Breaking

• Replaced all uses of XPCDictionary with [String: SourceKitRepresentable].
  JP Simard

• VariableNameMinLengthRule and VariableNameMaxLengthRule have been removed. VariableNameRule now has this functionality.
  Scott Hoyt

• ViolationLevelRule has been removed. This functionality is now provided by ConfigProviderRule and SeverityLevelsConfig.
  Scott Hoyt

Enhancements

• TypeBodyLengthRule now does not count comment or whitespace lines.
  Marcelo Fabri #369

• FunctionBodyLengthRule now does not count comment or whitespace lines.
  Marcelo Fabri #258

• All Rules are now configurable in at least their severity: SeverityConfig.
  Scott Hoyt #371 #130 #268

• TypeNameRule and VariableNameRule conform to ConfigProviderRule using NameConfig to support min_length, max_length, and excluded names.
  Scott Hoyt #388 #259 #191

• Add CyclomaticComplexityRule.
  Denis Lebedev

Bug Fixes

• Fix crash caused by infinite recursion when using nested config files.
  JP Simard #368

• Fix crash when file contains NULL character.
  Norio Nomura #379

0.6.0: Steam Cycle

Breaking

• ParameterizedRule is removed. Use ConfigurableRule instead.
  Scott Hoyt #353

• To activate a Rule, it must be added to the global masterRuleList.
  Scott Hoyt

Enhancements

• ConfigurableRule protocol allows for improved rule configuration. See CONTRIBUTING for more details.
  Scott Hoyt #303

• VariableNameMinLengthRule now supports excluding certain variable names (e.g. "id").
  Scott Hoyt #231

• ViolationLevelRule provides default ConfigurableRule implementation for rules that only need integer error and warning levels.
  Scott Hoyt

• Add AutoCorrect for StatementPositionRule.
  Raphael Randschau

• Add AutoCorrect for CommaRule.
  Raphael Randschau

• Add AutoCorrect for LegacyConstructorRule.
  Raphael Randschau

• Improve performance of LineLengthRule.
  Norio Nomura

• Add ConditionalBindingCascadeRule.
  Aaron McTavish #202

• Opt-in rules are now supported.
  JP Simard #256

• Add LegacyConstantRule.
  Aaron McTavish #319

• Add opt-in rule to encourage checking isEmpty over comparing count to zero.
  JP Simard #202

• Add opt-in "Missing Docs" rule to detect undocumented public declarations.
  JP Simard

Bug Fixes

• None.

0.5.6: Bug FixLint

Breaking

• None.

Enhancements

• Improve performance by reducing calls to SourceKit.
  Norio Nomura

Bug Fixes

• Fix homebrew deployment issues.
  Norio Nomura

• AutoCorrect for TrailingNewlineRule only removes at most one line.
  John Estropia

• valid_docs did not detect tuple as return value.
  Norio Nomura #324

• Escape strings when using CSV reporter.
  JP Simard

0.5.5: Magic Drying Fluff Balls™

http://www.amazon.com/Magic-Drying-Fluff-Balls-Softening/dp/B001EIW1SG

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Always fail if a YAML configuration file was found but could not be parsed.
  JP Simard #310

• Make commands with modifiers work for violations with line-only locations.
  JP Simard #316

0.5.4: Bounce™

Breaking

• Remove Location.init(file:offset:) in favor of the more explicit Location.init(file:byteOffset:) & Location.init(file:characterOffset:).
  JP Simard

Enhancements

• Add checkstyle reporter to generate XML reports in the Checkstyle 4.3 format.
  JP Simard #277

• Support command comment modifiers (previous, this & next) to limit the command's scope to a single line.
  JP Simard #222

• Add nested .swiftlint.yml configuration support.
  Scott Hoyt #299

Bug Fixes

• Fix multibyte handling in many rules.
  JP Simard #279

• Fix an NSRangeException crash.
  Norio Nomura #294

• The valid_docs rule now handles multibyte characters.
  Norio Nomura #295

0.5.3: Mountain Scent

Breaking

• None.

Enhancements

• Improve autocorrect for OpeningBraceRule.
  Yasuhiro Inami

• Add autocorrect for ColonRule.
  Brian Partridge

• Add ClosingBraceRule.
  Yasuhiro Inami

Bug Fixes

• Fix false positives in ValidDocsRule.
  JP Simard #267

0.5.2: Snuggle™

Breaking

• None.

Enhancements

• Performance improvements & unicode fixes (via SourceKitten).
  Norio Nomura

Bug Fixes

• Fix ValidDocsRule false positive when documenting functions with closure parameters.
  diogoguimaraes #267

0.5.1: Lint Tray Malfunction

Breaking

• None.

Enhancements

• None.

Bug Fixes

• Make linting faster than 0.5.0, but slower than 0.4.0
  Norio Nomura #119

• Re-introduce --use-script-input-files option for lint & autocorrect commands. Should also fix some issues when running SwiftLint from an Xcode build phase.
  JP Simard #264

0.5.0: Downy™

Breaking

• init() is no longer a member of the Rule protocol.

Enhancements

• Add legacy constructor rule.
  Marcelo Fabri #202

• The VariableNameRule now allows variable names when the entire name is capitalized. This allows stylistic usage common in cases like URL and other acronyms.
  Marcelo Fabri #161

• Add autocorrect command to automatically correct certain violations (currently only trailing_newline, trailing_semicolon & trailing_whitespace).
  JP Simard #5

• Allow to exclude files from included directory with excluded.
  Michal Laskowski

Bug Fixes

• Statement position rule no longer triggers for non-keyword uses of catch and else.
  JP Simard #237

• Fix issues with multi-byte characters.
  JP Simard #234

0.4.0: Wrinkle Release

Breaking

• API: Rename RuleExample to RuleDescription, remove StyleViolationType and combine Rule().identifier and Rule().example into Rule.description.
  JP Simard #183

Enhancements

• The VariableNameRule now allows capitalized variable names when they are declared static. This allows stylistic usage common in cases like OptionSetType subclasses.
  Will Fleming

• Add VariableNameMaxLengthRule and VariableNameMinLengthRule parameter rules. Remove length checks on VariableNameRule.
  Mickael Morier

• Add trailing semicolon rule.
  JP Simard

• Add force try rule.
  JP Simard

• Support linting from Input Files provided by Run Script Phase of Xcode with --use-script-input-files.
  Norio Nomura #193

Bug Fixes

• All rules now print their identifiers in reports.
  JP Simard #180

• ControlStatementRule now detects all violations.
  Mickael Morier #187

• ControlStatementRule no longer triggers a violation for acceptable use of parentheses.
  Mickael Morier #189

• Nesting rule no longer triggers a violation for enums nested one level deep.
  JP Simard #190

• ColonRule now triggers a violation even if equal operator is collapse to type and value.
  Mickael Morier #135

• Fix an issue where logs would be printed asynchronously over each other.
  JP Simard #200

0.3.0: Wrinkly Rules

Breaking

• swiftlint rules now just prints a list of all available rules and their identifiers.

Enhancements

• Support for Swift 2.1.
  JP Simard

• Added StatementPositionRule to make sure that catch, else if and else statements are on the same line as closing brace preceding them and after one space.
  Alex Culeva

• Added Comma Rule to ensure there is a single space after a comma.
  Alex Culeva

• Add rule identifier to all linter reports.
  zippy1978

• Add OpeningBraceRule to make sure there is exactly a space before opening brace and it is on the same line as declaration.
  Alex Culeva

• Print to stderr for all informational logs. Only reporter outputs is logged to stdout.
  JP Simard

• JSON and CSV reporters now only print at the very end of the linting process.
  JP Simard

• Add support for guard statements to ControlStatementRule.
  David Potter

• Lint parameter variables.
  JP Simard

Bug Fixes

• Custom reporters are now supported even when not running with --use-stdin.
  JP Simard #151

• Deduplicate files in the current directory.
  JP Simard #154

0.2.0: Tumble Dry

Breaking

• SwiftLint now exclusively supports Swift 2.0.
  JP Simard #77

• ViolationSeverity now has an associated type of String and two members: .Warning and .Error.
  JP Simard #113

Enhancements

• Configure SwiftLint via a YAML file: Supports disabled_rules, included, excluded and passing parameters to parameterized rules. Pass a configuration file path to --config, defaults to .swiftlint.yml.
  JP Simard #1 #3 #20 #26

• Updated TypeNameRule and VariableNameRule to allow private type & variable names to start with an underscore.
  JP Simard

• Disable and re-enable rules from within source code comments using // swiftlint:disable $IDENTIFIER and // swiftlint:enable $IDENTIFIER.
  JP Simard #4

• Add --strict lint flag which makes the lint fail if there are any warnings.
  Keith Smiley

• Violations are now printed to stderr.
  Keith Smiley

• Custom reporters are now supported. Specify a value for the reporter: key in your configuration file. Available reporters are xcode (default), json, csv.
  JP Simard #42

Bug Fixes

• Improve performance of TrailingWhitespaceRule.
  Keith Smiley

• Allow newlines in function return arrow.
  JP Simard

0.1.2: FabricSoftenerRule

Breaking

• None.

Enhancements

• Added OperatorFunctionWhitespaceRule to make sure that you use whitespace around operators when defining them.
  Akira Hirakawa #60

• Added ReturnArrowWhitespaceRule to make sure that you have 1 space before return arrow and return type.
  Akira Hirakawa

• Support linting from standard input (use --use-stdin).
  JP Simard #78

• Improve performance of TrailingNewlineRule.
  Keith Smiley

• Lint parentheses around switch statements.
  Keith Smiley

Bug Fixes

• None.

0.1.1: Top Loading

Breaking

• The Rule and ASTRule protocol members are now non-static.
  aarondaub

• Split Rule into Rule and ParameterizedRule protocols.
  aarondaub #21

Enhancements

• Added a command line option --path to specify a path to lint.
  Lars Lockefeer #16

• swiftlint now returns a non-zero error code when a warning of high-severity or above is found in the source files being linted.
  Pat Wallace #30

• Added rules command to display which rules are currently applied along with examples.
  Chris Eidhof

• Cache parsing to reduce execution time by more than 50%.
  Nikolaj Schumacher

• Added ControlStatementRule to make sure that if/for/while/do statements do not wrap their conditionals in parentheses.
  Andrea Mazzini

• Character position is now included in violation location where appropriate.
  JP Simard #62

• The following rules now conform to ASTRule: FunctionBodyLength, Nesting, TypeBodyLength, TypeName, VariableName.
  JP Simard

Bug Fixes

• Trailing newline and file length violations are now displayed in Xcode.
  JP Simard #43

0.1.0: Fresh Out Of The Dryer

First Version!