Skip to content

Commit

Permalink
Lint
Browse files Browse the repository at this point in the history
  • Loading branch information
eonist committed Nov 6, 2024
1 parent 33e24f3 commit 8455ef0
Show file tree
Hide file tree
Showing 20 changed files with 193 additions and 40 deletions.
159 changes: 159 additions & 0 deletions .swiftlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
only_rules:
# - force_unwrapping
# - force_cast
# - weak_computed_property
# - unused_private_declaration
- anyobject_protocol
- array_init
#- attributes
- block_based_kvo
- class_delegate_protocol
- closing_brace
- closure_end_indentation
- closure_parameter_position
- closure_spacing
- collection_alignment
- colon
- comma
- compiler_protocol_init
# - conditional_returns_on_newline
- contains_over_first_not_nil
- control_statement
- deployment_target
- discarded_notification_center_observer
- discouraged_direct_init
- discouraged_object_literal
- discouraged_optional_boolean
# - discouraged_optional_collection
- duplicate_imports
- dynamic_inline
- empty_count
- empty_enum_arguments
- empty_parameters
- empty_parentheses_with_trailing_closure
- empty_string
- empty_xctest_method
- explicit_init
- fallthrough
- fatal_error_message
- first_where
- for_where
- generic_type_name
- identical_operands
- identifier_name
- implicit_getter
- implicit_return
- inert_defer
- is_disjoint
- joined_default_parameter
- last_where
- leading_whitespace
- legacy_cggeometry_functions
- legacy_constant
- legacy_constructor
- legacy_hashing
- legacy_nsgeometry_functions
- legacy_random
- literal_expression_end_indentation
- lower_acl_than_parent
- mark
- modifier_order
# - multiline_arguments
# - multiline_function_chains
- multiline_literal_brackets
- multiline_parameters
- multiline_parameters_brackets
- multiple_closures_with_trailing_closure
- nimble_operator
- no_extension_access_modifier
- no_fallthrough_only
- notification_center_detachment
- number_separator
- object_literal
- opening_brace
- operator_usage_whitespace
- operator_whitespace
- overridden_super_call
- pattern_matching_keywords
- private_action
# - private_outlet
- private_unit_test
- prohibited_super_call
- protocol_property_accessors_order
- redundant_discardable_let
- redundant_nil_coalescing
- redundant_objc_attribute
- redundant_optional_initialization
- redundant_set_access_control
- redundant_string_enum_value
- redundant_type_annotation
- redundant_void_return
- required_enum_case
- return_arrow_whitespace
- shorthand_operator
- sorted_first_last
# - statement_position
- static_operator
# - strong_iboutlet
- superfluous_disable_command
- switch_case_alignment
# - switch_case_on_newline
- syntactic_sugar
- todo
- toggle_bool
- trailing_closure
- trailing_comma
- trailing_newline
- trailing_semicolon
- trailing_whitespace
#- type_name
# - unavailable_function
- unneeded_break_in_switch
- unneeded_parentheses_in_closure_argument
#- untyped_error_in_catch
- unused_closure_parameter
- unused_control_flow_label
- unused_enumerated
- unused_optional_binding
- unused_setter_value
- valid_ibinspectable
- vertical_parameter_alignment
- vertical_parameter_alignment_on_call
- vertical_whitespace_closing_braces
- vertical_whitespace_opening_braces
- void_return
- weak_delegate
- xct_specific_matcher
- xctfail_message
- yoda_condition
analyzer_rules:
- unused_import
number_separator:
minimum_length: 5
object_literal:
image_literal: false
discouraged_object_literal:
color_literal: false
identifier_name:
max_length:
warning: 100
error: 100
min_length:
warning: 0
error: 0
validates_start_with_lowercase: false
allowed_symbols:
- '_'
excluded:
- 'x'
- 'y'
- 'a'
- 'b'
- 'x1'
- 'x2'
- 'y1'
- 'y2'
# macOS_deployment_target: '10.12'
excluded: # paths to ignore during linting. Takes precedence over `included`.
- 'Packages/External/SwiftDraw'
- 'Packages/External'
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ extension ExampleView {
sizeClass: sizeClass,
splitConfig: splitConfig
)
.onChange(of: selectedSideBarIndex) { oldIndex, newIndex in // Responds to changes in the selected sidebar index to update dependent views or states.
.onChange(of: selectedSideBarIndex) { _, _ in // Responds to changes in the selected sidebar index to update dependent views or states.
handleSideBarChange(splitConfig, sizeClass)
} // Forward state change to handleSideBarChange
}
Expand All @@ -82,7 +82,7 @@ extension ExampleView {
title: DataModel.dataModel[selectedSideBarIndex].title,
selectedMainIndex: $selectedMainIndex,
items: items,
selectedItem: $selectedMainItem,
selectedItem: $selectedMainItem,
splitConfig: splitConfig,
sizeClass: sizeClass
)
Expand Down
1 change: 0 additions & 1 deletion ExampleProject/ExampleProject/example/ExampleView.swift
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,3 @@ struct ExampleView: View {
self.selectedMainItem = selectedMainItem
}
}

Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ extension DataModel {
* Accounts
* - Description: Represents the "Accounts" section in the sidebar, containing individual account information.
*/
static fileprivate let accounts: SideBarModel = {
fileprivate static let accounts: SideBarModel = {
SideBarModel(title: "Accounts", content: [ // sidebar-item
MainModel(
title: "Account one", // main-item
Expand All @@ -82,7 +82,7 @@ extension DataModel {
* Settings
* - Description: Represents the "Settings" section in the sidebar, containing settings information.
*/
static fileprivate let settings: SideBarModel = {
fileprivate static let settings: SideBarModel = {
SideBarModel(title: "Settings", content: [
MainModel(
title: "Setting 1",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,9 @@ extension Button {
#Preview {
Button(action: {
Swift.print("press")
}) {}
}) {
}
.iconButtonStyle(iconName: "arrow.left.and.right")
.padding()
.environment(\.colorScheme, .dark) // dark-mode
}


Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ extension DetailHeader {
* - Description: Displays the title of the detail view.
*/
var titleText: some View {
Text(title)
Text(title)
.titleTextStyle
.padding(.vertical, 6)
}
Expand All @@ -58,7 +58,8 @@ extension DetailHeader {
// This line toggles the visibility of columns based on whether the detail view is currently in full-screen mode.
// If in full-screen mode, it shows all columns; otherwise, it shows only the detail column.
splitConfig.columnVisibility = splitConfig.isDetailFullScreen ? .all : .detailOnly
}) {}
}) {
}
.iconButtonStyle(iconName: iconName)
.opacity(sizeClass == .regular ? 1.0 : 0.0) // We use opacity to not change the topbar height to be more narrow etc
// Animate opacity changes smoothly with .easeInOut(duration: 0.3) based on sidebar visibility.
Expand All @@ -76,7 +77,8 @@ extension DetailHeader {
var backButton: some View {
Button(action: {
dismiss() // This line triggers the environment's dismiss action, used to close the current view or navigate back in the navigation stack.
}) {}
}) {
}
.iconButtonStyle(iconName: "chevron.left")
// Only show if in compact mode
.opacity(sizeClass == .compact ? 1.0 : 0.0) // We use opacity to not change the topbar height to be more narrow etc
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ struct DetailList: View {
* Initializes a `DetailList` with the specified detail data.
* - Parameter detailData: The data to display in the list.
*/
public init(detailData: DetailData) {
init(detailData: DetailData) {
self.detailData = detailData
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ struct DetailView: View {
* navigating back in a navigation stack.
* - Note: It seems fine to keep this here
*/
#if os(iOS)
#if os(iOS)
@Environment(\.dismiss) var dismiss: DismissAction
#endif
/**
Expand Down Expand Up @@ -65,7 +65,7 @@ extension DetailView {
let detailView = DetailView(
title: mainModel.title,
detailData: mainModel.content,
splitConfig: splitConfig,
splitConfig: splitConfig,
sizeClass: sizeClass
)
return detailView
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,8 @@ extension MainHeader {
#else
splitConfig.columnVisibility = .all // Shows all 3 columns without animation for other platforms
#endif
}) {}
}) {
}
.iconButtonStyle(iconName: "square.righthalf.fill") // - Fixme: ⚠️️ describe what this icon looks like
.opacity(splitConfig.isShowingSideBar(sizeClass: sizeClass) ? 0.0 : 1.0) // Only show this if sidebar is hidden
// Animate opacity changes smoothly with .easeInOut(duration: 0.3) based on sidebar visibility.
Expand All @@ -78,7 +79,8 @@ extension MainHeader {
var backButton: some View {
Button(action: {
dismiss() // (⚠️️ API bug) this is how we consistantly can go back to sidebar in compact mode
}) {}
}) {
}
.iconButtonStyle(iconName: "chevron.left")
// Only show if in compact mode
.opacity(sizeClass == .compact ? 1.0 : 0.0) // We use opacity to not change the topbar height to be more narrow etc
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,3 @@ struct MainView: View {
*/
@Binding var sizeClass: UserInterfaceSizeClass?
}

Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ extension SideBarHeader {
#else
splitConfig.columnVisibility = .doubleColumn // Change without animation for other platforms
#endif
}) {}
}) {
}
if splitConfig.isShowingSideBar(sizeClass: sizeClass)/*sizeClass == .regular*/ { // If 3 column
button
.iconButtonStyle(iconName: "square.lefthalf.fill") // Applies an icon style with a half-filled square, indicating a partial collapse or expansion state.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ public struct SideBarView: View {
*/
var splitConfig: SplitConfig
}

1 change: 0 additions & 1 deletion Sources/SplitViewKit/SplitViewWrapper+Const.swift
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,3 @@ extension SplitViewWrapper {
*/
public typealias OverlayAlias = (_ splitConfig: SplitConfig, _ sizeClass: Binding<UserInterfaceSizeClass?>) -> OverlayView?
}

1 change: 0 additions & 1 deletion Sources/SplitViewKit/SplitViewWrapper+Content.swift
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,3 @@ extension SplitViewWrapper {
.navigationSplitViewStyle(.balanced)
}
}

2 changes: 1 addition & 1 deletion Sources/SplitViewKit/SplitViewWrapper.swift
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public struct SplitViewWrapper<SideBar: View, Content: View, Detail: View, Overl
public init(sideBar: @escaping SideBarAlias,
content: @escaping MainAlias,
detail: @escaping DetailAlias,
overlay: @escaping OverlayAlias = { _,_ in nil }, // - Fixme: ⚠️️ Move empty closure to default const?
overlay: @escaping OverlayAlias = { _, _ in nil }, // - Fixme: ⚠️️ Move empty closure to default const?
columnWidth: ColumnWidthKind = DefaultColumnWidth(),
splitConfig: SplitConfig = .init()) {
self.sideBar = sideBar
Expand Down
17 changes: 6 additions & 11 deletions Sources/SplitViewKit/ext/UIDeviceOrientation+Ext.swift
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ internal func getDeviceOrientation() -> UIDeviceOrientation {
if #available(iOS 15, *) {
interfaceOrientation = UIApplication.shared.connectedScenes
// Keep only the first `UIWindowScene`
.first(where: { $0 is UIWindowScene })
.first { $0 is UIWindowScene }
// Get its associated windows
.flatMap({ $0 as? UIWindowScene })?.interfaceOrientation
.flatMap { $0 as? UIWindowScene }?.interfaceOrientation
} else {
interfaceOrientation = UIApplication.shared.windows.first?.windowScene?.interfaceOrientation
}
Expand All @@ -51,19 +51,14 @@ internal func getDeviceOrientation() -> UIDeviceOrientation {
switch interfaceOrientation {
case .portrait:
orientation = .portrait
break
case .landscapeRight:
case .landscapeRight:
orientation = .landscapeLeft
break
case .landscapeLeft:
case .landscapeLeft:
orientation = .landscapeRight
break
case .portraitUpsideDown:
case .portraitUpsideDown:
orientation = .portraitUpsideDown
break
default:
default:
orientation = .unknown
break
}
}
return orientation
Expand Down
6 changes: 3 additions & 3 deletions Sources/SplitViewKit/modifier/DetailViewModifier.swift
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ struct DetailViewModifier: ViewModifier {
content
.navigationSplitViewColumnWidth( // Sets the width of the navigation split view column
min: columnWidth.min, // Sets the minimum width of the navigation split view column
ideal:columnWidth.ideal, // Sets the ideal width of the navigation split view column
ideal: columnWidth.ideal, // Sets the ideal width of the navigation split view column
max: columnWidth.max // Sets the maximum width of the navigation split view column
)
)
} else {
content // If there is no columnwidth, we use native default column widths etc
}
Expand All @@ -46,7 +46,7 @@ extension View {
* - columnWidth: An instance conforming to the `ColumnWidthKind` protocol, which provides custom width settings for the detail column based on the window width.
* - Returns: A View with the detail view modifier applied.
*/
internal func detailViewModifier(winWidth: CGFloat, columnWidth: ColumnWidthKind) -> some View{
internal func detailViewModifier(winWidth: CGFloat, columnWidth: ColumnWidthKind) -> some View {
let modifier = DetailViewModifier(
winWidth: winWidth,
columnWidth: columnWidth
Expand Down
4 changes: 2 additions & 2 deletions Sources/SplitViewKit/modifier/MainViewModifier.swift
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ fileprivate struct MainViewModifier: ViewModifier {
content
.navigationSplitViewColumnWidth( // Sets the width of the navigation split view column
min: columnWidth.min, // Sets the minimum width of the navigation split view column
ideal:columnWidth.ideal, // Sets the ideal width of the navigation split view column
ideal: columnWidth.ideal, // Sets the ideal width of the navigation split view column
max: columnWidth.max // Sets the maximum width of the navigation split view column
)
)
} else {
content // If there is no columnWidth, we use native default column widths etc
}
Expand Down
Loading

0 comments on commit 8455ef0

Please sign in to comment.