Merge pull request #30 from othyn/dev

v1.3.0

.github/workflows/swiftlint.yml

@@ -0,0 +1,35 @@
+name: Lint
+
+on:
+  push:
+    branches: [ main, dev ]
+    paths:
+      - '.github/workflows/swiftlint.yml'
+      - '.swiftlint.yml'
+      - 'auto-clicker/**/*.swift'
+  pull_request:
+    branches: [ main, dev ]
+    paths:
+      - '.github/workflows/swiftlint.yml'
+      - '.swiftlint.yml'
+      - 'auto-clicker/**/*.swift'
+
+jobs:
+  lint:
+    name: Ensure project code standards are adhered to
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      # - name: SwiftLint
+      #   uses: norio-nomura/action-swiftlint@3.2.1
+      # Okay this (strict mode) does work and I do prefer it, as it will fail the run if the code is not validating
+      #  ~all~ rules, even warnings. I prefer this behaviour, as its more obvious something is wrong. In order to
+      #  see what is wrong, under the PR go to the 'Files changed' tab, then scroll right to the bottom in which there
+      #  is a sub-heading 'Unchanged files with check annotations (Beta)' in which I really wish these annotations were
+      #  placed onto the main PR page.
+      - name: SwiftLint (Strict)
+        uses: norio-nomura/action-swiftlint@3.2.1
+        with:
+          args: --strict

.github/workflows/xcode.yml

@@ -0,0 +1,37 @@
+name: Build
+
+on:
+  push:
+    branches: [ main, dev ]
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  build:
+    name: Build and analyse with Xcode
+    runs-on: macos-12
+
+    strategy:
+      matrix:
+        xcode:
+          - ^13.3
+        # swift:
+        #   - ~5.6 # Xcode 13.3
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Check Working Directory
+        run: |
+          pwd
+          ls -lah
+      - name: Build
+        uses: mxcl/xcodebuild@v1
+        with:
+          platform: macOS
+          xcode: ${{ matrix.xcode }}
+          # swift: ${{ matrix.swift }} # selects the newest Xcode version that provides the requested Swift version
+          action: build # change to test when tests are written
+          # code-coverage: true
+          # warnings-as-errors: true
+          # configuration: release

.gitignore

@@ -1,5 +1,9 @@
 ## Remove new local build directory
-auto-clicker/derived_data
+derived_data
+
+# Remove build log files
+dist/logs/*
+!dist/logs/.gitkeep
 
 # Xcode
 #

.swiftlint.yml

@@ -0,0 +1,171 @@
+included:
+  - auto-clicker
+only_rules:
+  - anyobject_protocol
+  - array_init
+  - block_based_kvo
+  - class_delegate_protocol
+  - closing_brace
+  - closure_end_indentation
+  - closure_parameter_position
+  - closure_spacing
+  - collection_alignment
+  - colon
+  - comma
+  - compiler_protocol_init
+  - computed_accessors_order
+  - conditional_returns_on_newline
+  - contains_over_filter_count
+  - contains_over_filter_is_empty
+  - contains_over_first_not_nil
+  - contains_over_range_nil_comparison
+  - control_statement
+  - custom_rules
+  - deployment_target
+  - discarded_notification_center_observer
+  - discouraged_assert
+  - discouraged_direct_init
+  - discouraged_object_literal
+  - discouraged_optional_boolean
+  - discouraged_optional_collection
+  - duplicate_enum_cases
+  - duplicate_imports
+  - dynamic_inline
+  - empty_collection_literal
+  - empty_count
+  - empty_enum_arguments
+  - empty_parameters
+  - empty_parentheses_with_trailing_closure
+  - empty_string
+  - empty_xctest_method
+  - enum_case_associated_values_count
+  - explicit_init
+  - fallthrough
+  - fatal_error_message
+  - first_where
+  - flatmap_over_map_reduce
+  - for_where
+  - generic_type_name
+  - ibinspectable_in_extension
+  - identical_operands
+  - identifier_name
+  - implicit_getter
+  - implicit_return
+  - inclusive_language
+  - inert_defer
+  - is_disjoint
+  - joined_default_parameter
+  - last_where
+  - leading_whitespace
+  - legacy_cggeometry_functions
+  - legacy_constant
+  - legacy_constructor
+  - legacy_hashing
+  - legacy_multiple
+  - 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
+  - nimble_operator
+  - no_extension_access_modifier
+  - no_fallthrough_only
+  - no_space_in_method_call
+  - notification_center_detachment
+  - nsobject_prefer_isequal
+  - number_separator
+  - opening_brace
+  - operator_usage_whitespace
+  - operator_whitespace
+  - orphaned_doc_comment
+  - overridden_super_call
+  - prefer_self_type_over_type_of_self
+  - prefer_zero_over_explicit_init
+  - private_action
+  - private_outlet
+  - private_subject
+  - private_unit_test
+  - prohibited_super_call
+  - protocol_property_accessors_order
+  - reduce_boolean
+  - reduce_into
+  - 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
+  - test_case_accessibility
+  - toggle_bool
+  - trailing_comma
+  - trailing_newline
+  - trailing_semicolon
+  - trailing_whitespace
+  - unavailable_function
+  - unneeded_break_in_switch
+  - unneeded_parentheses_in_closure_argument
+  - unowned_variable_capture
+  - untyped_error_in_catch
+  - unused_capture_list
+  - 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
+  - xct_specific_matcher
+  - xctfail_message
+  - yoda_condition
+analyzer_rules:
+  - capture_variable
+  - unused_declaration
+  - unused_import
+number_separator:
+  minimum_length: 3
+identifier_name:
+  max_length:
+    warning: 100
+    error: 100
+  min_length:
+    warning: 2
+    error: 2
+  validates_start_with_lowercase: false
+deployment_target:
+  macOS_deployment_target: '11.0'
+custom_rules:
+  swiftui_state_private:
+    regex: '@(State|StateObject|ObservedObject|EnvironmentObject)\s+var'
+    message: "SwiftUI @State/@StateObject/@ObservedObject/@EnvironmentObject properties should be private"
+  swiftui_environment_private:
+    regex: '@Environment\(\\\.\w+\)\s+var'
+    message: "SwiftUI @Environment properties should be private"
+  swiftui_default_private:
+    regex: '@Default\(\.\w+\)\s+var'
+    message: "SwiftUI @Default properties should be private"
+  final_class:
+    regex: '^class [a-zA-Z\d]+[^{]+\{'
+    message: "Classes should be marked as final whenever possible. If you actually need it to be subclassable, just add `// swiftlint:disable:next final_class`."