pre-commit: SwiftLint: Disable failing tests #781

Author: JeneaVranceanu

.codespellrc

@@ -0,0 +1,4 @@
+[codespell]
+count = True
+ignore-words-list = ans,deriver,inout,packag
+skip = *.js,*WordLists.swift,.git,Carthage,.build,build

.github/workflows/macOS-tests.yml

@@ -29,7 +29,7 @@ jobs:
   spm:
     name: Swift Package Manager 5.7
     runs-on: macOS-12
-    concurrency: 
+    concurrency:
       group: spm-${{ github.run_id }}
       cancel-in-progress: false
     steps:
@@ -38,7 +38,11 @@ jobs:
         run: |
           pip3 install --upgrade pip
           pip3 install codespell
-          codespell --count --ignore-words-list=ans,deriver,inout,packag --skip="*.js,*WordLists.swift"
+          codespell  # See .codespellrc for args
+      - name: SwiftLint
+        run: |
+          # Adding --fix flag makes CI print only errors that cannot be fixed automatically
+          swiftlint --fix
       - name: Resolve dependencies
         run: swift package resolve
       - name: Build

.github/workflows/pre-commit.yml

@@ -0,0 +1,22 @@
+# https://pre-commit.com
+# This GitHub Action assumes that the repo contains a valid .pre-commit-config.yaml file.
+# Using pre-commit.ci is even better than using GitHub Actions for pre-commit.
+name: pre-commit
+on:
+  pull_request:
+    branches: [develop]
+  push:
+    branches: [develop]
+  workflow_dispatch:
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: pip install pre-commit
+      - run: pre-commit --version
+      - run: pre-commit install
+      - run: pre-commit run --all-files

.pre-commit-config.yaml

@@ -14,12 +14,9 @@ repos:
 -   repo: https://github.com/codespell-project/codespell
     rev: v2.2.2
     hooks:
-    -   id: codespell
-        args: ["--count --ignore-words-list=ans,deriver,inout,packag --skip=\"*.js,*WordLists.swift,.git,Carthage,.build,build\""]
-# SwiftLint is commented out until we fix all SwiftLint warnings and errors.
-# https://github.com/web3swift-team/web3swift/pull/756
-#-   repo: https://github.com/realm/SwiftLint
-#    rev: 0.50.3
-#    hooks:
-#    -   id: swiftlint
-#        args: [--fix, Sources, Tests]
+    -   id: codespell  # See .codespellrc for args
+# -   repo: https://github.com/realm/SwiftLint  # Too slow in pre-commit
+#     rev: 0.50.3
+#     hooks:
+#     -   id: swiftlint
+#         args: [--fix, Sources, Tests]

.swiftlint.yml

@@ -5,14 +5,45 @@ excluded:
   - DerivedData
   - Pods
 
+analyzer_rules:
+  - unused_import
+
 disabled_rules:
+  - block_based_kvo
+  - closure_body_length
+  - computed_accessors_order
+  - cyclomatic_complexity
+  - duplicate_imports
+  - empty_enum_arguments
+  - empty_string
+  - file_length
+  - for_where
+  - force_cast
+  - force_try
+  - force_unwrapping
+  - function_body_length
   - function_parameter_count
   - identifier_name
+  - implicit_getter
+  - implicitly_unwrapped_optional
+  - indentation_width
+  - large_tuple
+  - legacy_objc_type
   - line_length
   - multiple_closures_with_trailing_closure
   - nesting
+  - orphaned_doc_comment
+  - operator_whitespace
+  - return_arrow_whitespace
+  - shorthand_operator
   - todo
+  - trailing_closure
+  - type_body_length
   - type_name
+  - unneeded_break_in_switch
+  - unused_optional_binding
+  - vertical_parameter_alignment
+  - xctfail_message
 
 opt_in_rules:
   - closure_body_length
@@ -27,15 +58,14 @@ opt_in_rules:
   - static_operator
   - trailing_closure
   - unneeded_parentheses_in_closure_argument
-  - unused_import
   - weak_delegate
 
 # force warnings
 force_cast: error
-force_try: error 
+force_try: error
 
 custom_rules:
-  commented_out_code: 
+  commented_out_code:
     included: .*\.swift # regex that defines paths to include during linting. optional.
     excluded: .*Test(s)?\.swift # regex that defines paths to exclude during linting. optional
     name: Commented out code # rule name. optional.

CONTRIBUTION.md

@@ -17,7 +17,7 @@ Please take it from the [roadmap](https://hackmd.io/G5znP3xAQY-BVc1X8Y1jSg) or f
 
 ## Codestyle guideline
 - `swiftlint` check should goes with no warnings.
-- Here’s some more detailed and human readable code style [guidelines](https://hackmd.io/8bACoAnTSsKc55Os596yCg "") (you can add there some suggestion if you’d like to). 
+- Here’s some more detailed and human readable code style [guidelines](https://hackmd.io/8bACoAnTSsKc55Os596yCg "") (you can add there some suggestion if you’d like to).
 - We use [swift](https://www.swift.org/documentation/api-design-guidelines/ "") name convention.
 ## Tests guideline
 1. Cover each new public method with tests.
@@ -67,4 +67,4 @@ on:
 - [ ] All public method have `///` styled comments.
 - [ ] All magic or nonintuitive internal code parts are clearly explained in inline comments.
 - [ ] `swiftlint` ran have no warnings.
-- [ ] No commented out code lefts in PR.
+- [ ] No commented out code lefts in PR.

README.md

@@ -44,13 +44,13 @@
 
 ## Core features
 
-- [x] :zap: Swift implementation of [web3.js](https://github.com/ethereum/web3.js/) functionality 
-- [x] :thought_balloon: Interaction with remote node via **JSON RPC** 
+- [x] :zap: Swift implementation of [web3.js](https://github.com/ethereum/web3.js/) functionality
+- [x] :thought_balloon: Interaction with remote node via **JSON RPC**
 - [x] 🔐 Local **keystore management** (`geth` compatible)
-- [x] 🤖 Smart-contract **ABI parsing** 
+- [x] 🤖 Smart-contract **ABI parsing**
 - [x] 🔓**ABI decoding** (V2 is supported with return of structures from public functions. Part of 0.4.22 Solidity compiler)
 - [x] 🕸Ethereum Name Service **(ENS) support** - a secure & decentralised way to address resources both on and off the blockchain using simple, human-readable names
-- [x] :arrows_counterclockwise: **Smart contracts interactions** (read/write) 
+- [x] :arrows_counterclockwise: **Smart contracts interactions** (read/write)
 - [x]  ⛩ **Infura support**
 - [x] ⚒  **Parsing TxPool** content into native values (ethereum addresses and transactions) - easy to get pending transactions
 - [x] 🖇 **Event loops** functionality

Sources/Web3Core/EthereumNetwork/Request/APIRequest+ComputedProperties.swift

@@ -1,6 +1,6 @@
 //
 //  APIRequest+ComputedProperties.swift
-//  
+//
 //
 //  Created by Yaroslav Yashin on 12.07.2022.
 //

Sources/Web3Core/EthereumNetwork/Request/APIRequest+Methods.swift

@@ -1,6 +1,6 @@
 //
 //  APIRequest+Methods.swift
-//  
+//
 //
 //  Created by Yaroslav Yashin on 12.07.2022.
 //

Sources/Web3Core/EthereumNetwork/Request/APIRequest+UtilityTypes.swift

@@ -1,6 +1,6 @@
 //
 //  APIRequest+UtilityTypes.swift
-//  
+//
 //
 //  Created by Yaroslav Yashin on 12.07.2022.
 //