Add blanket_disable_command rule #4731

mildm8nnered · 2023-01-29T18:29:32Z

Adds a new SwiftLint rule: blanket_disable_command

Resolves #4684

This warns (by default) when a SwiftLint rule is disabled, and then never later re-enabled. In many cases this is because the developer forgot to re-enable the rule, or somehow bodged it (e.g. // swftlint:enable some_rule), resulting in stretches of code going unintentionally un-linted.

Violations of this rule are surprisingly common. I found a bunch in the SwiftLint source code, which I've patched in various ways in this PR - some could simply be turned into // swiftlint:disable:next some_rule's and some I suppressed.

There are some rules that it doesn't make sense to re-enable, and that should apply to the whole file. An allowed_rules configuration parameter allows these to be specified. By default, file_length and single_test_class are allowed.

For these and possibly other rules, we may want to disable a particular rule always for the entire file, and to warn if it that rule is disabled with a modifier or re-enabled. The always_blanket_disable configuration parameter allows a set of rules to be specified that should always be warned on anything except a blanket disable. By default the set is empty.

This rule will also warn if you use swiftlint:disable to disable a rule that's already disabled, or swiftlint:enable to enable a rule that isn't disabled.

nonTriggeringExamples:

// swiftlint:disable unused_import
// swiftlint:enable unused_import

// swiftlint:disable unused_import unused_declaration
// swiftlint:enable unused_import
// swiftlint:enable unused_declaration

// swiftlint:disable:this unused_import")

// swiftlint:disable:next unused_import")

// swiftlint:disable:previous unused_import")

triggeringExamples:

// swiftlint:disable unused_import

// swiftlint:disable unused_import unused_declaration
// swiftlint:enable unused_import

// swiftlint:disable unused_import
// swiftlint:disable unused_import
// swiftlint:enable unused_import

// swiftlint:enable unused_import

See #4684

SwiftLintBot · 2023-02-08T01:47:00Z

	70 Warnings
⚠️	This PR introduced a violation in Aerial: /Aerial/Source/Models/AerialVideo.swift:76:26: warning: Blanket Disable Command Violation: The disabled 'cyclomatic_complexity' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Aerial/Source/Models/Cache/Cache.swift:437:42: warning: Blanket Disable Command Violation: The disabled 'for_where' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Aerial/Source/Models/Cache/Cache.swift:437:42: warning: Blanket Disable Command Violation: The disabled 'for_where' rule was already disabled (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Aerial/Source/Models/Cache/Cache.swift:597:26: warning: Blanket Disable Command Violation: The disabled 'line_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Aerial/Source/Models/Sources/SourceList.swift:101:26: warning: Blanket Disable Command Violation: The disabled 'for_where' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Aerial/Source/Views/Sources/CheckboxCellView.swift:10:22: warning: Blanket Disable Command Violation: The disabled 'class_delegate_protocol' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Aerial/Source/Views/Sources/CheckboxCellView.swift:10:46: warning: Blanket Disable Command Violation: The disabled 'weak_delegate' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Resources/MainUI/Settings panels/SourcesViewController.swift:222:26: warning: Blanket Disable Command Violation: The disabled 'cyclomatic_complexity' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Resources/MainUI/Settings panels/TimeViewController.swift:55:26: warning: Blanket Disable Command Violation: The disabled 'cyclomatic_complexity' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Resources/MainUI/SidebarViewController.swift:430:1: warning: Blanket Disable Command Violation: The disabled '}' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Aerial: /Resources/MainUI/SidebarViewController.swift:430:1: warning: Blanket Disable Command Violation: The disabled '}*/' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Brave: /Sources/BraveShared/BraveStrings.swift:19:22: warning: Blanket Disable Command Violation: The disabled 'line_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /Core/APIRequest.swift:26:22: warning: Blanket Disable Command Violation: The disabled 'line_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /Core/Pixel.swift:221:21: warning: Blanket Disable Command Violation: The enabled 'file_length' rule was not disabled (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /Core/Pixel.swift:24:21: warning: Blanket Disable Command Violation: The enabled 'type_body_length' rule was not disabled (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /Core/PixelEvent.swift:25:22: warning: Blanket Disable Command Violation: The disabled 'type_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /DuckDuckGo/AutofillLoginSettingsListViewController.swift:28:22: warning: Blanket Disable Command Violation: The disabled 'type_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /DuckDuckGo/BrowsingMenu/BrowsingMenuViewController.swift:264:22: warning: Blanket Disable Command Violation: The disabled 'line_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /DuckDuckGo/DatabaseMigration.swift:77:25: warning: Blanket Disable Command Violation: The enabled 'function_body_length' rule was not disabled (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /DuckDuckGo/HomeMessageViewModelBuilder.swift:82:25: warning: Blanket Disable Command Violation: The enabled 'function_body_length' rule was not disabled (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /DuckDuckGo/TrackerImageCache.swift:107:26: warning: Blanket Disable Command Violation: The disabled 'cyclomatic_complexity' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /DuckDuckGo/TrackerImageCache.swift:107:26: warning: Blanket Disable Command Violation: The disabled 'cyclomatic_complexity' rule was already disabled (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /DuckDuckGoTests/AutofillLoginListViewModelTests.swift:20:22: warning: Blanket Disable Command Violation: The disabled 'line_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /DuckDuckGoTests/BookmarksExporterTests.swift:131:25: warning: Blanket Disable Command Violation: The enabled 'line_length' rule was not disabled (blanket_disable_command)
⚠️	This PR introduced a violation in DuckDuckGo: /DuckDuckGoTests/BookmarksExporterTests.swift:201:26: warning: Blanket Disable Command Violation: The disabled 'function_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Firefox: /Client/Extensions/UIWindow+Extension.swift:7:22: warning: Blanket Disable Command Violation: The disabled 'first_where' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Firefox: /Client/Frontend/Strings.swift:5:22: warning: Blanket Disable Command Violation: The disabled 'line_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Firefox: /Tests/XCUITests/DesktopModeTests.swift:7:22: warning: Blanket Disable Command Violation: The disabled 'empty_count' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Kickstarter: /Library/Strings.swift:7:22: warning: Blanket Disable Command Violation: The disabled 'valid_docs' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Kickstarter: /Library/Strings.swift:8:22: warning: Blanket Disable Command Violation: The disabled 'line_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Kickstarter: /Library/ViewModels/DiscoveryPostcardViewModelTests.swift:7:22: warning: Blanket Disable Command Violation: The disabled 'force_unwrapping' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Kickstarter: /bin/StringsScript/Tests/StringsScriptTests/StringsScriptTests.swift:5:22: warning: Blanket Disable Command Violation: The disabled 'line_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Moya: /Examples/_shared/GitHubAPI.swift:1:22: warning: Blanket Disable Command Violation: The disabled 'force_unwrapping' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Moya: /Tests/MoyaTests/MoyaProviderSpec.swift:1:34: warning: Blanket Disable Command Violation: The disabled 'type_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in NetNewsWire: /Widget/Resources/Localized.swift:1:22: warning: Blanket Disable Command Violation: The disabled 'all' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Nimble: /Sources/Nimble/DSL.swift:74:25: warning: Blanket Disable Command Violation: The enabled 'line_length' rule was not disabled (blanket_disable_command)
⚠️	This PR introduced a violation in PocketCasts: /podcasts/Strings+Generated.swift:1:22: warning: Blanket Disable Command Violation: The disabled 'all' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in PocketCasts: /podcasts/Strings+L10n.swift:159:22: warning: Blanket Disable Command Violation: The disabled 'convenience_type' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Realm: /Realm/ObjectServerTests/SwiftObjectServerTests.swift:2393:26: warning: Blanket Disable Command Violation: The disabled 'multiple_closures_with_trailing_closure' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Realm: /RealmSwift/Tests/PrimitiveMapTests.swift:23:22: warning: Blanket Disable Command Violation: The disabled 'cyclomatic_complexity' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Realm: /RealmSwift/Tests/QueryTests.swift:23:22: warning: Blanket Disable Command Violation: The disabled 'large_tuple' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Realm: /RealmSwift/Tests/QueryTests.swift:23:34: warning: Blanket Disable Command Violation: The disabled 'vertical_parameter_alignment' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Realm: /RealmSwift/Tests/RealmCollectionTypeTests.swift:19:22: warning: Blanket Disable Command Violation: The disabled 'type_name' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in SourceKitten: /Source/SourceKittenFramework/File.swift:8:34: warning: Blanket Disable Command Violation: The disabled 'type_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in SourceKitten: /Source/SourceKittenFramework/StatementKind.swift:1:22: warning: Blanket Disable Command Violation: The disabled 'identifier_name' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in SourceKitten: /Source/SourceKittenFramework/library_wrapper_Clang_C.swift:7:22: warning: Blanket Disable Command Violation: The disabled 'unused_declaration' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in SourceKitten: /Source/SourceKittenFramework/library_wrapper_SourceKit.swift:10:22: warning: Blanket Disable Command Violation: The disabled 'unused_declaration' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryRuntime/Sources/Generated/AutoHashable.generated.swift:3:22: warning: Blanket Disable Command Violation: The disabled 'all' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryRuntime/Sources/Generated/Coding.generated.swift:3:22: warning: Blanket Disable Command Violation: The disabled 'vertical_whitespace' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryRuntime/Sources/Generated/Coding.generated.swift:3:42: warning: Blanket Disable Command Violation: The disabled 'trailing_newline' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryRuntime/Sources/Generated/Description.generated.swift:3:22: warning: Blanket Disable Command Violation: The disabled 'vertical_whitespace' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryRuntime/Sources/Generated/Equality.generated.swift:3:22: warning: Blanket Disable Command Violation: The disabled 'vertical_whitespace' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryRuntime/Sources/Generated/JSExport.generated.swift:3:22: warning: Blanket Disable Command Violation: The disabled 'vertical_whitespace' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryRuntime/Sources/Generated/JSExport.generated.swift:3:42: warning: Blanket Disable Command Violation: The disabled 'trailing_newline' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryRuntime/Sources/Generated/Typed.generated.swift:3:22: warning: Blanket Disable Command Violation: The disabled 'vertical_whitespace' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryTests/Generating/SwiftTemplateSpecs.swift:23:26: warning: Blanket Disable Command Violation: The disabled 'function_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryTests/GeneratorSpec.swift:14:26: warning: Blanket Disable Command Violation: The disabled 'function_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryTests/Models/TypedSpec.generated.swift:13:22: warning: Blanket Disable Command Violation: The disabled 'function_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryTests/Parsing/ComposerSpec.swift:18:22: warning: Blanket Disable Command Violation: The disabled 'type_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryTests/Parsing/ComposerSpec.swift:20:26: warning: Blanket Disable Command Violation: The disabled 'function_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryTests/Parsing/FileParser + MethodsSpec.swift:15:26: warning: Blanket Disable Command Violation: The disabled 'function_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryTests/Parsing/FileParserSpec.swift:14:26: warning: Blanket Disable Command Violation: The disabled 'function_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /SourceryTests/SourcerySpec.swift:15:34: warning: Blanket Disable Command Violation: The disabled 'type_body_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /Templates/Tests/Context/AutoLenses.swift:28:22: warning: Blanket Disable Command Violation: The disabled 'identifier_name' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /Templates/Tests/Generated/AutoHashable.generated.swift:3:22: warning: Blanket Disable Command Violation: The disabled 'all' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /Templates/Tests/Generated/AutoLenses.generated.swift:3:22: warning: Blanket Disable Command Violation: The disabled 'variable_name' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /Templates/Tests/Generated/AutoMockable.generated.swift:3:22: warning: Blanket Disable Command Violation: The disabled 'line_length' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Sourcery: /Templates/Tests/Generated/AutoMockable.generated.swift:4:22: warning: Blanket Disable Command Violation: The disabled 'variable_name' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Wire: /Wire-iOS/Generated/Assets+Generated.swift:1:22: warning: Blanket Disable Command Violation: The disabled 'all' rule should be re-enabled before the end of the file (blanket_disable_command)
⚠️	This PR introduced a violation in Wire: /Wire-iOS/Generated/Strings+Generated.swift:1:22: warning: Blanket Disable Command Violation: The disabled 'all' rule should be re-enabled before the end of the file (blanket_disable_command)

	18 Messages
📖	Linting Aerial with this PR took 1.04s vs 1.04s on main (0% slower)
📖	Linting Alamofire with this PR took 1.34s vs 1.34s on main (0% slower)
📖	Linting Brave with this PR took 7.27s vs 7.25s on main (0% slower)
📖	Linting DuckDuckGo with this PR took 3.11s vs 3.1s on main (0% slower)
📖	Linting Firefox with this PR took 9.17s vs 9.12s on main (0% slower)
📖	Linting Kickstarter with this PR took 10.07s vs 10.12s on main (0% faster)
📖	Linting Moya with this PR took 0.52s vs 0.53s on main (1% faster)
📖	Linting NetNewsWire with this PR took 3.02s vs 3.01s on main (0% slower)
📖	Linting Nimble with this PR took 0.6s vs 0.58s on main (3% slower)
📖	Linting PocketCasts with this PR took 7.07s vs 7.07s on main (0% slower)
📖	Linting Quick with this PR took 0.23s vs 0.22s on main (4% slower)
📖	Linting Realm with this PR took 11.32s vs 11.33s on main (0% faster)
📖	Linting SourceKitten with this PR took 0.43s vs 0.43s on main (0% slower)
📖	Linting Sourcery with this PR took 2.18s vs 2.18s on main (0% slower)
📖	Linting Swift with this PR took 4.75s vs 4.75s on main (0% slower)
📖	Linting VLC with this PR took 1.35s vs 1.33s on main (1% slower)
📖	Linting Wire with this PR took 8.22s vs 8.19s on main (0% slower)
📖	Linting WordPress with this PR took 10.98s vs 11.0s on main (0% faster)

Generated by 🚫 Danger

Source/SwiftLintFramework/Rules/Lint/NoBlanketDisablesRule.swift

SimplyDanny · 2023-02-28T19:05:46Z

In general, I like this rule a lot! The OSS findings and the findings in SwiftLint itself splendidly show how much SwiftLint misses it.

mildm8nnered · 2023-02-28T23:42:49Z

In general, I like this rule a lot! The OSS findings and the findings in SwiftLint itself splendidly show how much SwiftLint misses it.

Thanks! I just saw so many people just disabling stuff for the remainder of the file to fix one warning that it got annoying - we have a custom Danger script to do (some of) this, but much nicer to just have it baked in. And yes, it does seem to get a lot of hits :-)

Not entirely sure that no_blanket_disable is the best naming. Possibly blanket_disable_command, to echo superfluous_disable_command?

SimplyDanny

Indeed, blanket_disable_command sounds better to me. Also, the wording of the violation messages can be improved. I made a few suggestions. Please let me know what you think.

CHANGELOG.md

Source/SwiftLintFramework/Rules/Lint/NoBlanketDisablesRule.swift

mildm8nnered · 2023-03-02T00:04:40Z

Indeed, blanket_disable_command sounds better to me. Also, the wording of the violation messages can be improved. I made a few suggestions. Please let me know what you think.

Cool - I went with blanket_disable_command and all your reason suggestions.

SimplyDanny

Just found some more points I'd like to discuss. Sorry! 😅

Source/SwiftLintFramework/Rules/Lint/BlanketDisableCommandRule.swift

SimplyDanny · 2023-03-05T10:31:35Z

Source/SwiftLintFramework/Rules/RuleConfigurations/BlanketDisableCommandConfiguration.swift

+    public private(set) var allowedRuleIdentifiers: Set<String> = ["file_length", "single_test_class"]
+    public private(set) var alwaysBlanketDisableRuleIdentifiers: Set<String> = []


Isn't it the other way around?

Suggested change

public private(set) var allowedRuleIdentifiers: Set<String> = ["file_length", "single_test_class"]

public private(set) var alwaysBlanketDisableRuleIdentifiers: Set<String> = []

public private(set) var allowedRuleIdentifiers: Set<String> = []

public private(set) var alwaysBlanketDisableRuleIdentifiers: Set<String> = ["file_length", "single_test_class"]

This is actually correct - the intention is that by default, the rule will not complain about

// swiftlint:disable file_length, for example, even though it's not re-enabled, because it makes sense to just disable it once for the whole file, and there's no point in doing // swiftlint:enable file_length at the end of the file.

Adding a rule to the alwaysBlanketDisableRuleIdentifiers goes one step further, by warning the user on any SwiftLint command affecting the rule, that is anything other than // swiftlint:disable file_length. I didn't want to enable that by default.

I have made one slight modification though - any rules in alwaysBlanketDisableRuleIdentifiers are automatically "allowed"

Hm, got it ... this is tricky, though.

I think this is the right behaviour, but maybe the naming isn't quite perfect. I went with allowed_rules and always_blanket_disable, but maybe there's something better, although I don't have any good suggestions.

I've also just added file_header, file_name, and file_name_no_space to the default allowed rules list.

Source/SwiftLintFramework/Rules/Lint/BlanketDisableCommandRule.swift

mildm8nnered · 2023-03-05T13:36:15Z

Just found some more points I'd like to discuss. Sorry! 😅

No worries :-) I'll try and get to these today ...

mildm8nnered · 2023-03-05T16:51:26Z

Just found some more points I'd like to discuss. Sorry! 😅

No worries :-) I'll try and get to these today ...

