v1.0.0

.actrc

@@ -1,8 +1,5 @@
 # Configuration file for act (run github actions locally using docker)
 # https://github.com/nektos/act
 
-# Swap docker image for the one containing the rust toolchain
--P ubuntu-latest=ghcr.io/catthehacker/ubuntu:rust-latest
-
-# Load custom event
--e .github/.act-event.json
+# Set the default image for the act container
+-P ubuntu-latest=ghcr.io/catthehacker/ubuntu:act-latest

.devcontainer/README.md

@@ -0,0 +1,48 @@
+# GameDig Dev Containers
+
+This setup guide is for configuring a unified, containerized environment tailored for both **Docker Desktop** (local development) and **GitHub Codespaces** (cloud development). The configurations use Visual Studio Code’s Dev Containers to streamline environment setup and maintain consistency across different operating systems.
+
+---
+
+## What Are Dev Containers?
+
+Dev Containers allow you to run a development environment inside a Docker container, providing an isolated workspace with pre-installed dependencies, tools, and configurations. This means:
+
+- **Reduced Setup Time**: All tools, dependencies, and configurations are predefined.
+- **Platform Consistency**: Every developer gets an identical environment, avoiding "works on my machine" issues.
+- **Flexibility**: Supports running on Windows, macOS, and Linux systems.
+
+For a general introduction, see [Microsoft’s Dev Containers Overview](https://code.visualstudio.com/docs/devcontainers/containers).
+
+## Dev Container Images
+
+The GameDig project includes two Dev Container configurations optimized for Docker Desktop and GitHub Codespaces:
+
+- **Docker Desktop**: Designed for local development.
+- **GitHub Codespaces**: Optimized for remote, cloud-based development on GitHub.
+
+### Key Features in Both Images:
+
+- **Rust Development Tools**: Rust is pre-installed with nightly toolchain.
+- **VS Code Extensions**: A comprehensive set of extensions for Rust development, code visualization, and Docker management.
+- **Utility Tools**:
+  - **`just` command runner** for task automation
+  - **`act`** for running GitHub Actions locally
+  - **Docker** integration for Docker-in-Docker or Docker-outside-of-Docker, depending on the environment.
+
+---
+
+## Setup Instructions
+
+### Prerequisites
+
+Ensure you have the following tools installed:
+
+- **Visual Studio Code**: [Download here](https://code.visualstudio.com/).
+- **Dev Containers Extension**: Install [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
+- **Docker**: Refer to the OS-specific steps on the [Docker website](https://docs.docker.com/get-docker).
+
+---
+
+> [!NOTE]
+> Work in progress. to be continued...

.devcontainer/docker_desktop/Dockerfile

@@ -0,0 +1,7 @@
+FROM mcr.microsoft.com/devcontainers/rust:1
+
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive
+
+RUN chown -R vscode /usr/local/cargo
+
+RUN rustup toolchain install nightly

.devcontainer/docker_desktop/compose.yaml

@@ -0,0 +1,8 @@
+services:
+  workspace:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    command: sleep infinity
+    volumes:
+      - ../..:/workspace:cached

.devcontainer/docker_desktop/devcontainer.json

@@ -0,0 +1,28 @@
+{
+  "name": "GameDig Docker Desktop (Dev Container)",
+
+  "service": "workspace",
+  "dockerComposeFile": "compose.yaml",
+  "workspaceFolder": "/workspace",
+
+  "features": {
+    "ghcr.io/guiyomh/features/just:0": {},
+    "ghcr.io/itsmechlark/features/act:1": {},
+    "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}
+  },
+
+  "customizations": {
+    "vscode": {
+      "settings": { "rust-analyzer.rustfmt.extraArgs": ["+nightly"] },
+      "extensions": [
+        "mhutchie.git-graph",
+        "Gruntfuggly.todo-tree",
+        "rust-lang.rust-analyzer",
+        "nefrob.vscode-just-syntax",
+        "tamasfe.even-better-toml",
+        "ms-vsliveshare.vsliveshare",
+        "aaron-bond.better-comments"
+      ]
+    }
+  }
+}

.devcontainer/github_codespace/Dockerfile

@@ -0,0 +1,7 @@
+FROM mcr.microsoft.com/devcontainers/rust:1
+
+RUN apt-get update && export DEBIAN_FRONTEND=noninteractive
+
+RUN chown -R vscode /usr/local/cargo
+
+RUN rustup toolchain install nightly

.devcontainer/github_codespace/devcontainer.json

@@ -0,0 +1,27 @@
+{
+  "name": "GameDig GitHub Codespace (Dev Container)",
+
+  "build": { "dockerfile": "Dockerfile" },
+
+  "features": {
+    "ghcr.io/guiyomh/features/just:0": {},
+    "ghcr.io/itsmechlark/features/act:1": {},
+    "ghcr.io/devcontainers/features/docker-in-docker:2": {}
+  },
+
+  "customizations": {
+    "vscode": {
+      "settings": { "rust-analyzer.rustfmt.extraArgs": ["+nightly"] },
+      "extensions": [
+        "mhutchie.git-graph",
+        "Gruntfuggly.todo-tree",
+        "rust-lang.rust-analyzer",
+        "nefrob.vscode-just-syntax",
+        "tamasfe.even-better-toml",
+        "ms-vsliveshare.vsliveshare",
+        "aaron-bond.better-comments",
+        "ms-azuretools.vscode-docker"
+      ]
+    }
+  }
+}

.gitattributes

@@ -0,0 +1,5 @@
+[attr]rust text eol=lf whitespace=tab-in-indent,trailing-space,tabwidth=4
+
+# Normalize files to LF line endings
+* text=auto eol=lf
+*.rs rust diff=rust

.github/dependabot.yml

@@ -1,5 +1,10 @@
 version: 2
 updates:
+  - package-ecosystem: "devcontainers"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
   - package-ecosystem: "github-actions"
     directory: "/.github/workflows"
     schedule:
@@ -13,4 +18,4 @@ updates:
   - package-ecosystem: "cargo"
     directory: "/crates/lib"
     schedule:
-      interval: "daily"
+      interval: "daily"

.github/workflows/ci.yaml

@@ -0,0 +1,53 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  check:
+    name: Check
+
+    strategy:
+      matrix:
+        platform:
+          - ubuntu-latest
+
+    runs-on: ${{ matrix.platform }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+          components: rustfmt, clippy
+
+      - name: Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          prefix-key: ${{ runner.os }}
+
+      - name: Build
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --verbose
+
+      - name: Lint
+        uses: actions-rs/cargo@v1
+        with:
+          command: clippy
+          args: --all-targets -- -D warnings
+
+      - name: Format
+        uses: actions-rs/cargo@v1
+        with:
+          command: fmt
+          args: --all -- --check