From 8f1e5006d697440bd49c67ece094208bdcc1e678 Mon Sep 17 00:00:00 2001 From: "swiftlintbot@jpsim.com" Date: Mon, 23 Dec 2024 11:58:47 +0000 Subject: [PATCH] Automated deployment to GitHub Pages: 610722ccb231082371f8a21997293ae1a532bb96 --- Classes.html | 190 ++--- .../BodyLengthRuleVisitor.html | 366 ++++----- Classes/BodyLengthRuleVisitor/Kind.html | 454 +++++++++++ .../CodeBlockVisitor.html | 744 +++++++----------- Classes/CodeIndentingRewriter.html | 58 +- .../IndentationStyle.html | 58 +- Classes/CustomRuleTimer.html | 492 ------------ .../DeclaredIdentifiersTrackingVisitor.html | 64 +- Classes/LinterCache.html | 499 ------------ Classes/RuleRegistry.html | 58 +- Classes/RuleStorage.html | 58 +- Classes/SwiftLintFile.html | 58 +- Classes/ViolationsSyntaxRewriter.html | 64 +- Classes/ViolationsSyntaxVisitor.html | 64 +- Enums.html | 91 +-- Enums/AccessControlLevel.html | 58 +- Enums/ExecutableInfo.html | 432 ---------- Enums/IdentifierDeclaration.html | 58 +- Enums/Issue.html | 60 +- Enums/OptionType.html | 58 +- Enums/RuleIdentifier.html | 58 +- Enums/RuleKind.html | 58 +- Enums/RuleListError.html | 58 +- Enums/SwiftExpressionKind.html | 58 +- Enums/ViolationSeverity.html | 58 +- Extensions.html | 58 +- Extensions/Array.html | 58 +- Extensions/Bool.html | 58 +- Extensions/Double.html | 58 +- Extensions/Int.html | 58 +- Extensions/Optional.html | 58 +- Extensions/Set.html | 58 +- Extensions/String.html | 58 +- Functions.html | 444 ----------- Global Variables.html | 450 ----------- Guides.html | 58 +- Macros.html | 58 +- Protocols.html | 89 +-- Protocols/ASTRule.html | 58 +- .../AcceptableByConfigurationElement.html | 58 +- Protocols/AnalyzerRule.html | 58 +- Protocols/CacheDescriptionProvider.html | 58 +- Protocols/CollectingRule.html | 62 +- Protocols/CorrectableRule.html | 58 +- Protocols/Documentable.html | 58 +- Protocols/Reporter.html | 576 -------------- Protocols/Rule.html | 60 +- Protocols/RuleConfiguration.html | 58 +- Protocols/SeverityBasedRuleConfiguration.html | 58 +- Protocols/SubstitutionCorrectableRule.html | 58 +- Protocols/SwiftSyntaxCorrectableRule.html | 58 +- Protocols/SwiftSyntaxRule.html | 58 +- Protocols/VersionComparable.html | 58 +- Rules.html | 58 +- Structs.html | 263 +------ Structs/Baseline.html | 58 +- Structs/ChildOptionSeverityConfiguration.html | 58 +- Structs/Command.html | 58 +- Structs/Command/Action.html | 58 +- Structs/Command/Modifier.html | 58 +- Structs/ConfigurationElement.html | 58 +- .../DeprecationNotice.html | 58 +- Structs/Correction.html | 58 +- Structs/Example.html | 58 +- Structs/Linter.html | 603 -------------- Structs/Location.html | 58 +- Structs/ReasonedRuleViolation.html | 58 +- .../ViolationCorrection.html | 58 +- Structs/RegexConfiguration.html | 58 +- Structs/Region.html | 58 +- Structs/RuleConfigurationDescription.html | 58 +- Structs/RuleConfigurationOption.html | 58 +- Structs/RuleDescription.html | 58 +- Structs/RuleList.html | 58 +- Structs/RuleListDocumentation.html | 505 ------------ Structs/RuleParameter.html | 58 +- Structs/SeverityConfiguration.html | 58 +- Structs/SeverityLevelsConfiguration.html | 58 +- Structs/Stack.html | 58 +- Structs/StyleViolation.html | 70 +- Structs/SwiftLintSyntaxMap.html | 58 +- Structs/SwiftLintSyntaxToken.html | 58 +- Structs/SwiftVersion.html | 58 +- Structs/Version.html | 541 ------------- Structs/YamlParser.html | 473 ----------- accessibility_label_for_image.html | 58 +- accessibility_trait_for_button.html | 58 +- anonymous_argument_in_multiline_closure.html | 58 +- array_init.html | 58 +- async_without_await.html | 58 +- attribute_name_spacing.html | 58 +- attributes.html | 58 +- balanced_xctest_lifecycle.html | 58 +- blanket_disable_command.html | 58 +- block_based_kvo.html | 58 +- capture_variable.html | 58 +- class_delegate_protocol.html | 58 +- closing_brace.html | 58 +- closure_body_length.html | 58 +- closure_end_indentation.html | 58 +- closure_parameter_position.html | 58 +- closure_spacing.html | 58 +- collection_alignment.html | 58 +- colon.html | 58 +- comma.html | 58 +- comma_inheritance.html | 58 +- comment_spacing.html | 58 +- compiler_protocol_init.html | 58 +- computed_accessors_order.html | 58 +- conditional_returns_on_newline.html | 58 +- contains_over_filter_count.html | 58 +- contains_over_filter_is_empty.html | 58 +- contains_over_first_not_nil.html | 58 +- contains_over_range_nil_comparison.html | 58 +- contrasted_opening_brace.html | 58 +- control_statement.html | 58 +- convenience_type.html | 58 +- custom_rules.html | 58 +- cyclomatic_complexity.html | 58 +- deployment_target.html | 58 +- direct_return.html | 58 +- discarded_notification_center_observer.html | 58 +- discouraged_assert.html | 58 +- discouraged_direct_init.html | 58 +- discouraged_none_name.html | 58 +- discouraged_object_literal.html | 58 +- discouraged_optional_boolean.html | 58 +- discouraged_optional_collection.html | 58 +- .../Contents/Resources/Documents/Classes.html | 190 ++--- .../Classes/BodyLengthRuleVisitor.html | 366 ++++----- .../Classes/BodyLengthRuleVisitor/Kind.html | 454 +++++++++++ .../CodeBlockVisitor.html} | 744 +++++++----------- .../Classes/CodeIndentingRewriter.html | 58 +- .../IndentationStyle.html | 58 +- .../Documents/Classes/CustomRuleTimer.html | 492 ------------ .../DeclaredIdentifiersTrackingVisitor.html | 64 +- .../Documents/Classes/LinterCache.html | 499 ------------ .../Documents/Classes/RuleRegistry.html | 58 +- .../Documents/Classes/RuleStorage.html | 58 +- .../Documents/Classes/SwiftLintFile.html | 58 +- .../Classes/ViolationsSyntaxRewriter.html | 64 +- .../Classes/ViolationsSyntaxVisitor.html | 64 +- .../Contents/Resources/Documents/Enums.html | 91 +-- .../Documents/Enums/AccessControlLevel.html | 58 +- .../Documents/Enums/ExecutableInfo.html | 432 ---------- .../Enums/IdentifierDeclaration.html | 58 +- .../Resources/Documents/Enums/Issue.html | 60 +- .../Resources/Documents/Enums/OptionType.html | 58 +- .../Documents/Enums/RuleIdentifier.html | 58 +- .../Resources/Documents/Enums/RuleKind.html | 58 +- .../Documents/Enums/RuleListError.html | 58 +- .../Documents/Enums/SwiftExpressionKind.html | 58 +- .../Documents/Enums/ViolationSeverity.html | 58 +- .../Resources/Documents/Extensions.html | 58 +- .../Resources/Documents/Extensions/Array.html | 58 +- .../Resources/Documents/Extensions/Bool.html | 58 +- .../Documents/Extensions/Double.html | 58 +- .../Resources/Documents/Extensions/Int.html | 58 +- .../Documents/Extensions/Optional.html | 58 +- .../Resources/Documents/Extensions/Set.html | 58 +- .../Documents/Extensions/String.html | 58 +- .../Resources/Documents/Functions.html | 444 ----------- .../Resources/Documents/Global Variables.html | 450 ----------- .../Contents/Resources/Documents/Guides.html | 58 +- .../Contents/Resources/Documents/Macros.html | 58 +- .../Resources/Documents/Protocols.html | 89 +-- .../Documents/Protocols/ASTRule.html | 58 +- .../AcceptableByConfigurationElement.html | 58 +- .../Documents/Protocols/AnalyzerRule.html | 58 +- .../Protocols/CacheDescriptionProvider.html | 58 +- .../Documents/Protocols/CollectingRule.html | 62 +- .../Documents/Protocols/CorrectableRule.html | 58 +- .../Documents/Protocols/Documentable.html | 58 +- .../Documents/Protocols/Reporter.html | 576 -------------- .../Resources/Documents/Protocols/Rule.html | 60 +- .../Protocols/RuleConfiguration.html | 58 +- .../SeverityBasedRuleConfiguration.html | 58 +- .../SubstitutionCorrectableRule.html | 58 +- .../Protocols/SwiftSyntaxCorrectableRule.html | 58 +- .../Documents/Protocols/SwiftSyntaxRule.html | 58 +- .../Protocols/VersionComparable.html | 58 +- .../Contents/Resources/Documents/Rules.html | 58 +- .../Contents/Resources/Documents/Structs.html | 263 +------ .../Resources/Documents/Structs/Baseline.html | 58 +- .../ChildOptionSeverityConfiguration.html | 58 +- .../Resources/Documents/Structs/Command.html | 58 +- .../Documents/Structs/Command/Action.html | 58 +- .../Documents/Structs/Command/Modifier.html | 58 +- .../Structs/ConfigurationElement.html | 58 +- .../DeprecationNotice.html | 58 +- .../Documents/Structs/Correction.html | 58 +- .../Resources/Documents/Structs/Example.html | 58 +- .../Resources/Documents/Structs/Linter.html | 603 -------------- .../Resources/Documents/Structs/Location.html | 58 +- .../Structs/ReasonedRuleViolation.html | 58 +- .../ViolationCorrection.html | 58 +- .../Documents/Structs/RegexConfiguration.html | 58 +- .../Resources/Documents/Structs/Region.html | 58 +- .../Structs/RuleConfigurationDescription.html | 58 +- .../Structs/RuleConfigurationOption.html | 58 +- .../Documents/Structs/RuleDescription.html | 58 +- .../Resources/Documents/Structs/RuleList.html | 58 +- .../Structs/RuleListDocumentation.html | 505 ------------ .../Documents/Structs/RuleParameter.html | 58 +- .../Structs/SeverityConfiguration.html | 58 +- .../Structs/SeverityLevelsConfiguration.html | 58 +- .../Resources/Documents/Structs/Stack.html | 58 +- .../Documents/Structs/StyleViolation.html | 70 +- .../Documents/Structs/SwiftLintSyntaxMap.html | 58 +- .../Structs/SwiftLintSyntaxToken.html | 58 +- .../Documents/Structs/SwiftVersion.html | 58 +- .../Resources/Documents/Structs/Version.html | 541 ------------- .../Documents/Structs/YamlParser.html | 473 ----------- .../accessibility_label_for_image.html | 58 +- .../accessibility_trait_for_button.html | 58 +- ...onymous_argument_in_multiline_closure.html | 58 +- .../Resources/Documents/array_init.html | 58 +- .../Documents/async_without_await.html | 58 +- .../Documents/attribute_name_spacing.html | 58 +- .../Resources/Documents/attributes.html | 58 +- .../Documents/balanced_xctest_lifecycle.html | 58 +- .../Documents/blanket_disable_command.html | 58 +- .../Resources/Documents/block_based_kvo.html | 58 +- .../Resources/Documents/capture_variable.html | 58 +- .../Documents/class_delegate_protocol.html | 58 +- .../Resources/Documents/closing_brace.html | 58 +- .../Documents/closure_body_length.html | 58 +- .../Documents/closure_end_indentation.html | 58 +- .../Documents/closure_parameter_position.html | 58 +- .../Resources/Documents/closure_spacing.html | 58 +- .../Documents/collection_alignment.html | 58 +- .../Contents/Resources/Documents/colon.html | 58 +- .../Contents/Resources/Documents/comma.html | 58 +- .../Documents/comma_inheritance.html | 58 +- .../Resources/Documents/comment_spacing.html | 58 +- .../Documents/compiler_protocol_init.html | 58 +- .../Documents/computed_accessors_order.html | 58 +- .../conditional_returns_on_newline.html | 58 +- .../Documents/contains_over_filter_count.html | 58 +- .../contains_over_filter_is_empty.html | 58 +- .../contains_over_first_not_nil.html | 58 +- .../contains_over_range_nil_comparison.html | 58 +- .../Documents/contrasted_opening_brace.html | 58 +- .../Documents/control_statement.html | 58 +- .../Resources/Documents/convenience_type.html | 58 +- .../Resources/Documents/custom_rules.html | 58 +- .../Documents/cyclomatic_complexity.html | 58 +- .../Documents/deployment_target.html | 58 +- .../Resources/Documents/direct_return.html | 58 +- ...iscarded_notification_center_observer.html | 58 +- .../Documents/discouraged_assert.html | 58 +- .../Documents/discouraged_direct_init.html | 58 +- .../Documents/discouraged_none_name.html | 58 +- .../Documents/discouraged_object_literal.html | 58 +- .../discouraged_optional_boolean.html | 58 +- .../discouraged_optional_collection.html | 58 +- .../Documents/duplicate_conditions.html | 58 +- .../Documents/duplicate_enum_cases.html | 58 +- .../Documents/duplicate_imports.html | 58 +- .../duplicated_key_in_dictionary_literal.html | 58 +- .../Resources/Documents/dynamic_inline.html | 58 +- .../Documents/empty_collection_literal.html | 58 +- .../Resources/Documents/empty_count.html | 58 +- .../Documents/empty_enum_arguments.html | 58 +- .../Resources/Documents/empty_parameters.html | 58 +- ...pty_parentheses_with_trailing_closure.html | 58 +- .../Resources/Documents/empty_string.html | 58 +- .../Documents/empty_xctest_method.html | 58 +- .../enum_case_associated_values_count.html | 58 +- .../Resources/Documents/expiring_todo.html | 58 +- .../Resources/Documents/explicit_acl.html | 58 +- .../Documents/explicit_enum_raw_value.html | 58 +- .../Resources/Documents/explicit_init.html | 58 +- .../Resources/Documents/explicit_self.html | 58 +- .../Documents/explicit_top_level_acl.html | 58 +- .../Documents/explicit_type_interface.html | 58 +- .../Documents/extension_access_modifier.html | 58 +- .../Resources/Documents/fallthrough.html | 58 +- .../Documents/fatal_error_message.html | 58 +- .../Resources/Documents/file_header.html | 58 +- .../Resources/Documents/file_length.html | 58 +- .../Resources/Documents/file_name.html | 58 +- .../Documents/file_name_no_space.html | 58 +- .../Resources/Documents/file_types_order.html | 58 +- .../Resources/Documents/final_test_case.html | 58 +- .../Resources/Documents/first_where.html | 58 +- .../Documents/flatmap_over_map_reduce.html | 58 +- .../Resources/Documents/for_where.html | 58 +- .../Resources/Documents/force_cast.html | 58 +- .../Resources/Documents/force_try.html | 58 +- .../Resources/Documents/force_unwrapping.html | 58 +- .../Documents/function_body_length.html | 58 +- .../function_default_parameter_at_end.html | 58 +- .../Documents/function_parameter_count.html | 58 +- .../Documents/generic_type_name.html | 58 +- .../Documents/ibinspectable_in_extension.html | 58 +- .../Documents/identical_operands.html | 58 +- .../Resources/Documents/identifier_name.html | 58 +- .../Resources/Documents/implicit_getter.html | 58 +- .../Resources/Documents/implicit_return.html | 58 +- .../implicitly_unwrapped_optional.html | 58 +- .../Documents/inclusive_language.html | 58 +- .../Documents/indentation_width.html | 58 +- .../Contents/Resources/Documents/index.html | 58 +- .../Documents/invalid_swiftlint_command.html | 58 +- .../Resources/Documents/is_disjoint.html | 58 +- .../Documents/joined_default_parameter.html | 58 +- .../Resources/Documents/large_tuple.html | 58 +- .../Resources/Documents/last_where.html | 58 +- .../Documents/leading_whitespace.html | 58 +- .../legacy_cggeometry_functions.html | 58 +- .../Resources/Documents/legacy_constant.html | 58 +- .../Documents/legacy_constructor.html | 58 +- .../Resources/Documents/legacy_hashing.html | 58 +- .../Resources/Documents/legacy_multiple.html | 58 +- .../legacy_nsgeometry_functions.html | 58 +- .../Resources/Documents/legacy_objc_type.html | 58 +- .../Resources/Documents/legacy_random.html | 58 +- .../Documents/let_var_whitespace.html | 58 +- .../Resources/Documents/line_length.html | 58 +- .../literal_expression_end_indentation.html | 58 +- .../Documents/local_doc_comment.html | 58 +- .../Documents/lower_acl_than_parent.html | 58 +- .../Contents/Resources/Documents/mark.html | 58 +- .../Resources/Documents/missing_docs.html | 58 +- .../Resources/Documents/modifier_order.html | 58 +- .../Documents/multiline_arguments.html | 58 +- .../multiline_arguments_brackets.html | 58 +- .../Documents/multiline_function_chains.html | 58 +- .../Documents/multiline_literal_brackets.html | 58 +- .../Documents/multiline_parameters.html | 58 +- .../multiline_parameters_brackets.html | 58 +- ...ltiple_closures_with_trailing_closure.html | 58 +- .../Contents/Resources/Documents/nesting.html | 58 +- .../Resources/Documents/nimble_operator.html | 58 +- .../Resources/Documents/no_empty_block.html | 58 +- .../no_extension_access_modifier.html | 58 +- .../Documents/no_fallthrough_only.html | 58 +- .../Documents/no_grouping_extension.html | 58 +- .../Resources/Documents/no_magic_numbers.html | 58 +- .../Documents/no_space_in_method_call.html | 58 +- .../non_optional_string_data_conversion.html | 58 +- .../non_overridable_class_declaration.html | 58 +- .../notification_center_detachment.html | 58 +- .../ns_number_init_as_function_reference.html | 58 +- .../Documents/nslocalizedstring_key.html | 58 +- .../nslocalizedstring_require_bundle.html | 58 +- .../Documents/nsobject_prefer_isequal.html | 58 +- .../Resources/Documents/number_separator.html | 58 +- .../Resources/Documents/object_literal.html | 58 +- .../Documents/one_declaration_per_file.html | 58 +- .../Resources/Documents/opening_brace.html | 58 +- .../Documents/operator_usage_whitespace.html | 58 +- .../Documents/operator_whitespace.html | 58 +- .../optional_data_string_conversion.html | 58 +- .../optional_enum_case_matching.html | 58 +- .../Documents/orphaned_doc_comment.html | 58 +- .../Documents/overridden_super_call.html | 58 +- .../Documents/override_in_extension.html | 58 +- .../Documents/pattern_matching_keywords.html | 58 +- .../Resources/Documents/period_spacing.html | 58 +- .../Resources/Documents/prefer_key_path.html | 58 +- .../Resources/Documents/prefer_nimble.html | 58 +- .../prefer_self_in_static_references.html | 58 +- .../prefer_self_type_over_type_of_self.html | 58 +- .../Documents/prefer_type_checking.html | 58 +- .../prefer_zero_over_explicit_init.html | 58 +- .../Documents/prefixed_toplevel_constant.html | 58 +- .../Resources/Documents/private_action.html | 58 +- .../Resources/Documents/private_outlet.html | 58 +- .../Documents/private_over_fileprivate.html | 58 +- .../Resources/Documents/private_subject.html | 58 +- .../Documents/private_swiftui_state.html | 58 +- .../Documents/private_unit_test.html | 58 +- .../prohibited_interface_builder.html | 58 +- .../Documents/prohibited_super_call.html | 58 +- .../protocol_property_accessors_order.html | 58 +- .../Documents/quick_discouraged_call.html | 58 +- .../quick_discouraged_focused_test.html | 58 +- .../quick_discouraged_pending_test.html | 58 +- ...aw_value_for_camel_cased_codable_enum.html | 58 +- .../Resources/Documents/reduce_boolean.html | 58 +- .../Resources/Documents/reduce_into.html | 58 +- .../Documents/redundant_discardable_let.html | 58 +- .../Documents/redundant_nil_coalescing.html | 58 +- .../Documents/redundant_objc_attribute.html | 58 +- .../redundant_optional_initialization.html | 58 +- .../Documents/redundant_self_in_closure.html | 58 +- .../redundant_set_access_control.html | 58 +- .../redundant_string_enum_value.html | 58 +- .../Documents/redundant_type_annotation.html | 58 +- .../Documents/redundant_void_return.html | 58 +- .../Resources/Documents/required_deinit.html | 58 +- .../Documents/required_enum_case.html | 58 +- .../Documents/return_arrow_whitespace.html | 58 +- .../return_value_from_void_function.html | 58 +- .../Resources/Documents/rule-directory.html | 58 +- .../Contents/Resources/Documents/search.json | 2 +- .../Resources/Documents/self_binding.html | 58 +- .../self_in_property_initialization.html | 58 +- .../Documents/shorthand_argument.html | 58 +- .../Documents/shorthand_operator.html | 58 +- .../Documents/shorthand_optional_binding.html | 58 +- .../Documents/single_test_class.html | 58 +- .../Documents/sorted_enum_cases.html | 58 +- .../Documents/sorted_first_last.html | 58 +- .../Resources/Documents/sorted_imports.html | 58 +- .../Documents/statement_position.html | 58 +- .../Resources/Documents/static_operator.html | 58 +- .../Documents/static_over_final_class.html | 58 +- .../Documents/strict_fileprivate.html | 58 +- .../Resources/Documents/strong_iboutlet.html | 58 +- .../superfluous_disable_command.html | 58 +- .../Resources/Documents/superfluous_else.html | 58 +- .../Documents/swift-syntax-dashboard.html | 58 +- .../Documents/switch_case_alignment.html | 58 +- .../Documents/switch_case_on_newline.html | 58 +- .../Resources/Documents/syntactic_sugar.html | 58 +- .../Documents/test_case_accessibility.html | 58 +- .../Contents/Resources/Documents/todo.html | 58 +- .../Resources/Documents/toggle_bool.html | 58 +- .../Resources/Documents/trailing_closure.html | 58 +- .../Resources/Documents/trailing_comma.html | 58 +- .../Resources/Documents/trailing_newline.html | 58 +- .../Documents/trailing_semicolon.html | 58 +- .../Documents/trailing_whitespace.html | 58 +- .../Resources/Documents/type_body_length.html | 58 +- .../Documents/type_contents_order.html | 58 +- .../Resources/Documents/type_name.html | 58 +- .../Documents/typesafe_array_init.html | 58 +- .../Documents/unavailable_condition.html | 58 +- .../Documents/unavailable_function.html | 58 +- .../Documents/unhandled_throwing_task.html | 58 +- .../Documents/unneeded_break_in_switch.html | 58 +- .../Documents/unneeded_override.html | 58 +- ...eeded_parentheses_in_closure_argument.html | 58 +- .../unneeded_synthesized_initializer.html | 58 +- .../Documents/unowned_variable_capture.html | 58 +- .../Documents/untyped_error_in_catch.html | 58 +- .../Documents/unused_closure_parameter.html | 58 +- .../Documents/unused_control_flow_label.html | 58 +- .../Documents/unused_declaration.html | 58 +- .../Documents/unused_enumerated.html | 58 +- .../Resources/Documents/unused_import.html | 58 +- .../Documents/unused_optional_binding.html | 58 +- .../Resources/Documents/unused_parameter.html | 58 +- .../Documents/unused_setter_value.html | 58 +- .../Documents/valid_ibinspectable.html | 58 +- .../vertical_parameter_alignment.html | 58 +- .../vertical_parameter_alignment_on_call.html | 58 +- .../Documents/vertical_whitespace.html | 58 +- .../vertical_whitespace_between_cases.html | 58 +- .../vertical_whitespace_closing_braces.html | 58 +- .../vertical_whitespace_opening_braces.html | 58 +- .../Documents/void_function_in_ternary.html | 58 +- .../Resources/Documents/void_return.html | 58 +- .../Resources/Documents/weak_delegate.html | 58 +- .../Documents/xct_specific_matcher.html | 58 +- .../Resources/Documents/xctfail_message.html | 58 +- .../Resources/Documents/yoda_condition.html | 58 +- .../Contents/Resources/docSet.dsidx | Bin 176128 -> 176128 bytes docsets/SwiftLintCore.tgz | Bin 692365 -> 605838 bytes duplicate_conditions.html | 58 +- duplicate_enum_cases.html | 58 +- duplicate_imports.html | 58 +- duplicated_key_in_dictionary_literal.html | 58 +- dynamic_inline.html | 58 +- empty_collection_literal.html | 58 +- empty_count.html | 58 +- empty_enum_arguments.html | 58 +- empty_parameters.html | 58 +- empty_parentheses_with_trailing_closure.html | 58 +- empty_string.html | 58 +- empty_xctest_method.html | 58 +- enum_case_associated_values_count.html | 58 +- expiring_todo.html | 58 +- explicit_acl.html | 58 +- explicit_enum_raw_value.html | 58 +- explicit_init.html | 58 +- explicit_self.html | 58 +- explicit_top_level_acl.html | 58 +- explicit_type_interface.html | 58 +- extension_access_modifier.html | 58 +- fallthrough.html | 58 +- fatal_error_message.html | 58 +- file_header.html | 58 +- file_length.html | 58 +- file_name.html | 58 +- file_name_no_space.html | 58 +- file_types_order.html | 58 +- final_test_case.html | 58 +- first_where.html | 58 +- flatmap_over_map_reduce.html | 58 +- for_where.html | 58 +- force_cast.html | 58 +- force_try.html | 58 +- force_unwrapping.html | 58 +- function_body_length.html | 58 +- function_default_parameter_at_end.html | 58 +- function_parameter_count.html | 58 +- generic_type_name.html | 58 +- ibinspectable_in_extension.html | 58 +- identical_operands.html | 58 +- identifier_name.html | 58 +- implicit_getter.html | 58 +- implicit_return.html | 58 +- implicitly_unwrapped_optional.html | 58 +- inclusive_language.html | 58 +- indentation_width.html | 58 +- index.html | 58 +- invalid_swiftlint_command.html | 58 +- is_disjoint.html | 58 +- joined_default_parameter.html | 58 +- large_tuple.html | 58 +- last_where.html | 58 +- leading_whitespace.html | 58 +- legacy_cggeometry_functions.html | 58 +- legacy_constant.html | 58 +- legacy_constructor.html | 58 +- legacy_hashing.html | 58 +- legacy_multiple.html | 58 +- legacy_nsgeometry_functions.html | 58 +- legacy_objc_type.html | 58 +- legacy_random.html | 58 +- let_var_whitespace.html | 58 +- line_length.html | 58 +- literal_expression_end_indentation.html | 58 +- local_doc_comment.html | 58 +- lower_acl_than_parent.html | 58 +- mark.html | 58 +- missing_docs.html | 58 +- modifier_order.html | 58 +- multiline_arguments.html | 58 +- multiline_arguments_brackets.html | 58 +- multiline_function_chains.html | 58 +- multiline_literal_brackets.html | 58 +- multiline_parameters.html | 58 +- multiline_parameters_brackets.html | 58 +- multiple_closures_with_trailing_closure.html | 58 +- nesting.html | 58 +- nimble_operator.html | 58 +- no_empty_block.html | 58 +- no_extension_access_modifier.html | 58 +- no_fallthrough_only.html | 58 +- no_grouping_extension.html | 58 +- no_magic_numbers.html | 58 +- no_space_in_method_call.html | 58 +- non_optional_string_data_conversion.html | 58 +- non_overridable_class_declaration.html | 58 +- notification_center_detachment.html | 58 +- ns_number_init_as_function_reference.html | 58 +- nslocalizedstring_key.html | 58 +- nslocalizedstring_require_bundle.html | 58 +- nsobject_prefer_isequal.html | 58 +- number_separator.html | 58 +- object_literal.html | 58 +- one_declaration_per_file.html | 58 +- opening_brace.html | 58 +- operator_usage_whitespace.html | 58 +- operator_whitespace.html | 58 +- optional_data_string_conversion.html | 58 +- optional_enum_case_matching.html | 58 +- orphaned_doc_comment.html | 58 +- overridden_super_call.html | 58 +- override_in_extension.html | 58 +- pattern_matching_keywords.html | 58 +- period_spacing.html | 58 +- prefer_key_path.html | 58 +- prefer_nimble.html | 58 +- prefer_self_in_static_references.html | 58 +- prefer_self_type_over_type_of_self.html | 58 +- prefer_type_checking.html | 58 +- prefer_zero_over_explicit_init.html | 58 +- prefixed_toplevel_constant.html | 58 +- private_action.html | 58 +- private_outlet.html | 58 +- private_over_fileprivate.html | 58 +- private_subject.html | 58 +- private_swiftui_state.html | 58 +- private_unit_test.html | 58 +- prohibited_interface_builder.html | 58 +- prohibited_super_call.html | 58 +- protocol_property_accessors_order.html | 58 +- quick_discouraged_call.html | 58 +- quick_discouraged_focused_test.html | 58 +- quick_discouraged_pending_test.html | 58 +- raw_value_for_camel_cased_codable_enum.html | 58 +- reduce_boolean.html | 58 +- reduce_into.html | 58 +- redundant_discardable_let.html | 58 +- redundant_nil_coalescing.html | 58 +- redundant_objc_attribute.html | 58 +- redundant_optional_initialization.html | 58 +- redundant_self_in_closure.html | 58 +- redundant_set_access_control.html | 58 +- redundant_string_enum_value.html | 58 +- redundant_type_annotation.html | 58 +- redundant_void_return.html | 58 +- required_deinit.html | 58 +- required_enum_case.html | 58 +- return_arrow_whitespace.html | 58 +- return_value_from_void_function.html | 58 +- rule-directory.html | 58 +- search.json | 2 +- self_binding.html | 58 +- self_in_property_initialization.html | 58 +- shorthand_argument.html | 58 +- shorthand_operator.html | 58 +- shorthand_optional_binding.html | 58 +- single_test_class.html | 58 +- sorted_enum_cases.html | 58 +- sorted_first_last.html | 58 +- sorted_imports.html | 58 +- statement_position.html | 58 +- static_operator.html | 58 +- static_over_final_class.html | 58 +- strict_fileprivate.html | 58 +- strong_iboutlet.html | 58 +- superfluous_disable_command.html | 58 +- superfluous_else.html | 58 +- swift-syntax-dashboard.html | 58 +- switch_case_alignment.html | 58 +- switch_case_on_newline.html | 58 +- syntactic_sugar.html | 58 +- test_case_accessibility.html | 58 +- todo.html | 58 +- toggle_bool.html | 58 +- trailing_closure.html | 58 +- trailing_comma.html | 58 +- trailing_newline.html | 58 +- trailing_semicolon.html | 58 +- trailing_whitespace.html | 58 +- type_body_length.html | 58 +- type_contents_order.html | 58 +- type_name.html | 58 +- typesafe_array_init.html | 58 +- unavailable_condition.html | 58 +- unavailable_function.html | 58 +- unhandled_throwing_task.html | 58 +- unneeded_break_in_switch.html | 58 +- unneeded_override.html | 58 +- unneeded_parentheses_in_closure_argument.html | 58 +- unneeded_synthesized_initializer.html | 58 +- unowned_variable_capture.html | 58 +- untyped_error_in_catch.html | 58 +- unused_closure_parameter.html | 58 +- unused_control_flow_label.html | 58 +- unused_declaration.html | 58 +- unused_enumerated.html | 58 +- unused_import.html | 58 +- unused_optional_binding.html | 58 +- unused_parameter.html | 58 +- unused_setter_value.html | 58 +- valid_ibinspectable.html | 58 +- vertical_parameter_alignment.html | 58 +- vertical_parameter_alignment_on_call.html | 58 +- vertical_whitespace.html | 58 +- vertical_whitespace_between_cases.html | 58 +- vertical_whitespace_closing_braces.html | 58 +- vertical_whitespace_opening_braces.html | 58 +- void_function_in_ternary.html | 58 +- void_return.html | 58 +- weak_delegate.html | 58 +- xct_specific_matcher.html | 58 +- xctfail_message.html | 58 +- yoda_condition.html | 58 +- 666 files changed, 7722 insertions(+), 43206 deletions(-) rename docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html => Classes/BodyLengthRuleVisitor.html (64%) create mode 100644 Classes/BodyLengthRuleVisitor/Kind.html rename Structs/Configuration.html => Classes/CodeBlockVisitor.html (58%) delete mode 100644 Classes/CustomRuleTimer.html delete mode 100644 Classes/LinterCache.html delete mode 100644 Enums/ExecutableInfo.html delete mode 100644 Functions.html delete mode 100644 Global Variables.html delete mode 100644 Protocols/Reporter.html delete mode 100644 Structs/Linter.html delete mode 100644 Structs/RuleListDocumentation.html delete mode 100644 Structs/Version.html delete mode 100644 Structs/YamlParser.html rename Structs/CollectedLinter.html => docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor.html (64%) create mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor/Kind.html rename docsets/SwiftLintCore.docset/Contents/Resources/Documents/{Structs/Configuration.html => Classes/CodeBlockVisitor.html} (58%) delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CustomRuleTimer.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Enums/ExecutableInfo.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Functions.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Global Variables.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/Reporter.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Linter.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/RuleListDocumentation.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Version.html delete mode 100644 docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/YamlParser.html diff --git a/Classes.html b/Classes.html index 16bafe296..648cb36e6 100644 --- a/Classes.html +++ b/Classes.html @@ -67,21 +67,24 @@ - - +
  • +
    + + + + BodyLengthRuleVisitor + +
    +
    +
    +
    +
    +
    +

    Visitor that collection violations of code block lengths.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public final class BodyLengthRuleVisitor<Parent> : ViolationsSyntaxVisitor<SeverityLevelsConfiguration<Parent>> where Parent : Rule
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + CodeBlockVisitor + +
    +
    +
    +
    +
    +
    +

    A visitor that collects style violations for all available code blocks.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    open class CodeBlockVisitor<Configuration> : ViolationsSyntaxVisitor<Configuration> where Configuration : RuleConfiguration
    + +
    +
    + +
    +
    +
  • @@ -615,8 +575,8 @@ AST nodes (e.g. a code block in a code block).

    Declaration

    Swift

    -
    open class DeclaredIdentifiersTrackingVisitor<Configuration: RuleConfiguration>:
    -        ViolationsSyntaxVisitor<Configuration>
    +
    open class DeclaredIdentifiersTrackingVisitor<Configuration: RuleConfiguration>:
    +        ViolationsSyntaxVisitor<Configuration>
    @@ -647,7 +607,7 @@ AST nodes (e.g. a code block in a code block).

    Declaration

    Swift

    -
    open class ViolationsSyntaxVisitor<Configuration> : SyntaxVisitor where Configuration : RuleConfiguration
    +
    open class ViolationsSyntaxVisitor<Configuration> : SyntaxVisitor where Configuration : RuleConfiguration
    diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html b/Classes/BodyLengthRuleVisitor.html similarity index 64% rename from docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html rename to Classes/BodyLengthRuleVisitor.html index cbaee620f..16c8b5639 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/CollectedLinter.html +++ b/Classes/BodyLengthRuleVisitor.html @@ -1,7 +1,7 @@ - CollectedLinter Structure Reference + BodyLengthRuleVisitor Class Reference @@ -14,9 +14,9 @@ - + - +

    @@ -50,9 +50,9 @@

    @@ -69,21 +69,24 @@ - -
  • - - - file + + + Kind
    @@ -402,19 +360,20 @@
    -

    The file to lint with this linter.

    +

    The code block types to check.

    + See more

    Declaration

    Swift

    -
    public let file: SwiftLintFile
    +
    public enum Kind
    @@ -422,9 +381,9 @@
  • @@ -432,14 +391,14 @@
    -

    Computes or retrieves style violations.

    +

    Initializer.

    Declaration

    Swift

    -
    public func styleViolations(using storage: RuleStorage) -> [StyleViolation]
    +
    public init(kind: Kind, file: SwiftLintFile, configuration: SeverityLevelsConfiguration<Parent>)
    @@ -450,24 +409,44 @@ - storage + kind
    -

    The storage object containing all collected info.

    +

    The code block type to check. See Kind.

    +
    + + + + + + file + + + +
    +

    The file to collect violation for.

    +
    + + + + + + configuration + + + +
    +

    The configuration that defines the acceptable limits.

    -
    -

    Return Value

    -

    All style violations found by this linter.

    -
  • @@ -475,9 +454,9 @@
  • @@ -485,43 +464,18 @@
    -

    Computes or retrieves style violations and the time spent executing each rule.

    - +

    Declaration

    Swift

    -
    public func styleViolationsAndRuleTimes(using storage: RuleStorage)
    -    -> ([StyleViolation], [(id: String, time: Double)])
    +
    override public func visitPost(_ node: EnumDeclSyntax)
    -
    -

    Parameters

    - - - - - - - -
    - - storage - - -
    -

    The storage object containing all collected info.

    -
    -
    -
    -
    -

    Return Value

    -

    All style violations found by this linter, and the time spent executing each rule.

    -
    @@ -529,9 +483,9 @@
  • @@ -539,42 +493,18 @@
    -

    Applies corrections for all rules to this file, returning performed corrections.

    - +

    Declaration

    Swift

    -
    public func correct(using storage: RuleStorage) -> [Correction]
    +
    override public func visitPost(_ node: ClassDeclSyntax)
    -
    -

    Parameters

    - - - - - - - -
    - - storage - - -
    -

    The storage object containing all collected info.

    -
    -
    -
    -
    -

    Return Value

    -

    All corrections that were applied.

    -
    @@ -582,9 +512,9 @@
  • @@ -592,50 +522,134 @@
    -

    Formats the file associated with this linter.

    - +

    Declaration

    Swift

    -
    public func format(useTabs: Bool, indentWidth: Int)
    +
    override public func visitPost(_ node: StructDeclSyntax)
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - useTabs - - -
    -

    Should the file be formatted using tabs?

    -
    -
    - - indentWidth - - -
    -

    How many spaces should be used per indentation level.

    -
    -
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: ActorDeclSyntax)
    + +
    +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: ClosureExprSyntax)
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: FunctionDeclSyntax)
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: InitializerDeclSyntax)
    + +
    +
    +
    diff --git a/Classes/BodyLengthRuleVisitor/Kind.html b/Classes/BodyLengthRuleVisitor/Kind.html new file mode 100644 index 000000000..993e5506d --- /dev/null +++ b/Classes/BodyLengthRuleVisitor/Kind.html @@ -0,0 +1,454 @@ + + + + Kind Enumeration Reference + + + + + + + + + + + + + + + + +
    +

    + + SwiftLintCore 0.57.1 Docs + + (100% documented) +

    + +
    +
    + +
    +
    + +

    + + GitHub + View on GitHub + +

    + +

    + + Dash + Install in Dash + +

    +
    + + + +
    + +
    + +
    +
    +

    Kind

    +
    +
    + +
    public enum Kind
    + +
    +
    +

    The code block types to check.

    + + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + closure + +
      +
      +
      +
      +
      +
      +

      Closure code blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case closure
      + +
      +
      + +
      +
      +
    • +
    • +
      + + + + function + +
      +
      +
      +
      +
      +
      +

      Function body blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case function
      + +
      +
      + +
      +
      +
    • +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Type (class, enum, …) member blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case type
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + + diff --git a/Structs/Configuration.html b/Classes/CodeBlockVisitor.html similarity index 58% rename from Structs/Configuration.html rename to Classes/CodeBlockVisitor.html index dd3ed3da3..a6b66c40f 100644 --- a/Structs/Configuration.html +++ b/Classes/CodeBlockVisitor.html @@ -1,7 +1,7 @@ - Configuration Structure Reference + CodeBlockVisitor Class Reference @@ -14,9 +14,9 @@ - + - +

    @@ -50,9 +50,9 @@

    @@ -69,21 +69,24 @@ - -
    -
  • - - -
    -
    - - -
    - -

    Hashable -

    -
    -
    -
      -
    • -
      - - - - hash(into:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func hash(into hasher: inout Hasher)
      - -
      -
      - -
      -
      -
    • -
    • -
      - - - - ==(_:_:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func == (lhs: Configuration, rhs: Configuration) -> Bool
      - -
      -
      - -
      -
      -
    • -
    -
    -
    -
    - - -
    - -

    CustomStringConvertible -

    -
    -
    -
    diff --git a/Classes/LinterCache.html b/Classes/LinterCache.html deleted file mode 100644 index a8178ee24..000000000 --- a/Classes/LinterCache.html +++ /dev/null @@ -1,499 +0,0 @@ - - - - LinterCache Class Reference - - - - - - - - - - - - - - - - -
    -

    - - SwiftLintCore 0.57.1 Docs - - (100% documented) -

    - -
    -
    - -
    -
    - -

    - - GitHub - View on GitHub - -

    - -

    - - Dash - Install in Dash - -

    -
    - - - -
    - -
    - -
    -
    -

    LinterCache

    -
    -
    - -
    public final class LinterCache
    - -
    -
    -

    A persisted cache for storing and retrieving linter results.

    - - -
    -
    - -
    -
    -
    -
      -
    • - -
      -
      -
      -
      -
      -

      Creates a LinterCache by specifying a SwiftLint configuration and a file manager.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public init(configuration: Configuration, fileManager: some LintableFileManager = FileManager.default)
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - -
      - - configuration - - -
      -

      The SwiftLint configuration for which this cache will be used.

      -
      -
      - - fileManager - - -
      -

      The file manager to use to read lintable file information.

      -
      -
      -
      - -
      -
      -
    • -
    • -
      - - - - save() - -
      -
      -
      -
      -
      -
      -

      Persists the cache to disk.

      -
      -

      Throws

      - Throws if the linter cache doesn’t have a location value, if the cache couldn’t be serialized, or if - the contents couldn’t be written to disk. - -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func save() throws
      - -
      -
      - -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/Classes/RuleRegistry.html b/Classes/RuleRegistry.html index 2551f402a..3f37677bb 100644 --- a/Classes/RuleRegistry.html +++ b/Classes/RuleRegistry.html @@ -69,21 +69,24 @@ - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  • -
    - - - - Reporter - -
    -
    -
    -
    -
    -
    -

    An interface for reporting violations as strings.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol Reporter : CustomStringConvertible
    - -
    -
    - -
    -
    -
  • diff --git a/Protocols/ASTRule.html b/Protocols/ASTRule.html index 9684e9c16..dc2312568 100644 --- a/Protocols/ASTRule.html +++ b/Protocols/ASTRule.html @@ -69,21 +69,24 @@
  • - - - - - - - - - - -
  • -
    - - - - Configuration - -
    -
    -
    -
    -
    -
    -

    The configuration struct for SwiftLint. User-defined in the .swiftlint.yml file, drives the behavior of SwiftLint.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Configuration
    -
    extension Configuration: Hashable
    -
    extension Configuration: CustomStringConvertible
    - -
    -
    - -
    -
    -
  • @@ -631,70 +527,6 @@ non-triggering style

  • -
  • -
    - - - - Linter - -
    -
    -
    -
    -
    -
    -

    Represents a file that can be linted for style violations and corrections after being collected.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Linter
    - -
    -
    - -
    -
    -
  • -
  • -
    - - - - CollectedLinter - -
    -
    -
    -
    -
    -
    -

    Represents a file that can compute style violations and corrections for a list of rules.

    - -

    A CollectedLinter is only created after a Linter has run its collection steps in Linter.collect(into:).

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct CollectedLinter
    - -
    -
    - -
    -
    -
  • @@ -1111,7 +943,7 @@ foo: warning: 1
    @@ -1209,81 +1041,6 @@ foo: warning: 1
  • -
  • -
    - - - - Version - -
    -
    -
    -
    -
    -
    -

    A type describing the SwiftLint version.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Version : VersionComparable
    - -
    -
    - -
    -
    -
  • - - -
    -
    - - -
    - -

    YamlParser -

    -
    -
    -
    @@ -592,7 +552,7 @@ @@ -681,7 +641,7 @@ @@ -730,7 +690,7 @@ @@ -779,7 +739,7 @@ @@ -808,7 +768,7 @@ diff --git a/Structs/SwiftLintSyntaxMap.html b/Structs/SwiftLintSyntaxMap.html index 6afc9869f..514994d5d 100644 --- a/Structs/SwiftLintSyntaxMap.html +++ b/Structs/SwiftLintSyntaxMap.html @@ -69,21 +69,24 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
  • +
    + + + + BodyLengthRuleVisitor + +
    +
    +
    +
    +
    +
    +

    Visitor that collection violations of code block lengths.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public final class BodyLengthRuleVisitor<Parent> : ViolationsSyntaxVisitor<SeverityLevelsConfiguration<Parent>> where Parent : Rule
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + CodeBlockVisitor + +
    +
    +
    +
    +
    +
    +

    A visitor that collects style violations for all available code blocks.

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    open class CodeBlockVisitor<Configuration> : ViolationsSyntaxVisitor<Configuration> where Configuration : RuleConfiguration
    + +
    +
    + +
    +
    +
  • @@ -615,8 +575,8 @@ AST nodes (e.g. a code block in a code block).

    Declaration

    Swift

    -
    open class DeclaredIdentifiersTrackingVisitor<Configuration: RuleConfiguration>:
    -        ViolationsSyntaxVisitor<Configuration>
    +
    open class DeclaredIdentifiersTrackingVisitor<Configuration: RuleConfiguration>:
    +        ViolationsSyntaxVisitor<Configuration>
    @@ -647,7 +607,7 @@ AST nodes (e.g. a code block in a code block).

    Declaration

    Swift

    -
    open class ViolationsSyntaxVisitor<Configuration> : SyntaxVisitor where Configuration : RuleConfiguration
    +
    open class ViolationsSyntaxVisitor<Configuration> : SyntaxVisitor where Configuration : RuleConfiguration
    diff --git a/Structs/CollectedLinter.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor.html similarity index 64% rename from Structs/CollectedLinter.html rename to docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor.html index cbaee620f..16c8b5639 100644 --- a/Structs/CollectedLinter.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor.html @@ -1,7 +1,7 @@ - CollectedLinter Structure Reference + BodyLengthRuleVisitor Class Reference @@ -14,9 +14,9 @@ - + - +

    @@ -50,9 +50,9 @@

    @@ -69,21 +69,24 @@ - -
  • - - - file + + + Kind
    @@ -402,19 +360,20 @@
    -

    The file to lint with this linter.

    +

    The code block types to check.

    + See more

    Declaration

    Swift

    -
    public let file: SwiftLintFile
    +
    public enum Kind
    @@ -422,9 +381,9 @@
  • @@ -432,14 +391,14 @@
    -

    Computes or retrieves style violations.

    +

    Initializer.

    Declaration

    Swift

    -
    public func styleViolations(using storage: RuleStorage) -> [StyleViolation]
    +
    public init(kind: Kind, file: SwiftLintFile, configuration: SeverityLevelsConfiguration<Parent>)
    @@ -450,24 +409,44 @@ - storage + kind
    -

    The storage object containing all collected info.

    +

    The code block type to check. See Kind.

    +
    + + + + + + file + + + +
    +

    The file to collect violation for.

    +
    + + + + + + configuration + + + +
    +

    The configuration that defines the acceptable limits.

    -
    -

    Return Value

    -

    All style violations found by this linter.

    -
  • @@ -475,9 +454,9 @@
  • @@ -485,43 +464,18 @@
    -

    Computes or retrieves style violations and the time spent executing each rule.

    - +

    Declaration

    Swift

    -
    public func styleViolationsAndRuleTimes(using storage: RuleStorage)
    -    -> ([StyleViolation], [(id: String, time: Double)])
    +
    override public func visitPost(_ node: EnumDeclSyntax)
    -
    -

    Parameters

    - - - - - - - -
    - - storage - - -
    -

    The storage object containing all collected info.

    -
    -
    -
    -
    -

    Return Value

    -

    All style violations found by this linter, and the time spent executing each rule.

    -
    @@ -529,9 +483,9 @@
  • @@ -539,42 +493,18 @@
    -

    Applies corrections for all rules to this file, returning performed corrections.

    - +

    Declaration

    Swift

    -
    public func correct(using storage: RuleStorage) -> [Correction]
    +
    override public func visitPost(_ node: ClassDeclSyntax)
    -
    -

    Parameters

    - - - - - - - -
    - - storage - - -
    -

    The storage object containing all collected info.

    -
    -
    -
    -
    -

    Return Value

    -

    All corrections that were applied.

    -
    @@ -582,9 +512,9 @@
  • @@ -592,50 +522,134 @@
    -

    Formats the file associated with this linter.

    - +

    Declaration

    Swift

    -
    public func format(useTabs: Bool, indentWidth: Int)
    +
    override public func visitPost(_ node: StructDeclSyntax)
    -
    -

    Parameters

    - - - - - - - - - - - -
    - - useTabs - - -
    -

    Should the file be formatted using tabs?

    -
    -
    - - indentWidth - - -
    -

    How many spaces should be used per indentation level.

    -
    -
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: ActorDeclSyntax)
    + +
    +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: ClosureExprSyntax)
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: FunctionDeclSyntax)
    + +
    +
    + +
    +
    +
  • +
  • +
    + + + + visitPost(_:) + +
    +
    +
    +
    +
    +
    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    override public func visitPost(_ node: InitializerDeclSyntax)
    + +
    +
    +
    diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor/Kind.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor/Kind.html new file mode 100644 index 000000000..993e5506d --- /dev/null +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/BodyLengthRuleVisitor/Kind.html @@ -0,0 +1,454 @@ + + + + Kind Enumeration Reference + + + + + + + + + + + + + + + + +
    +

    + + SwiftLintCore 0.57.1 Docs + + (100% documented) +

    + +
    +
    + +
    +
    + +

    + + GitHub + View on GitHub + +

    + +

    + + Dash + Install in Dash + +

    +
    + + + +
    + +
    + +
    +
    +

    Kind

    +
    +
    + +
    public enum Kind
    + +
    +
    +

    The code block types to check.

    + + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + closure + +
      +
      +
      +
      +
      +
      +

      Closure code blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case closure
      + +
      +
      + +
      +
      +
    • +
    • +
      + + + + function + +
      +
      +
      +
      +
      +
      +

      Function body blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case function
      + +
      +
      + +
      +
      +
    • +
    • +
      + + + + type + +
      +
      +
      +
      +
      +
      +

      Type (class, enum, …) member blocks.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      case type
      + +
      +
      + +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + + diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CodeBlockVisitor.html similarity index 58% rename from docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html rename to docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CodeBlockVisitor.html index dd3ed3da3..a6b66c40f 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/Configuration.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/CodeBlockVisitor.html @@ -1,7 +1,7 @@ - Configuration Structure Reference + CodeBlockVisitor Class Reference @@ -14,9 +14,9 @@ - + - +

    @@ -50,9 +50,9 @@

    @@ -69,21 +69,24 @@ - -
    -
  • - - -
    -
    - - -
    - -

    Hashable -

    -
    -
    -
      -
    • -
      - - - - hash(into:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func hash(into hasher: inout Hasher)
      - -
      -
      - -
      -
      -
    • -
    • -
      - - - - ==(_:_:) - -
      -
      -
      -
      -
      -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public static func == (lhs: Configuration, rhs: Configuration) -> Bool
      - -
      -
      - -
      -
      -
    • -
    -
    -
    -
    - - -
    - -

    CustomStringConvertible -

    -
    -
    -
    diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html deleted file mode 100644 index a8178ee24..000000000 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/LinterCache.html +++ /dev/null @@ -1,499 +0,0 @@ - - - - LinterCache Class Reference - - - - - - - - - - - - - - - - -
    -

    - - SwiftLintCore 0.57.1 Docs - - (100% documented) -

    - -
    -
    - -
    -
    - -

    - - GitHub - View on GitHub - -

    - -

    - - Dash - Install in Dash - -

    -
    - - - -
    - -
    - -
    -
    -

    LinterCache

    -
    -
    - -
    public final class LinterCache
    - -
    -
    -

    A persisted cache for storing and retrieving linter results.

    - - -
    -
    - -
    -
    -
    -
      -
    • - -
      -
      -
      -
      -
      -

      Creates a LinterCache by specifying a SwiftLint configuration and a file manager.

      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public init(configuration: Configuration, fileManager: some LintableFileManager = FileManager.default)
      - -
      -
      -
      -

      Parameters

      - - - - - - - - - - - -
      - - configuration - - -
      -

      The SwiftLint configuration for which this cache will be used.

      -
      -
      - - fileManager - - -
      -

      The file manager to use to read lintable file information.

      -
      -
      -
      - -
      -
      -
    • -
    • -
      - - - - save() - -
      -
      -
      -
      -
      -
      -

      Persists the cache to disk.

      -
      -

      Throws

      - Throws if the linter cache doesn’t have a location value, if the cache couldn’t be serialized, or if - the contents couldn’t be written to disk. - -
      - -
      -
      -

      Declaration

      -
      -

      Swift

      -
      public func save() throws
      - -
      -
      - -
      -
      -
    • -
    -
    -
    -
    - -
    -
    - - - diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html index 2551f402a..3f37677bb 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Classes/RuleRegistry.html @@ -69,21 +69,24 @@ - - - - - - - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  • -
    - - - - Reporter - -
    -
    -
    -
    -
    -
    -

    An interface for reporting violations as strings.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public protocol Reporter : CustomStringConvertible
    - -
    -
    - -
    -
    -
  • diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/ASTRule.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/ASTRule.html index 9684e9c16..dc2312568 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/ASTRule.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Protocols/ASTRule.html @@ -69,21 +69,24 @@
  • - - - - - - - - - - -
  • -
    - - - - Configuration - -
    -
    -
    -
    -
    -
    -

    The configuration struct for SwiftLint. User-defined in the .swiftlint.yml file, drives the behavior of SwiftLint.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Configuration
    -
    extension Configuration: Hashable
    -
    extension Configuration: CustomStringConvertible
    - -
    -
    - -
    -
    -
  • @@ -631,70 +527,6 @@ non-triggering style

  • -
  • -
    - - - - Linter - -
    -
    -
    -
    -
    -
    -

    Represents a file that can be linted for style violations and corrections after being collected.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Linter
    - -
    -
    - -
    -
    -
  • -
  • -
    - - - - CollectedLinter - -
    -
    -
    -
    -
    -
    -

    Represents a file that can compute style violations and corrections for a list of rules.

    - -

    A CollectedLinter is only created after a Linter has run its collection steps in Linter.collect(into:).

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct CollectedLinter
    - -
    -
    - -
    -
    -
  • @@ -1111,7 +943,7 @@ foo: warning: 1
    @@ -1209,81 +1041,6 @@ foo: warning: 1
  • -
  • -
    - - - - Version - -
    -
    -
    -
    -
    -
    -

    A type describing the SwiftLint version.

    - - See more -
    -
    -

    Declaration

    -
    -

    Swift

    -
    public struct Version : VersionComparable
    - -
    -
    - -
    -
    -
  • - - -
    -
    - - -
    - -

    YamlParser -

    -
    -
    -
    @@ -592,7 +552,7 @@ @@ -681,7 +641,7 @@ @@ -730,7 +690,7 @@ @@ -779,7 +739,7 @@ @@ -808,7 +768,7 @@ diff --git a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html index 6afc9869f..514994d5d 100644 --- a/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html +++ b/docsets/SwiftLintCore.docset/Contents/Resources/Documents/Structs/SwiftLintSyntaxMap.html @@ -69,21 +69,24 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -