Add Pre-commit to repo

Author: Brian Obot

.github/workflows/create_pull_requests.yml

@@ -0,0 +1,64 @@
+name: Quality Check & PR to Master
+
+on:
+  push:
+    branches:
+      - dev
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11' # You can change this to your preferred version
+          cache: 'pip'
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install pytest # Ensures pytest is available even if not in requirements.txt
+
+      # - name: Create .env file
+      #   run: |
+
+      # - name: Run Tests
+      #   run: |
+      #     mkdir logs
+      #     pytest -s
+
+  create_pull_request:
+      runs-on: ubuntu-latest
+      needs: test  # This creates the dependency link
+      if: github.actor == 'brianobot'
+      permissions:
+        contents: write
+        pull-requests: write
+      env:
+        GITHUB_TOKEN: ${{ secrets.MY_PERSONAL_TOKEN }}
+      steps:
+        - name: Checkout Code
+          uses: actions/checkout@v4
+
+        - name: Create Pull Request
+          run: |
+            # Check if a PR already exists from dev to master
+            PR_EXISTS=$(gh pr list --head dev --base master --state open --json number -q '.[0].number')
+
+            if [ -z "$PR_EXISTS" ]; then
+              echo "No open PR found. Creating a new one..."
+              gh pr create \
+                --head dev \
+                --base master \
+                --title "Auto-PR: Dev to Master" \
+                --body "Automated PR triggered by push from ${{ github.actor }}" \
+                --assignee "${{ github.actor }}"
+            else
+              echo "PR already exists: #$PR_EXISTS. Skipping creation."
+            fi

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: local
+    hooks:
+      - id: rustfmt
+        name: rustfmt
+        entry: cargo fmt --all -- --check
+        language: system
+        types: [rust]
+        pass_filenames: false
+  
+      - id: cargo-check
+        name: cargo-check
+        entry: cargo check
+        language: system
+        types: [rust]
+        pass_filenames: false
+  
+      - id: clippy
+        name: clippy
+        entry: cargo clippy -- -D warnings
+        language: system
+        types: [rust]
+        pass_filenames: false

src/bin/01_variables.rs

