From ddbf21684c0290ab19761d98f76d9074e7d23ac6 Mon Sep 17 00:00:00 2001 From: "swiftlintbot@jpsim.com" Date: Mon, 2 Oct 2023 20:50:38 +0000 Subject: [PATCH] Automated deployment to GitHub Pages: 2433e7b5bf85749e87ee62fc68ccc0aadab10f04 --- Classes.html | 95 +++- .../ConfigurationElement.html | 179 ++++++-- Classes/CustomRuleTimer.html | 12 +- .../DeclaredIdentifiersTrackingVisitor.html | 12 +- Classes/LinterCache.html | 12 +- Classes/RuleRegistry.html | 12 +- Classes/RuleStorage.html | 12 +- Classes/SwiftLintFile.html | 12 +- Classes/ViolationsSyntaxVisitor.html | 12 +- Enums.html | 17 +- Enums/AccessControlLevel.html | 12 +- Enums/ExecutableInfo.html | 12 +- Enums/Issue.html | 12 +- Enums/OptionType.html | 87 +--- Enums/RuleIdentifier.html | 12 +- Enums/RuleKind.html | 12 +- Enums/RuleListError.html | 12 +- Enums/SwiftExpressionKind.html | 12 +- Enums/ViolationSeverity.html | 49 +-- Extensions.html | 66 +-- Extensions/Array.html | 43 +- Extensions/Bool.html | 43 +- Extensions/Double.html | 43 +- Extensions/Int.html | 43 +- Extensions/NSRegularExpression.html | 405 ------------------ Extensions/Optional.html | 43 +- Extensions/Range.html | 405 ------------------ Extensions/Set.html | 43 +- Extensions/String.html | 43 +- Functions.html | 12 +- Global Variables.html | 12 +- Guides.html | 12 +- Protocols.html | 18 +- Protocols/ASTRule.html | 12 +- .../AcceptableByConfigurationElement.html | 135 +++++- Protocols/AnalyzerRule.html | 12 +- Protocols/CacheDescriptionProvider.html | 12 +- Protocols/CollectingRule.html | 12 +- Protocols/ConfigurationProviderRule.html | 12 +- Protocols/CorrectableRule.html | 12 +- Protocols/Documentable.html | 12 +- Protocols/Reporter.html | 12 +- Protocols/Rule.html | 12 +- Protocols/RuleConfiguration.html | 113 ++++- Protocols/SeverityBasedRuleConfiguration.html | 12 +- Protocols/SubstitutionCorrectableASTRule.html | 12 +- Protocols/SubstitutionCorrectableRule.html | 12 +- Protocols/SwiftSyntaxCorrectableRule.html | 12 +- Protocols/SwiftSyntaxRule.html | 12 +- Protocols/ViolationsSyntaxRewriter.html | 12 +- Rules.html | 12 +- Structs.html | 102 +---- Structs/ChildOptionSeverityConfiguration.html | 14 +- Structs/CollectedLinter.html | 12 +- Structs/Command.html | 12 +- Structs/Command/Action.html | 12 +- Structs/Command/Modifier.html | 12 +- Structs/Configuration.html | 12 +- Structs/Correction.html | 12 +- Structs/Example.html | 12 +- Structs/Linter.html | 12 +- Structs/Location.html | 12 +- Structs/ReasonedRuleViolation.html | 12 +- Structs/RegexConfiguration.html | 16 +- Structs/Region.html | 12 +- Structs/RuleConfigurationDescription.html | 22 +- Structs/RuleConfigurationOption.html | 24 +- Structs/RuleDescription.html | 12 +- Structs/RuleList.html | 12 +- Structs/RuleListDocumentation.html | 12 +- Structs/RuleParameter.html | 12 +- Structs/SeverityConfiguration.html | 14 +- Structs/SeverityLevelsConfiguration.html | 24 +- Structs/Stack.html | 12 +- Structs/StyleViolation.html | 12 +- Structs/SwiftLintSyntaxMap.html | 12 +- Structs/SwiftLintSyntaxToken.html | 12 +- Structs/SwiftVersion.html | 12 +- Structs/Version.html | 12 +- Structs/ViolationCorrection.html | 12 +- Structs/YamlParser.html | 12 +- accessibility_label_for_image.html | 12 +- accessibility_trait_for_button.html | 12 +- anonymous_argument_in_multiline_closure.html | 12 +- anyobject_protocol.html | 12 +- array_init.html | 12 +- attributes.html | 12 +- balanced_xctest_lifecycle.html | 12 +- blanket_disable_command.html | 12 +- block_based_kvo.html | 12 +- capture_variable.html | 12 +- class_delegate_protocol.html | 12 +- closing_brace.html | 12 +- closure_body_length.html | 12 +- closure_end_indentation.html | 12 +- closure_parameter_position.html | 12 +- closure_spacing.html | 12 +- collection_alignment.html | 12 +- colon.html | 12 +- comma.html | 12 +- comma_inheritance.html | 12 +- comment_spacing.html | 12 +- compiler_protocol_init.html | 12 +- computed_accessors_order.html | 12 +- conditional_returns_on_newline.html | 12 +- contains_over_filter_count.html | 12 +- contains_over_filter_is_empty.html | 12 +- contains_over_first_not_nil.html | 12 +- contains_over_range_nil_comparison.html | 12 +- control_statement.html | 12 +- convenience_type.html | 12 +- custom_rules.html | 12 +- cyclomatic_complexity.html | 12 +- deployment_target.html | 12 +- direct_return.html | 12 +- discarded_notification_center_observer.html | 12 +- discouraged_assert.html | 12 +- discouraged_direct_init.html | 12 +- discouraged_none_name.html | 12 +- discouraged_object_literal.html | 12 +- discouraged_optional_boolean.html | 12 +- discouraged_optional_collection.html | 12 +- .../Contents/Resources/Documents/Classes.html | 95 +++- .../Classes}/ConfigurationElement.html | 179 ++++++-- .../Documents/Classes/CustomRuleTimer.html | 12 +- .../DeclaredIdentifiersTrackingVisitor.html | 12 +- .../Documents/Classes/LinterCache.html | 12 +- .../Documents/Classes/RuleRegistry.html | 12 +- .../Documents/Classes/RuleStorage.html | 12 +- .../Documents/Classes/SwiftLintFile.html | 12 +- .../Classes/ViolationsSyntaxVisitor.html | 12 +- .../Contents/Resources/Documents/Enums.html | 17 +- .../Documents/Enums/AccessControlLevel.html | 12 +- .../Documents/Enums/ExecutableInfo.html | 12 +- .../Resources/Documents/Enums/Issue.html | 12 +- .../Resources/Documents/Enums/OptionType.html | 87 +--- .../Documents/Enums/RuleIdentifier.html | 12 +- .../Resources/Documents/Enums/RuleKind.html | 12 +- .../Documents/Enums/RuleListError.html | 12 +- .../Documents/Enums/SwiftExpressionKind.html | 12 +- .../Documents/Enums/ViolationSeverity.html | 49 +-- .../Resources/Documents/Extensions.html | 66 +-- .../Resources/Documents/Extensions/Array.html | 43 +- .../Resources/Documents/Extensions/Bool.html | 43 +- .../Documents/Extensions/Double.html | 43 +- .../Resources/Documents/Extensions/Int.html | 43 +- .../Extensions/NSRegularExpression.html | 405 ------------------ .../Documents/Extensions/Optional.html | 43 +- .../Resources/Documents/Extensions/Range.html | 405 ------------------ .../Resources/Documents/Extensions/Set.html | 43 +- .../Documents/Extensions/String.html | 43 +- .../Resources/Documents/Functions.html | 12 +- .../Resources/Documents/Global Variables.html | 12 +- .../Contents/Resources/Documents/Guides.html | 12 +- .../Resources/Documents/Protocols.html | 18 +- .../Documents/Protocols/ASTRule.html | 12 +- .../AcceptableByConfigurationElement.html | 135 +++++- .../Documents/Protocols/AnalyzerRule.html | 12 +- .../Protocols/CacheDescriptionProvider.html | 12 +- .../Documents/Protocols/CollectingRule.html | 12 +- .../Protocols/ConfigurationProviderRule.html | 12 +- .../Documents/Protocols/CorrectableRule.html | 12 +- .../Documents/Protocols/Documentable.html | 12 +- .../Documents/Protocols/Reporter.html | 12 +- .../Resources/Documents/Protocols/Rule.html | 12 +- .../Protocols/RuleConfiguration.html | 113 ++++- .../SeverityBasedRuleConfiguration.html | 12 +- .../SubstitutionCorrectableASTRule.html | 12 +- .../SubstitutionCorrectableRule.html | 12 +- .../Protocols/SwiftSyntaxCorrectableRule.html | 12 +- .../Documents/Protocols/SwiftSyntaxRule.html | 12 +- .../Protocols/ViolationsSyntaxRewriter.html | 12 +- .../Contents/Resources/Documents/Rules.html | 12 +- .../Contents/Resources/Documents/Structs.html | 102 +---- .../ChildOptionSeverityConfiguration.html | 14 +- .../Documents/Structs/CollectedLinter.html | 12 +- .../Resources/Documents/Structs/Command.html | 12 +- .../Documents/Structs/Command/Action.html | 12 +- .../Documents/Structs/Command/Modifier.html | 12 +- .../Documents/Structs/Configuration.html | 12 +- .../Documents/Structs/Correction.html | 12 +- .../Resources/Documents/Structs/Example.html | 12 +- .../Resources/Documents/Structs/Linter.html | 12 +- .../Resources/Documents/Structs/Location.html | 12 +- .../Structs/ReasonedRuleViolation.html | 12 +- .../Documents/Structs/RegexConfiguration.html | 16 +- .../Resources/Documents/Structs/Region.html | 12 +- .../Structs/RuleConfigurationDescription.html | 22 +- .../Structs/RuleConfigurationOption.html | 24 +- .../Documents/Structs/RuleDescription.html | 12 +- .../Resources/Documents/Structs/RuleList.html | 12 +- .../Structs/RuleListDocumentation.html | 12 +- .../Documents/Structs/RuleParameter.html | 12 +- .../Structs/SeverityConfiguration.html | 14 +- .../Structs/SeverityLevelsConfiguration.html | 24 +- .../Resources/Documents/Structs/Stack.html | 12 +- .../Documents/Structs/StyleViolation.html | 12 +- .../Documents/Structs/SwiftLintSyntaxMap.html | 12 +- .../Structs/SwiftLintSyntaxToken.html | 12 +- .../Documents/Structs/SwiftVersion.html | 12 +- .../Resources/Documents/Structs/Version.html | 12 +- .../Structs/ViolationCorrection.html | 12 +- .../Documents/Structs/YamlParser.html | 12 +- .../accessibility_label_for_image.html | 12 +- .../accessibility_trait_for_button.html | 12 +- ...onymous_argument_in_multiline_closure.html | 12 +- .../Documents/anyobject_protocol.html | 12 +- .../Resources/Documents/array_init.html | 12 +- .../Resources/Documents/attributes.html | 12 +- .../Documents/balanced_xctest_lifecycle.html | 12 +- .../Documents/blanket_disable_command.html | 12 +- .../Resources/Documents/block_based_kvo.html | 12 +- .../Resources/Documents/capture_variable.html | 12 +- .../Documents/class_delegate_protocol.html | 12 +- .../Resources/Documents/closing_brace.html | 12 +- .../Documents/closure_body_length.html | 12 +- .../Documents/closure_end_indentation.html | 12 +- .../Documents/closure_parameter_position.html | 12 +- .../Resources/Documents/closure_spacing.html | 12 +- .../Documents/collection_alignment.html | 12 +- .../Contents/Resources/Documents/colon.html | 12 +- .../Contents/Resources/Documents/comma.html | 12 +- .../Documents/comma_inheritance.html | 12 +- .../Resources/Documents/comment_spacing.html | 12 +- .../Documents/compiler_protocol_init.html | 12 +- .../Documents/computed_accessors_order.html | 12 +- .../conditional_returns_on_newline.html | 12 +- .../Documents/contains_over_filter_count.html | 12 +- .../contains_over_filter_is_empty.html | 12 +- .../contains_over_first_not_nil.html | 12 +- .../contains_over_range_nil_comparison.html | 12 +- .../Documents/control_statement.html | 12 +- .../Resources/Documents/convenience_type.html | 12 +- .../Resources/Documents/custom_rules.html | 12 +- .../Documents/cyclomatic_complexity.html | 12 +- .../Documents/deployment_target.html | 12 +- .../Resources/Documents/direct_return.html | 12 +- ...iscarded_notification_center_observer.html | 12 +- .../Documents/discouraged_assert.html | 12 +- .../Documents/discouraged_direct_init.html | 12 +- .../Documents/discouraged_none_name.html | 12 +- .../Documents/discouraged_object_literal.html | 12 +- .../discouraged_optional_boolean.html | 12 +- .../discouraged_optional_collection.html | 12 +- .../Documents/duplicate_conditions.html | 12 +- .../Documents/duplicate_enum_cases.html | 12 +- .../Documents/duplicate_imports.html | 12 +- .../duplicated_key_in_dictionary_literal.html | 12 +- .../Resources/Documents/dynamic_inline.html | 12 +- .../Documents/empty_collection_literal.html | 12 +- .../Resources/Documents/empty_count.html | 12 +- .../Documents/empty_enum_arguments.html | 12 +- .../Resources/Documents/empty_parameters.html | 12 +- ...pty_parentheses_with_trailing_closure.html | 12 +- .../Resources/Documents/empty_string.html | 12 +- .../Documents/empty_xctest_method.html | 12 +- .../enum_case_associated_values_count.html | 12 +- .../Resources/Documents/expiring_todo.html | 12 +- .../Resources/Documents/explicit_acl.html | 12 +- .../Documents/explicit_enum_raw_value.html | 12 +- .../Resources/Documents/explicit_init.html | 12 +- .../Resources/Documents/explicit_self.html | 12 +- .../Documents/explicit_top_level_acl.html | 12 +- .../Documents/explicit_type_interface.html | 12 +- .../Documents/extension_access_modifier.html | 12 +- .../Resources/Documents/fallthrough.html | 12 +- .../Documents/fatal_error_message.html | 12 +- .../Resources/Documents/file_header.html | 12 +- .../Resources/Documents/file_length.html | 12 +- .../Resources/Documents/file_name.html | 12 +- .../Documents/file_name_no_space.html | 12 +- .../Resources/Documents/file_types_order.html | 12 +- .../Resources/Documents/first_where.html | 12 +- .../Documents/flatmap_over_map_reduce.html | 12 +- .../Resources/Documents/for_where.html | 12 +- .../Resources/Documents/force_cast.html | 12 +- .../Resources/Documents/force_try.html | 12 +- .../Resources/Documents/force_unwrapping.html | 12 +- .../Documents/function_body_length.html | 12 +- .../function_default_parameter_at_end.html | 12 +- .../Documents/function_parameter_count.html | 12 +- .../Documents/generic_type_name.html | 12 +- .../Documents/ibinspectable_in_extension.html | 12 +- .../Documents/identical_operands.html | 12 +- .../Resources/Documents/identifier_name.html | 12 +- .../Resources/Documents/implicit_getter.html | 12 +- .../Resources/Documents/implicit_return.html | 12 +- .../implicitly_unwrapped_optional.html | 12 +- .../Documents/inclusive_language.html | 12 +- .../Documents/indentation_width.html | 12 +- .../Contents/Resources/Documents/index.html | 12 +- .../Resources/Documents/inert_defer.html | 12 +- .../Documents/invalid_swiftlint_command.html | 12 +- .../Resources/Documents/is_disjoint.html | 12 +- .../Documents/joined_default_parameter.html | 12 +- .../Resources/Documents/large_tuple.html | 12 +- .../Resources/Documents/last_where.html | 12 +- .../Documents/leading_whitespace.html | 12 +- .../legacy_cggeometry_functions.html | 12 +- .../Resources/Documents/legacy_constant.html | 12 +- .../Documents/legacy_constructor.html | 12 +- .../Resources/Documents/legacy_hashing.html | 12 +- .../Resources/Documents/legacy_multiple.html | 12 +- .../legacy_nsgeometry_functions.html | 12 +- .../Resources/Documents/legacy_objc_type.html | 12 +- .../Resources/Documents/legacy_random.html | 12 +- .../Documents/let_var_whitespace.html | 12 +- .../Resources/Documents/line_length.html | 12 +- .../literal_expression_end_indentation.html | 12 +- .../Documents/local_doc_comment.html | 12 +- .../Documents/lower_acl_than_parent.html | 12 +- .../Contents/Resources/Documents/mark.html | 12 +- .../Resources/Documents/missing_docs.html | 12 +- .../Resources/Documents/modifier_order.html | 12 +- .../Documents/multiline_arguments.html | 12 +- .../multiline_arguments_brackets.html | 12 +- .../Documents/multiline_function_chains.html | 12 +- .../Documents/multiline_literal_brackets.html | 12 +- .../Documents/multiline_parameters.html | 12 +- .../multiline_parameters_brackets.html | 12 +- ...ltiple_closures_with_trailing_closure.html | 12 +- .../Contents/Resources/Documents/nesting.html | 12 +- .../Resources/Documents/nimble_operator.html | 12 +- .../no_extension_access_modifier.html | 12 +- .../Documents/no_fallthrough_only.html | 12 +- .../Documents/no_grouping_extension.html | 12 +- .../Resources/Documents/no_magic_numbers.html | 12 +- .../Documents/no_space_in_method_call.html | 12 +- .../non_overridable_class_declaration.html | 12 +- .../notification_center_detachment.html | 12 +- .../ns_number_init_as_function_reference.html | 12 +- .../Documents/nslocalizedstring_key.html | 12 +- .../nslocalizedstring_require_bundle.html | 12 +- .../Documents/nsobject_prefer_isequal.html | 12 +- .../Resources/Documents/number_separator.html | 12 +- .../Resources/Documents/object_literal.html | 12 +- .../Resources/Documents/opening_brace.html | 12 +- .../Documents/operator_usage_whitespace.html | 12 +- .../Documents/operator_whitespace.html | 12 +- .../optional_enum_case_matching.html | 12 +- .../Documents/orphaned_doc_comment.html | 12 +- .../Documents/overridden_super_call.html | 12 +- .../Documents/override_in_extension.html | 12 +- .../Documents/pattern_matching_keywords.html | 12 +- .../Resources/Documents/period_spacing.html | 12 +- .../Resources/Documents/prefer_nimble.html | 12 +- .../prefer_self_in_static_references.html | 12 +- .../prefer_self_type_over_type_of_self.html | 12 +- .../prefer_zero_over_explicit_init.html | 12 +- .../Documents/prefixed_toplevel_constant.html | 12 +- .../Resources/Documents/private_action.html | 12 +- .../Resources/Documents/private_outlet.html | 12 +- .../Documents/private_over_fileprivate.html | 12 +- .../Resources/Documents/private_subject.html | 12 +- .../Documents/private_swiftui_state.html | 12 +- .../Documents/private_unit_test.html | 12 +- .../prohibited_interface_builder.html | 12 +- .../Documents/prohibited_super_call.html | 12 +- .../protocol_property_accessors_order.html | 12 +- .../Documents/quick_discouraged_call.html | 12 +- .../quick_discouraged_focused_test.html | 12 +- .../quick_discouraged_pending_test.html | 12 +- ...aw_value_for_camel_cased_codable_enum.html | 12 +- .../Resources/Documents/reduce_boolean.html | 12 +- .../Resources/Documents/reduce_into.html | 12 +- .../Documents/redundant_discardable_let.html | 12 +- .../Documents/redundant_nil_coalescing.html | 12 +- .../Documents/redundant_objc_attribute.html | 12 +- .../redundant_optional_initialization.html | 12 +- .../Documents/redundant_self_in_closure.html | 12 +- .../redundant_set_access_control.html | 12 +- .../redundant_string_enum_value.html | 12 +- .../Documents/redundant_type_annotation.html | 12 +- .../Documents/redundant_void_return.html | 12 +- .../Resources/Documents/required_deinit.html | 12 +- .../Documents/required_enum_case.html | 12 +- .../Documents/return_arrow_whitespace.html | 12 +- .../return_value_from_void_function.html | 12 +- .../Resources/Documents/rule-directory.html | 12 +- .../Contents/Resources/Documents/search.json | 2 +- .../Resources/Documents/self_binding.html | 12 +- .../self_in_property_initialization.html | 12 +- .../Documents/shorthand_operator.html | 12 +- .../Documents/shorthand_optional_binding.html | 12 +- .../Documents/single_test_class.html | 12 +- .../Documents/sorted_enum_cases.html | 12 +- .../Documents/sorted_first_last.html | 12 +- .../Resources/Documents/sorted_imports.html | 12 +- .../Documents/statement_position.html | 12 +- .../Resources/Documents/static_operator.html | 12 +- .../Documents/strict_fileprivate.html | 12 +- .../Resources/Documents/strong_iboutlet.html | 12 +- .../superfluous_disable_command.html | 12 +- .../Resources/Documents/superfluous_else.html | 12 +- .../Documents/swift-syntax-dashboard.html | 12 +- .../Documents/switch_case_alignment.html | 12 +- .../Documents/switch_case_on_newline.html | 12 +- .../Resources/Documents/syntactic_sugar.html | 12 +- .../Documents/test_case_accessibility.html | 12 +- .../Contents/Resources/Documents/todo.html | 12 +- .../Resources/Documents/toggle_bool.html | 12 +- .../Resources/Documents/trailing_closure.html | 12 +- .../Resources/Documents/trailing_comma.html | 12 +- .../Resources/Documents/trailing_newline.html | 12 +- .../Documents/trailing_semicolon.html | 12 +- .../Documents/trailing_whitespace.html | 12 +- .../Resources/Documents/type_body_length.html | 12 +- .../Documents/type_contents_order.html | 12 +- .../Resources/Documents/type_name.html | 12 +- .../Documents/typesafe_array_init.html | 12 +- .../Documents/unavailable_condition.html | 12 +- .../Documents/unavailable_function.html | 12 +- .../Documents/unhandled_throwing_task.html | 12 +- .../Documents/unneeded_break_in_switch.html | 12 +- .../Documents/unneeded_override.html | 12 +- ...eeded_parentheses_in_closure_argument.html | 12 +- .../unneeded_synthesized_initializer.html | 12 +- .../Documents/unowned_variable_capture.html | 12 +- .../Documents/untyped_error_in_catch.html | 12 +- .../Documents/unused_capture_list.html | 12 +- .../Documents/unused_closure_parameter.html | 12 +- .../Documents/unused_control_flow_label.html | 12 +- .../Documents/unused_declaration.html | 12 +- .../Documents/unused_enumerated.html | 12 +- .../Resources/Documents/unused_import.html | 12 +- .../Documents/unused_optional_binding.html | 12 +- .../Documents/unused_setter_value.html | 12 +- .../Documents/valid_ibinspectable.html | 12 +- .../vertical_parameter_alignment.html | 12 +- .../vertical_parameter_alignment_on_call.html | 12 +- .../Documents/vertical_whitespace.html | 12 +- .../vertical_whitespace_between_cases.html | 12 +- .../vertical_whitespace_closing_braces.html | 12 +- .../vertical_whitespace_opening_braces.html | 12 +- .../Documents/void_function_in_ternary.html | 12 +- .../Resources/Documents/void_return.html | 12 +- .../Resources/Documents/weak_delegate.html | 12 +- .../Documents/xct_specific_matcher.html | 12 +- .../Resources/Documents/xctfail_message.html | 12 +- .../Resources/Documents/yoda_condition.html | 12 +- .../Contents/Resources/docSet.dsidx | Bin 167936 -> 163840 bytes docsets/SwiftLintCore.tgz | Bin 579383 -> 569901 bytes duplicate_conditions.html | 12 +- duplicate_enum_cases.html | 12 +- duplicate_imports.html | 12 +- duplicated_key_in_dictionary_literal.html | 12 +- dynamic_inline.html | 12 +- empty_collection_literal.html | 12 +- empty_count.html | 12 +- empty_enum_arguments.html | 12 +- empty_parameters.html | 12 +- empty_parentheses_with_trailing_closure.html | 12 +- empty_string.html | 12 +- empty_xctest_method.html | 12 +- enum_case_associated_values_count.html | 12 +- expiring_todo.html | 12 +- explicit_acl.html | 12 +- explicit_enum_raw_value.html | 12 +- explicit_init.html | 12 +- explicit_self.html | 12 +- explicit_top_level_acl.html | 12 +- explicit_type_interface.html | 12 +- extension_access_modifier.html | 12 +- fallthrough.html | 12 +- fatal_error_message.html | 12 +- file_header.html | 12 +- file_length.html | 12 +- file_name.html | 12 +- file_name_no_space.html | 12 +- file_types_order.html | 12 +- first_where.html | 12 +- flatmap_over_map_reduce.html | 12 +- for_where.html | 12 +- force_cast.html | 12 +- force_try.html | 12 +- force_unwrapping.html | 12 +- function_body_length.html | 12 +- function_default_parameter_at_end.html | 12 +- function_parameter_count.html | 12 +- generic_type_name.html | 12 +- ibinspectable_in_extension.html | 12 +- identical_operands.html | 12 +- identifier_name.html | 12 +- implicit_getter.html | 12 +- implicit_return.html | 12 +- implicitly_unwrapped_optional.html | 12 +- inclusive_language.html | 12 +- indentation_width.html | 12 +- index.html | 12 +- inert_defer.html | 12 +- invalid_swiftlint_command.html | 12 +- is_disjoint.html | 12 +- joined_default_parameter.html | 12 +- large_tuple.html | 12 +- last_where.html | 12 +- leading_whitespace.html | 12 +- legacy_cggeometry_functions.html | 12 +- legacy_constant.html | 12 +- legacy_constructor.html | 12 +- legacy_hashing.html | 12 +- legacy_multiple.html | 12 +- legacy_nsgeometry_functions.html | 12 +- legacy_objc_type.html | 12 +- legacy_random.html | 12 +- let_var_whitespace.html | 12 +- line_length.html | 12 +- literal_expression_end_indentation.html | 12 +- local_doc_comment.html | 12 +- lower_acl_than_parent.html | 12 +- mark.html | 12 +- missing_docs.html | 12 +- modifier_order.html | 12 +- multiline_arguments.html | 12 +- multiline_arguments_brackets.html | 12 +- multiline_function_chains.html | 12 +- multiline_literal_brackets.html | 12 +- multiline_parameters.html | 12 +- multiline_parameters_brackets.html | 12 +- multiple_closures_with_trailing_closure.html | 12 +- nesting.html | 12 +- nimble_operator.html | 12 +- no_extension_access_modifier.html | 12 +- no_fallthrough_only.html | 12 +- no_grouping_extension.html | 12 +- no_magic_numbers.html | 12 +- no_space_in_method_call.html | 12 +- non_overridable_class_declaration.html | 12 +- notification_center_detachment.html | 12 +- ns_number_init_as_function_reference.html | 12 +- nslocalizedstring_key.html | 12 +- nslocalizedstring_require_bundle.html | 12 +- nsobject_prefer_isequal.html | 12 +- number_separator.html | 12 +- object_literal.html | 12 +- opening_brace.html | 12 +- operator_usage_whitespace.html | 12 +- operator_whitespace.html | 12 +- optional_enum_case_matching.html | 12 +- orphaned_doc_comment.html | 12 +- overridden_super_call.html | 12 +- override_in_extension.html | 12 +- pattern_matching_keywords.html | 12 +- period_spacing.html | 12 +- prefer_nimble.html | 12 +- prefer_self_in_static_references.html | 12 +- prefer_self_type_over_type_of_self.html | 12 +- prefer_zero_over_explicit_init.html | 12 +- prefixed_toplevel_constant.html | 12 +- private_action.html | 12 +- private_outlet.html | 12 +- private_over_fileprivate.html | 12 +- private_subject.html | 12 +- private_swiftui_state.html | 12 +- private_unit_test.html | 12 +- prohibited_interface_builder.html | 12 +- prohibited_super_call.html | 12 +- protocol_property_accessors_order.html | 12 +- quick_discouraged_call.html | 12 +- quick_discouraged_focused_test.html | 12 +- quick_discouraged_pending_test.html | 12 +- raw_value_for_camel_cased_codable_enum.html | 12 +- reduce_boolean.html | 12 +- reduce_into.html | 12 +- redundant_discardable_let.html | 12 +- redundant_nil_coalescing.html | 12 +- redundant_objc_attribute.html | 12 +- redundant_optional_initialization.html | 12 +- redundant_self_in_closure.html | 12 +- redundant_set_access_control.html | 12 +- redundant_string_enum_value.html | 12 +- redundant_type_annotation.html | 12 +- redundant_void_return.html | 12 +- required_deinit.html | 12 +- required_enum_case.html | 12 +- return_arrow_whitespace.html | 12 +- return_value_from_void_function.html | 12 +- rule-directory.html | 12 +- search.json | 2 +- self_binding.html | 12 +- self_in_property_initialization.html | 12 +- shorthand_operator.html | 12 +- shorthand_optional_binding.html | 12 +- single_test_class.html | 12 +- sorted_enum_cases.html | 12 +- sorted_first_last.html | 12 +- sorted_imports.html | 12 +- statement_position.html | 12 +- static_operator.html | 12 +- strict_fileprivate.html | 12 +- strong_iboutlet.html | 12 +- superfluous_disable_command.html | 12 +- superfluous_else.html | 12 +- swift-syntax-dashboard.html | 12 +- switch_case_alignment.html | 12 +- switch_case_on_newline.html | 12 +- syntactic_sugar.html | 12 +- test_case_accessibility.html | 12 +- todo.html | 12 +- toggle_bool.html | 12 +- trailing_closure.html | 12 +- trailing_comma.html | 12 +- trailing_newline.html | 12 +- trailing_semicolon.html | 12 +- trailing_whitespace.html | 12 +- type_body_length.html | 12 +- type_contents_order.html | 12 +- type_name.html | 12 +- typesafe_array_init.html | 12 +- unavailable_condition.html | 12 +- unavailable_function.html | 12 +- unhandled_throwing_task.html | 12 +- unneeded_break_in_switch.html | 12 +- unneeded_override.html | 12 +- unneeded_parentheses_in_closure_argument.html | 12 +- unneeded_synthesized_initializer.html | 12 +- unowned_variable_capture.html | 12 +- untyped_error_in_catch.html | 12 +- unused_capture_list.html | 12 +- unused_closure_parameter.html | 12 +- unused_control_flow_label.html | 12 +- unused_declaration.html | 12 +- unused_enumerated.html | 12 +- unused_import.html | 12 +- unused_optional_binding.html | 12 +- unused_setter_value.html | 12 +- valid_ibinspectable.html | 12 +- vertical_parameter_alignment.html | 12 +- vertical_parameter_alignment_on_call.html | 12 +- vertical_whitespace.html | 12 +- vertical_whitespace_between_cases.html | 12 +- vertical_whitespace_closing_braces.html | 12 +- vertical_whitespace_opening_braces.html | 12 +- void_function_in_ternary.html | 12 +- void_return.html | 12 +- weak_delegate.html | 12 +- xct_specific_matcher.html | 12 +- xctfail_message.html | 12 +- yoda_condition.html | 12 +- 638 files changed, 3298 insertions(+), 7886 deletions(-) rename {docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs => Classes}/ConfigurationElement.html (74%) delete mode 100644 Extensions/NSRegularExpression.html delete mode 100644 Extensions/Range.html rename {Structs => docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes}/ConfigurationElement.html (74%) delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions/NSRegularExpression.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Extensions/Range.html diff --git a/Classes.html b/Classes.html index e4c807d9a..2d57ca8f2 100644 --- a/Classes.html +++ b/Classes.html @@ -67,6 +67,9 @@
  • Classes + +
    +
    + + +
    + +

    Property wrapper +

    +
    +
    +
      +
    • +
      + + + + ConfigurationElement + +
      +
      +
      +
      +
      +
      +

      A single parameter of a rule configuration.

      + +

      Apply it to a simple (e.g. boolean) property like

      +
      @ConfigurationElement(key: "name")
