Add linting and checks before commit

.github/ISSUE_TEMPLATE/bug_report.md

@@ -3,7 +3,7 @@ name: Bug report
 about: Found something wrong? Let us know.
 title: "[BUG] "
 labels: bug
-assignees: ''
+assignees: ""
 ---
 
 # Describe the Bug

.github/ISSUE_TEMPLATE/feature.md

@@ -3,7 +3,7 @@ name: Feature
 about: A new feature to be added.
 title: "[FEAT] "
 labels: enhancement
-assignees: ''
+assignees: ""
 ---
 
 # Description

.github/ISSUE_TEMPLATE/performance.md

@@ -3,7 +3,7 @@ name: Performance
 about: An opportunity for performance improvement or other performance-related work.
 title: "[PERF] "
 labels: enhancement
-assignees: ''
+assignees: ""
 ---
 
 # Description

.github/ISSUE_TEMPLATE/task.md

@@ -3,7 +3,7 @@ name: Task
 about: A development task to be done.
 title: "[TASK] "
 labels: enhancement
-assignees: ''
+assignees: ""
 ---
 
 # Description

.github/workflows/ci.yml

@@ -2,28 +2,27 @@
 name: CI
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "*" ]
+    branches: ["*"]
 
 # Environment variables that will be set on all runners
 env:
   DEV_SHELL_LINUX: "nix --store ~/nix_store develop '.#ci'"
   DEV_SHELL_MACOS: "nix develop '.#ci'"
-  CARGO_TERM_COLOR: always   # Always colour Cargo's output.
-  CARGO_INCREMENTAL: 0       # Always run without incremental builds on CI.
+  CARGO_TERM_COLOR: always # Always colour Cargo's output.
+  CARGO_INCREMENTAL: 0 # Always run without incremental builds on CI.
   CARGO_PROFILE_DEV_DEBUG: 0 # Don't embed debug info even though the build is a dev build.
 
 # Configuration for individual jobs
 jobs:
-
   # This job is responsible for running the unit and integration tests
   test:
     name: "Test"
     strategy:
       fail-fast: false
       matrix:
-        os: [ "ubuntu-latest", "macos-latest" ]
+        os: ["ubuntu-latest", "macos-latest"]
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout Code
@@ -72,7 +71,7 @@ jobs:
 
   # This job runs the linter.
   lint:
-    name: "Lint"
+    name: "Lint Code"
     runs-on: "ubuntu-latest"
     steps:
       - name: Checkout Code
@@ -102,9 +101,9 @@ jobs:
       - name: Lint Code
         shell: bash
         run: |
-          ${{ env.DEV_SHELL_LINUX }} --command cargo clippy --all-targets
+          ${{ env.DEV_SHELL_LINUX }} --command cargo clippy --all-targets --all-features
 
-  # This job checks the code formatting.
+  # This job checks the formatting of the code and other artifacts.
   formatting:
     name: "Check Formatting"
     runs-on: "ubuntu-latest"
@@ -137,3 +136,11 @@ jobs:
         shell: bash
         run: |
           ${{ env.DEV_SHELL_LINUX }} --command cargo fmt --all -- --check
+      - name: Install Node Deps
+        shell: bash
+        run: |
+          ${{ env.DEV_SHELL_LINUX }} --command npm install
+      - name: Lint Documentation
+        shell: bash
+        run: |
+          ${{ env.DEV_SHELL_LINUX}} --command npx prettier --check .

.gitignore

@@ -3,4 +3,9 @@
 
 # Tooling
 .idea/
+node_modules/
 result
+
+# Linting and Formatting
+package-lock.json
+.husky/_

.husky/pre-commit

@@ -0,0 +1 @@
+cargo clippy --all-targets --all-features -- -D warnings && cargo +nightly fmt && npx lint-staged

.prettierignore

@@ -0,0 +1,3 @@
+# Generated Lockfiles
+Cargo.lock
+package-lock.json

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "printWidth": 100,
+  "proseWrap": "always",
+  "tabWidth": 2,
+  "plugins": ["prettier-plugin-toml"]
+}