@@ -23,7 +23,7 @@ fn main() {
     // causes the compiler to produce an error message, so only use mut if you indeed need to mutate
     // the variable in question
     println!("The value of y is {y}");
-    y = y + 10;
+    y += 10;
     println!("The new value of y is {y}");
 
     // CONSTANTS are not allowed to be made mutable, they are always immutable
@@ -73,7 +73,7 @@ fn main() {
 
     timeout = 12.10;
 
-    timeout -= 1 as f32;
+    timeout -= 1f32;
 
     println!("Timeout = {timeout}");
 
@@ -134,7 +134,8 @@ fn main() {
     x += 10;
     println!("X = {x}");
 
-    let ass_val = x = 10;
+    #[allow(clippy::let_unit_value)]
+    let _ass_val = x = 10;
     println!("X = {}", x);
-    println!("Assigment value = {:?}", ass_val);
+    println!("Assigment value = {:?}", ());
 }

src/bin/02_data_types.rs

@@ -32,13 +32,13 @@ fn main() {
     // you can mix underscore and type suffix to better indicate the type of an integer
     //
     let _rating = 24_u8; // the underscore is ignore and only needed to make it easier to read
-    let _score = 25__u16;
+    let _score = 25_u16;
 
     let some_value = 123u16;
     println!("Some Value = {:?}", some_value);
 
     // floating point type
-    let _rating = 5__f32; // again the underscore is ignored
+    let _rating = 5_f32; // again the underscore is ignored
     let _average = 32f64;
 
     // the floating point type has associated constant to meet IEEE specs

src/bin/02b_literals.rs

@@ -1,3 +1,5 @@
+#![allow(clippy::nonminimal_bool)]
+
 fn main() {
     // integers 1
     // floats 1.23

src/bin/02e_vectors.rs

@@ -1,3 +1,5 @@
+#![allow(clippy::vec_init_then_push)]
+
 use std::vec;
 
 fn main() {
@@ -14,6 +16,7 @@ fn main() {
 
     // you can pop elements from the vector
     let last_value = data.pop();
+    #[allow(clippy::unnecessary_unwrap)]
     if last_value.is_some() {
         println!("Popped value: {}", last_value.unwrap());
     }
@@ -98,6 +101,7 @@ fn main() {
     // we can emulate the behaviour of storing different types in a vector
     // by storying an enum that can hold different types
 
+    #[allow(clippy::enum_variant_names)]
     #[derive(Debug)]
     enum FieldType {
         SmallIntegerField(i8),
@@ -119,13 +123,14 @@ fn main() {
         }
     }
 
+    #[allow(clippy::vec_init_then_push)]
     let mut columns: Vec<FieldType> = Vec::new();
 
     columns.push(FieldType::IntergerField(10));
     columns.push(FieldType::SmallIntegerField(10));
     columns.push(FieldType::BigIntergerField(10000000));
     columns.push(FieldType::StringField("Hello".to_string()));
-    columns.push(FieldType::FloatField(3.14));
+    columns.push(FieldType::FloatField(3.146565));
 
     println!("Columns = {:?}", columns);
 
@@ -145,6 +150,7 @@ fn main() {
     println!("Reversed data = {:?}", data);
 
     let mut names = vec!["John", "Doe", "Jane", "Doe", "Alice", "Bob"];
+    #[allow(clippy::unnecessary_sort_by)]
     names.sort_by(|a, b| a.len().cmp(&b.len()));
     println!("Sorted names = {:?}", names);
 
@@ -174,6 +180,7 @@ fn main() {
     );
 
     // an example to convert an vector of &str types to a vector String types
+    #[allow(clippy::useless_vec)]
     let names = vec!["james", "paul", "okon", "obot", "abasifreke"]
         .iter_mut()
         .map(|x| x.to_string())

src/bin/02g_expression.rs

@@ -50,6 +50,7 @@ fn main() {
     #[allow(dead_code)]
     fn show_files() -> std::io::Result<()> {
         #[allow(dead_code)]
+        #[allow(clippy::useless_vec)]
         let mut _v = vec![1, 2, 3];
 
         // perfectly valid rust code
@@ -89,7 +90,7 @@ fn main() {
         println!("Current Value = {start}");
         start += 1;
 
-        if start % 24 == 0 {
+        if start.is_multiple_of(24) {
             break start; // you can use break to return values from a loop in rust
         }
     };
@@ -117,10 +118,10 @@ fn main() {
                 break 'search;
             }
         }
-        println!("");
+        println!(" ");
         temp += 2;
     }
-    println!("");
+    println!(" ");
 
     // a break can have a label and a value but both are optional
     // break - empty break
@@ -170,7 +171,7 @@ fn partition<T: Ord>(slice: &mut [T]) -> usize {
 
     for j in 0..pivot_index {
         if slice[j] <= slice[pivot_index] {
-            i = i + 1isize;
+            i += 1isize;
             slice.swap(i as usize, j);
         }
     }

src/bin/03_functions.rs

@@ -61,5 +61,5 @@ fn with_return_value() -> u32 {
 }
 
 fn with_return_keyword() -> f64 {
-    return 64.0;
+    64.0
 }

src/bin/03b_more_on_functions.rs

@@ -30,6 +30,7 @@ fn main() {
     // the by value captures usually occurs for type that are non_copy
     // to force closure to capture a variable by value, use the keyword move before the pipes
 
+    #[allow(clippy::useless_vec)]
     let haystack = vec![1, 2, 3, 4];
     let contains = move |needle: i32| haystack.contains(&needle);
 
@@ -90,6 +91,7 @@ impl _Box {
 
     // &self is usually used in place of the full form self: &Self, where Self point to the type the function is
     // defined on, self gives access to the type fields via dot notation
+    #[allow(clippy::needless_arbitrary_self_type)]
     fn _area(self: &Self) -> u8 {
         self.width * self.heigth
     }

src/bin/03c_diverging_functions.rs

@@ -1,4 +1,5 @@
 #![allow(unreachable_code)]
+#![allow(clippy::diverging_sub_expression)]
 
 fn main() {
     // diverging functions are functions that never return,