+var property = true
+
      + +

      If the wrapped element is an InlinableOptionType, there are two options for its representation +in the documentation:

      + +
        +
      1. It can be inlined into the parent configuration. For that, do not provide a name as an argument. E.g. +swift +@ConfigurationElement(key: "name") +var property = true +@ConfigurationElement +var levels = SeverityLevelsConfiguration(warning: 1, error: 2) + +will be documented as a linear list: + +name: true +warning: 1 +error: 2 +
        2. +
      2. It can be represented as a separate nested configuration. In this case, it must have a name. E.g. +swift +@ConfigurationElement(key: "name") +var property = true +@ConfigurationElement(key: "levels") +var levels = SeverityLevelsConfiguration(warning: 1, error: 2) + +will have a nested configuration section: + +name: true +levels: warning: 1 + error: 2 +
        3. +
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      @propertyWrapper
+public class ConfigurationElement<T> where T : Equatable, T : AcceptableByConfigurationElement
      +
      extension ConfigurationElement: Equatable
      + +
      +
      +
      + Show on GitHub +
      +
      +
      +
    • diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ConfigurationElement.html b/Classes/ConfigurationElement.html similarity index 74% rename from docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ConfigurationElement.html rename to Classes/ConfigurationElement.html index a5211336a..b87bd7f4d 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/ConfigurationElement.html +++ b/Classes/ConfigurationElement.html @@ -1,7 +1,7 @@ - ConfigurationElement Structure Reference + ConfigurationElement Class Reference @@ -14,9 +14,9 @@ - + - +

      @@ -50,7 +50,7 @@

      SwiftLintCore Reference - ConfigurationElement Structure Reference + ConfigurationElement Class Reference

      @@ -67,6 +67,9 @@
    • Classes
      • @@ -394,7 +389,7 @@ levels: warning: 1
      - Show on GitHub + Show on GitHub
      @@ -406,9 +401,9 @@ levels: warning: 1
    • @@ -428,7 +423,7 @@ levels: warning: 1
    - Show on GitHub + Show on GitHub
    @@ -436,9 +431,9 @@ levels: warning: 1
  • - + - projectedValue + projectedValue
    @@ -453,12 +448,12 @@ levels: warning: 1

    Declaration

    Swift

    - 
    public var projectedValue: String { get }
    + 
    public var projectedValue: ConfigurationElement { get }
    - Show on GitHub + Show on GitHub
    @@ -466,9 +461,39 @@ levels: warning: 1
  • - - - init(wrappedValue:key:) + + + key + +
    +
    +
    +
    +
    +
    +

    Name of this configuration entry.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public let key: String
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • +
  • +
    + + + + init(wrappedValue:key:postprocessor:)
    @@ -483,7 +508,7 @@ levels: warning: 1

    Declaration

    Swift

    - 
    public init(wrappedValue value: T, key: String)
    + 
    public init(wrappedValue value: T, key: String, postprocessor: @escaping (inout T) throws -> Void = { _ in })
    @@ -515,11 +540,23 @@ levels: warning: 1 + + + + postprocessor + + + +
    +

    Function to be applied to the wrapped value after parsing to validate and modify it.

    +
    + +
    - Show on GitHub + Show on GitHub
    @@ -527,9 +564,9 @@ levels: warning: 1
  • - + - init(key:) + init(key:)
    @@ -546,7 +583,7 @@ levels: warning: 1

    Declaration

    Swift

    - 
    public init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : AcceptableByConfigurationElement
    + 
    public convenience init<Wrapped>(key: String) where T == Wrapped?, Wrapped : Equatable, Wrapped : AcceptableByConfigurationElement
    @@ -570,7 +607,7 @@ levels: warning: 1
    - Show on GitHub + Show on GitHub
    @@ -578,9 +615,9 @@ levels: warning: 1
  • - + - init(wrappedValue:) + init(wrappedValue:)
    @@ -598,7 +635,7 @@ parent configuration in this specific case.

    Declaration

    Swift

    - 
    public init(wrappedValue value: T) where T : InlinableOptionType
    + 
    public convenience init(wrappedValue value: T) where T : InlinableOptionType
    @@ -622,7 +659,79 @@ parent configuration in this specific case.

    - Show on GitHub + Show on GitHub +
    + + +
    • +
  • +
    + + + + performAfterParseOperations() + +
    +
    +
    +
    +
    +
    +

    Run operations to validate and modify the parsed value.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func performAfterParseOperations() throws
    + +
    +
    +
    + Show on GitHub +
    +
    +
    +
    • + + +
    +
    + + +
    + +

    Property wrapper +

    +
    +
    +
    - Show on GitHub + Show on GitHub
    @@ -637,7 +630,7 @@
    - Show on GitHub + Show on GitHub
    diff --git a/Enums/AccessControlLevel.html b/Enums/AccessControlLevel.html index 6b50bfb82..c739fd109 100644 --- a/Enums/AccessControlLevel.html +++ b/Enums/AccessControlLevel.html @@ -67,6 +67,9 @@
  • Classes