set up repo github actions (precommit and dependabot) as well as pre-…

…commit

.dictionary.txt

@@ -0,0 +1 @@
+crate

.github/dependabot.yaml

@@ -0,0 +1,27 @@
+---
+version: 2
+
+updates:
+  # Maintain dependencies for Docker
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: weekly
+    assignees:
+      - "fredclausen"
+
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: weekly
+    assignees:
+      - "fredclausen"
+
+  # Maintain pip packages for acars_router
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: weekly
+    assignees:
+      - "fredclausen"

.github/workflows/pr-validator.yml

@@ -7,15 +7,14 @@ on:
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v1
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
-          
+
       - name: Format check
         run: cargo fmt  -- --check
       - name: Build and Lint

.github/workflows/pre-commit-updates.yaml

@@ -0,0 +1,23 @@
+name: Update pre-commit hooks
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: 0 0 * * 0
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+      - uses: vrslev/[email protected]
+      - uses: peter-evans/create-pull-request@v5
+        with:
+          branch: pre-commit-autoupdate
+          title: "chore(deps): Update pre-commit hooks"
+          commit-message: "chore(deps): Update pre-commit hooks"
+          body: Update pre-commit hooks
+          labels: dependencies
+          delete-branch: True

.pre-commit-config.yaml

@@ -0,0 +1,66 @@
+repos:
+  # lint yaml, line and whitespace
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: requirements-txt-fixer
+      - id: mixed-line-ending
+      - id: check-executables-have-shebangs
+      - id: check-shebang-scripts-are-executable
+
+  # lint the dockerfiles
+  - repo: https://github.com/hadolint/hadolint
+    rev: v2.12.1-beta
+    hooks:
+      - id: hadolint
+
+  # prettier
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.3" # Use the sha / tag you want to point at
+    hooks:
+      - id: prettier
+        types_or: [file, bash, sh, javascript, jsx, ts, tsx]
+        additional_dependencies:
+          - [email protected]
+        exclude: ^(Dockerfile*)
+
+  - repo: https://github.com/codespell-project/codespell.git
+    rev: "v2.2.6" # Use the sha / tag you want to point at
+    hooks:
+      - id: codespell
+        types: [text]
+        args: [--ignore-words=.dictionary.txt]
+        exclude: ^(Dockerfile*)
+
+  - repo: https://github.com/shellcheck-py/shellcheck-py
+    rev: v0.9.0.6
+    hooks:
+      - id: shellcheck
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: 0.27.1
+    hooks:
+      - id: check-github-actions
+      - id: check-github-workflows
+
+  - repo: https://github.com/doublify/pre-commit-rust
+    rev: v1.0
+    hooks:
+      - id: fmt
+      - id: cargo-check
+
+    # lint python formatting
+  - repo: https://github.com/psf/black
+    rev: 23.11.0
+    hooks:
+      - id: black
+        exclude: ^(acars_router/)
+
+  - repo: https://github.com/pycqa/flake8
+    rev: "6.1.0" # pick a git hash / tag to point to
+    hooks:
+      - id: flake8
+        args: ["--extend-ignore=W503,W504,E501"]
+        exclude: ^(acars_router/)

README.md

@@ -1,5 +1,4 @@
-stubborn-io
-===========
+# stubborn-io
 
 This crate provides io traits/structs that automatically recover from potential disconnections/interruptions.
 
@@ -12,7 +11,6 @@ stubborn-io = "0.3"
 API Documentation, examples and motivations can be found here -
 https://docs.rs/stubborn-io .
 
-
 ### Usage Example
 
 In this example, we will see a drop in replacement for tokio's TcpStream, with the
@@ -32,4 +30,3 @@ let mut tcp_stream = StubbornTcpStream::connect(addr).await?;
 // call all of the regular methods on it, as seen below
 tcp_stream.write_all(b"hello world!").await?;
 ```
-

src/strategies.rs

@@ -11,7 +11,7 @@ use std::time::Duration;
 ///
 /// // With the below strategy, the stubborn-io item will try to reconnect infinitely,
 /// // waiting an exponentially increasing (by 2) value with 5% random jitter. Once the
-/// // wait would otherwise exceed the maxiumum of 30 seconds, it will instead wait 30
+/// // wait would otherwise exceed the maximum of 30 seconds, it will instead wait 30
 /// // seconds.
 ///
 /// let options = ReconnectOptions::new().with_retries_generator(|| {