ok - so I think I've addressed everything from that last batch :-)

SimplyDanny · 2023-03-05T18:35:23Z

Source/SwiftLintFramework/Rules/Lint/BlanketDisableCommandRule.swift

+        return violations
+    }
+
+    private func violation(


Is this indirection really needed for only one saved conversion?

So in three cases I have a RuleIdentifier (so they use the indirection), and then in two cases, in validateAlwaysBlanketDisable, I have the string.

I couldn't see anyway round that - the indirection felt cleaner than making the three call sites call stringRepresentation themselves.

SimplyDanny · 2023-03-07T20:44:36Z

Well done. Thanks @mildm8nnered!

mildm8nnered changed the title ~~Mildm8nnered no blanket disables rule~~ Add no blanket disables rule Jan 30, 2023

mildm8nnered force-pushed the mildm8nnered-no-blanket-disables-rule branch from 5cc14a6 to f370aa7 Compare February 11, 2023 11:19

mildm8nnered force-pushed the mildm8nnered-no-blanket-disables-rule branch 2 times, most recently from 16ee74e to 413da97 Compare February 26, 2023 17:07

SimplyDanny reviewed Feb 28, 2023

View reviewed changes

Source/SwiftLintFramework/Rules/Lint/NoBlanketDisablesRule.swift Outdated Show resolved Hide resolved

mildm8nnered force-pushed the mildm8nnered-no-blanket-disables-rule branch from 413da97 to 35f25e0 Compare February 28, 2023 22:00

SimplyDanny reviewed Mar 1, 2023

View reviewed changes

SimplyDanny approved these changes Mar 2, 2023

View reviewed changes

mildm8nnered force-pushed the mildm8nnered-no-blanket-disables-rule branch from c88f83f to 6b52cb2 Compare March 4, 2023 18:01

SimplyDanny reviewed Mar 5, 2023

View reviewed changes

mildm8nnered force-pushed the mildm8nnered-no-blanket-disables-rule branch from 8f50371 to 7f76874 Compare March 5, 2023 15:49

mildm8nnered changed the title ~~Add no blanket disables rule~~ Add blanket_disable_command rule Mar 5, 2023

SimplyDanny reviewed Mar 5, 2023

View reviewed changes

mildm8nnered added 11 commits March 5, 2023 21:55

Started to add the rule

82b79cf

No longer a SwiftSyntax rule

399b390

Added unit test

39e23a3

Ran sourcery

1635b69

Quick implementation

314b6ba

Auto-corrects

f80cf11

Hardcode exceptions for now

09b8c79

Fixes for violations in SwiftLint's source code

09d67de

Brute-forced superfluous_disable tests

3c0a317

Added a configuration option

008dd99

auto-correct

0e8d055

mildm8nnered added 20 commits March 5, 2023 21:55

Tightened up a little more

98c4204

whitespace fixes

121ffa9

Fixed always blanket disable code

29c6e97

Improved always_blanket_disable behaviour

4841ede

Rename rule to blanket_disable_command

56aecc5

Tweaked rule as per suggestions

3a878b4

Pass the file instead of the path into our violation method

5de6683

Fixes

173047d

Required changes now that location has moved

ecf7fae

Fix and rerun make sourcery

967d3a7

Fixed BlanketDisableCommand tests

5993e20

Fixed line ending tests

9fc501d

Final fixes

18f3caa

Better bounds checking

7fc9ddf

Remove un-needed typealias

f640f82

Refactored into separate methods for each violation type

d5c5e83

Setup for indicating rule identifiers

da4f485

We now exactly indicate the problem rule identifier

805659b

More tests

f73b328

No need to skip comment tests

6455403

mildm8nnered force-pushed the mildm8nnered-no-blanket-disables-rule branch from 7f76874 to 6455403 Compare March 5, 2023 21:55

mildm8nnered added 2 commits March 5, 2023 22:18

Fixed unit tests

3209707

Added some more default allowed rules

32fe222

SimplyDanny merged commit 0bd8a7a into realm:main Mar 7, 2023

ZevEisenberg mentioned this pull request Mar 28, 2023

Fix warnings in templates caused by SwiftLint 0.51.0 SwiftGen/SwiftGen#1054

Merged

6 tasks

conanoc mentioned this pull request Mar 30, 2023

ci: Disable blanket_disable_command rule LF-Decentralized-Trust-labs/aries-framework-swift#38

Merged

mildm8nnered deleted the mildm8nnered-no-blanket-disables-rule branch April 17, 2023 23:29

chwo mentioned this pull request Jun 7, 2023

Feature Request: disable rules for whole file #5052

Open

2 tasks

tomhuettmann mentioned this pull request Feb 2, 2024

Is blanket_disable_command really necessary? #5450

Closed

2 tasks

		public private(set) var allowedRuleIdentifiers: Set<String> = ["file_length", "single_test_class"]
		public private(set) var alwaysBlanketDisableRuleIdentifiers: Set<String> = []

Add blanket_disable_command rule #4731

Add blanket_disable_command rule #4731

Uh oh!

Conversation

mildm8nnered commented Jan 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SwiftLintBot commented Feb 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

SimplyDanny commented Feb 28, 2023

Uh oh!

mildm8nnered commented Feb 28, 2023

Uh oh!

SimplyDanny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mildm8nnered commented Mar 2, 2023

Uh oh!

SimplyDanny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

SimplyDanny Mar 5, 2023

Choose a reason for hiding this comment

Uh oh!

mildm8nnered Mar 5, 2023

Choose a reason for hiding this comment

Uh oh!

mildm8nnered Mar 5, 2023

Choose a reason for hiding this comment

Uh oh!

SimplyDanny Mar 5, 2023

Choose a reason for hiding this comment

Uh oh!

mildm8nnered Mar 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mildm8nnered commented Mar 5, 2023

Uh oh!

mildm8nnered commented Mar 5, 2023

Uh oh!

SimplyDanny Mar 5, 2023

Choose a reason for hiding this comment

Uh oh!

mildm8nnered Mar 5, 2023

Choose a reason for hiding this comment

Uh oh!

SimplyDanny commented Mar 7, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mildm8nnered commented Jan 29, 2023 •

edited

Loading

SwiftLintBot commented Feb 8, 2023 •

edited

Loading