Modernize devcontainer (#17)

.devcontainer/Dockerfile

@@ -0,0 +1,18 @@
+FROM swift:5.9-jammy
+# FROM swiftlang/swift:nightly-main-focal
+
+# Install test dependencies
+RUN DEBIAN_FRONTEND=noninteractive \
+  apt-get update && \
+  apt-get install -y \
+    xxd
+
+# Install swift-format
+RUN \
+  git clone https://github.com/apple/swift-format.git -b 509.0.0 /opt/swift-format && \
+  cd /opt/swift-format && \
+  # Build debug since release takes forever to build and there isn't a meaningful runtime performance delta
+  swift build -c debug && \
+  cp .build/debug/swift-format /usr/bin/swift-format && \
+  rm -rf /opt/swift-format
+

.devcontainer/devcontainer.json

@@ -0,0 +1,37 @@
+{
+  "name": "Shwift",
+  "dockerFile": "Dockerfile",
+
+  "capAdd": [
+    "SYS_PTRACE"
+  ],
+  "securityOpt": [
+    "seccomp=unconfined"
+  ],
+
+  "mounts": [
+    // Use a named volume for the build products for optimal performance (https://code.visualstudio.com/remote/advancedcontainers/improve-performance?WT.mc_id=javascript-14373-yolasors#_use-a-targeted-named-volume)
+    "source=${localWorkspaceFolderBasename}-build,target=${containerWorkspaceFolder}/build,type=volume"
+  ],
+  "remoteEnv": {
+    // Useful for disambiguating devcontainers
+    "LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}"
+  },
+
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "lldb.library": "/usr/lib/liblldb.so",
+        "lldb.launch.expressions": "native",
+
+        "[swift]": {
+          "editor.defaultFormatter": "vknabel.vscode-apple-swift-format"
+        },
+      },
+      "extensions": [
+        "sswg.swift-lang",
+        "vknabel.vscode-apple-swift-format",
+      ],
+    }
+  },
+}

.github/workflows/checkCommit.yml

@@ -0,0 +1,71 @@
+name: Check Commit
+
+on:
+  push:
+    branches:
+      - main
+  pull_request: {}
+
+jobs:
+  validate-formatting:
+    name: Validate Formatting
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Initialize devcontainer
+        uses: devcontainers/[email protected]
+        with:
+          push: never
+          runCmd: |
+            git status
+            echo "Devcontainer Initialized."
+      - name: Validate swift formatting
+        uses: devcontainers/[email protected]
+        with:
+          push: never
+          runCmd: |
+            swift-format \
+              --in-place \
+              --recursive Sources Tests
+            git config --global --add safe.directory /workspaces/Shwift
+            git diff
+            git diff-index --quiet HEAD --
+
+  test-macos:
+    name: Run Tests on macOS
+    strategy:
+      fail-fast: false
+    runs-on: macos-13
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Correct Swift Version
+        uses: compnerd/gha-setup-swift@main
+        with:
+          branch: swift-5.9-release
+          tag: 5.9-RELEASE
+      - run: swift build
+      - run: swift test
+      - run: swift run ScriptExample
+
+  test-devcontainer:
+    name: Run Tests in devcontainer
+    strategy:
+      fail-fast: false
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: Initialize devcontainer
+        uses: devcontainers/[email protected]
+        with:
+          push: never
+          runCmd: |
+            echo "Devcontainer Initialized."
+      - name: Test Shwift
+        uses: devcontainers/[email protected]
+        with:
+          push: never
+          runCmd: |
+            swift build
+            swift test
+            swift run ScriptExample

.gitignore

@@ -3,6 +3,4 @@
 /Packages
 /*.xcodeproj
 xcuserdata/
-DerivedData/
-.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
-.swiftpm
+.vscode

Package.resolved

@@ -10,15 +10,6 @@
           "version": "1.1.4"
         }
       },
-      {
-        "package": "swift-format",
-        "repositoryURL": "https://github.com/apple/swift-format",
-        "state": {
-          "branch": "release/5.8",
-          "revision": "fbfe1869527923dd9f9b2edac148baccfce0dce7",
-          "version": null
-        }
-      },
       {
         "package": "swift-nio",
         "repositoryURL": "https://github.com/apple/swift-nio.git",
@@ -28,15 +19,6 @@
           "version": "2.40.0"
         }
       },
-      {
-        "package": "SwiftSyntax",
-        "repositoryURL": "https://github.com/apple/swift-syntax",
-        "state": {
-          "branch": null,
-          "revision": "2c49d66d34dfd6f8130afdba889de77504b58ec0",
-          "version": "508.0.1"
-        }
-      },
       {
         "package": "swift-system",
         "repositoryURL": "https://github.com/apple/swift-system",
@@ -45,15 +27,6 @@
           "revision": "836bc4557b74fe6d2660218d56e3ce96aff76574",
           "version": "1.1.1"
         }
-      },
-      {
-        "package": "swift-tools-support-core",
-        "repositoryURL": "https://github.com/apple/swift-tools-support-core.git",
-        "state": {
-          "branch": null,
-          "revision": "93784c59434dbca8e8a9e4b700d0d6d94551da6a",
-          "version": "0.5.2"
-        }
       }
     ]
   },

Package.swift

@@ -12,7 +12,6 @@ let package = Package(
     .library(name: "Shwift", targets: ["Shwift"]),
   ],
   dependencies: [
-    .package(url: "https://github.com/apple/swift-format", .branch("release/5.8")),
     .package(url: "https://github.com/apple/swift-argument-parser", from: "1.0.0"),
     .package(url: "https://github.com/apple/swift-system", from: "1.1.1"),
     .package(url: "https://github.com/apple/swift-nio.git", from: "2.0.0"),