ci: set up linting on ci

Author: JaapWijnen

.github/workflows/pull_request.yml

@@ -3,6 +3,14 @@ name: Pull Requst
 on: [pull_request]
 
 jobs:
+  lint:
+    name: Lint Formatting
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Lint Formatting
+        run: swift format lint --recursive --strict .
+
   test-ubuntu-latest:
     name: Test Swift ${{ matrix.swift }} Ubuntu Latest
     strategy:

.swift-format

@@ -0,0 +1,25 @@
+ {
+   "fileScopedDeclarationPrivacy" : {
+     "accessLevel" : "private"
+   },
+   "indentation" : {
+     "spaces" : 4
+   },
+   "indentConditionalCompilationBlocks" : false,
+   "indentSwitchCaseLabels" : true,
+   "lineLength" : 140,
+   "rules" : {
+     "AllPublicDeclarationsHaveDocumentation" : true,
+     "NeverForceUnwrap" : true,
+     "NeverUseForceTry" : true,
+     "NeverUseImplicitlyUnwrappedOptionals" : true,
+     "NoAccessLevelOnExtensionDeclaration" : true,
+     "NoLeadingUnderscores" : true,
+     "OmitExplicitReturns" : true,
+     "UseEarlyExits" : true,
+     "UseWhereClausesInForLoops" : true,
+     "ValidateDocumentationComments" : true
+   },
+   "spacesAroundRangeFormationOperators" : true,
+   "version" : 1
+ }

README.md

@@ -2,5 +2,15 @@
 ## Getting Started
 
 ## Contributing
+### Code Formatting
+This package makes use of [swift-format](https://github.com/swiftlang/swift-format), which is built directly into the swift toolchain as of
+swift 6. To apply formatting rules to all files, which you should do before submitting a PR, run from the root of the repository:
 
-## Additional Resources
+```sh
+swift format --in-place --recursive .
+```
+
+Formatting is validated with the `--strict` flag on every PR
+
+
+## Additional Resources