Merge pull request #23 from LebJe/UpdateWorkflows

Update Workflows

.github/workflows/buildAndTest.yml

@@ -3,10 +3,10 @@ name: "Build and Test"
 on: ["push", "pull_request"]
 
 jobs:
-    TestOnMacOS-11_0-x86_64:
-        runs-on: "macos-11"
+    TestOnMacOS-Latest-x86_64:
+        runs-on: "macos-latest"
         steps:
-            - uses: "actions/checkout@v3"
+            - uses: "actions/checkout@v4"
             - name: "Run tests"
               run: "swift test"
     # TestOnUbuntu-20_04-ARM:
@@ -29,23 +29,23 @@ jobs:
     TestOnUbuntu-20_04-x86_64:
         runs-on: "ubuntu-latest"
         steps:
-            - uses: "actions/checkout@v3"
+            - uses: "actions/checkout@v4"
             - name: "Run tests"
               run: "swift test"
     TestOnWindows10-x86_64:
         runs-on: "windows-latest"
         steps:
-            - uses: "actions/checkout@v3"
+            - uses: "actions/checkout@v4"
             - uses: "seanmiddleditch/gha-setup-vsdevenv@master"
             - uses: "compnerd/gha-setup-swift@main"
               with:
-                  branch: "swift-5.6-release"
-                  tag: "5.6-RELEASE"
+                  branch: "swift-5.8-release"
+                  tag: "5.8-RELEASE"
             - name: "Test"
               run: "swift test -Xcc -D_ALLOW_COMPILER_AND_STL_VERSION_MISMATCH -Xcxx -D_ALLOW_COMPILER_AND_STL_VERSION_MISMATCH"
-    TestBuildingOnMacOS-11_0-ARM64:
-        runs-on: "macos-11"
+    TestBuildingOnMacOS-Latest-ARM64:
+        runs-on: "macos-latest"
         steps:
-            - uses: "actions/checkout@v3"
+            - uses: "actions/checkout@v4"
             - name: "Run tests"
               run: "swift build --arch arm64"

.github/workflows/generateDocumentation.yml

@@ -9,29 +9,20 @@ jobs:
     "GenerateDocumentation":
         runs-on: "macos-latest"
         steps:
-            - uses: "actions/checkout@v3"
-            - name: "Clone swift-docc and swift-docc-render"
-              run: "gh repo clone apple/swift-docc && gh repo clone LebJe/swift-docc-render"
-              env:
-                  GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-            - name: "Build swift-docc-render"
-              run: "cd swift-docc-render/ && npm install && npm run build && cd .."
-            - name: "Cache DocC"
-              id: "cache-docc"
-              uses: "actions/cache@v3"
-              with:
-                  key: "TOMLKit-docc-build"
-                  path: "swift-docc/.build"
-            - name: "Build swift-docc"
-              if: "${{ !steps.cache-docc.outputs.cache-hit }}"
-              run: "swift build --product docc --package-path swift-docc -c release"
+            - uses: "actions/checkout@v4"
+            # - name: "Clone swift-docc-render"
+            #   run: "gh repo clone LebJe/swift-docc-render"
+            #   env:
+            #       GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+            # - name: "Build swift-docc-render"
+            #   run: "cd swift-docc-render/ && npm install && npm run build && cd .."
             - name: "Build TOMLKit"
               run: "swift build --target TOMLKit -Xswiftc -emit-symbol-graph -Xswiftc -emit-symbol-graph-dir -Xswiftc .build"
             - name: "Build documentation"
               run: |
-                  export DOCC_HTML_DIR=swift-docc-render/dist
+                  #export DOCC_HTML_DIR=swift-docc-render/dist
 
-                  ./swift-docc/.build/release/docc convert \
+                  xcrun docc convert \
                   Sources/TOMLKit/TOMLKit.docc \
                   --fallback-display-name TOMLKit \
                   --fallback-bundle-identifier com.LebJe.TOMKit \
@@ -40,7 +31,7 @@ jobs:
                   --enable-inherited-docs \
                   --output-dir docs
 
-                  ./swift-docc/.build/release/docc process-archive transform-for-static-hosting docs --hosting-base-path /TOMLKit
+                  xcrun docc process-archive transform-for-static-hosting docs --hosting-base-path /TOMLKit
             - name: "Deploy to GitHub Pages"
               uses: "peaceiris/actions-gh-pages@v3"
               with:

.github/workflows/pre-commit.yml

@@ -1,16 +1,15 @@
 name: "Run Pre-Commit"
 
-on: "pull_request"
+on:
+    push:
+        branches:
+            - "main"
 
 jobs:
     PreCommit:
         runs-on: "macos-latest"
         steps:
-            - uses: "actions/checkout@v3"
-            - name: "Checkout PR"
-              env:
-                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-              run: "gh pr checkout ${{ github.event.pull_request.number }}"
+            - uses: "actions/checkout@v4"
             - name: "Install Dependencies"
               run: "brew bundle"
             - uses: "LebJe/pre-commit-composite-action@0.0.1"

.gitignore

@@ -10,3 +10,4 @@ Sources/TOMLKit/TOMLKit.docc/.docc-build
 TOMLKit.doccarchive
 docs/
 .vscode
+node_modules

.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
           - id: "swift-format"
             name: "Format Swift"
     - repo: "https://github.com/pre-commit/mirrors-prettier"
-      rev: "v2.6.1"
+      rev: "v4.0.0-alpha.3-1"
       hooks:
           - id: "prettier"
             name: "Format YAML & Markdown"

.prettierrc

@@ -0,0 +1,6 @@
+{
+	"trailingComma": "es5",
+	"tabWidth": 4,
+	"singleQuote": false,
+	"useTabs": true
+}

Sources/TOMLKit/TOML Data Types/TOMLTable/TOMLTable.swift

@@ -184,7 +184,7 @@ public final class TOMLTable:
 	}
 
 	/// A pointer to the underlying `toml::table`.
-	internal var tablePointer: OpaquePointer
+	var tablePointer: OpaquePointer
 
 	/// The amount of elements in the table.
 	public var count: Int { tableSize(self.tablePointer) }

Sources/TOMLKit/TOMLParseError.swift

@@ -16,12 +16,12 @@ public struct TOMLSourcePosition: Equatable, CustomDebugStringConvertible {
 
 	public var debugDescription: String { "line \(self.line), column \(self.column)" }
 
-	internal init(line: Int, column: Int) {
+	init(line: Int, column: Int) {
 		self.line = line
 		self.column = column
 	}
 
-	internal init(cTOMLSourcePosition: CTOMLSourcePosition) {
+	init(cTOMLSourcePosition: CTOMLSourcePosition) {
 		self.line = Int(cTOMLSourcePosition.line)
 		self.column = Int(cTOMLSourcePosition.column)
 	}
@@ -31,12 +31,12 @@ public struct TOMLSourceRegion: Equatable, CustomDebugStringConvertible {
 	public let begin: TOMLSourcePosition
 	public let end: TOMLSourcePosition
 
-	internal init(begin: TOMLSourcePosition, end: TOMLSourcePosition) {
+	init(begin: TOMLSourcePosition, end: TOMLSourcePosition) {
 		self.begin = begin
 		self.end = end
 	}
 
-	internal init(cBegin: CTOMLSourcePosition, cEnd: CTOMLSourcePosition) {
+	init(cBegin: CTOMLSourcePosition, cEnd: CTOMLSourcePosition) {
 		self.begin = .init(cTOMLSourcePosition: cBegin)
 		self.end = .init(cTOMLSourcePosition: cEnd)
 	}
@@ -56,7 +56,7 @@ public struct TOMLParseError: Error, CustomDebugStringConvertible {
 	/// This documentation comment was taken from the [toml++ documentation](https://marzer.github.io/tomlplusplus/classtoml_1_1parse__error.html#a8168b4941305654cf4ba8fc96efd0514).
 	public let source: TOMLSourceRegion
 
-	internal init(cTOMLParseError: CTOMLParseError) {
+	init(cTOMLParseError: CTOMLParseError) {
 		self.description = String(cString: cTOMLParseError.description)
 		self.source = TOMLSourceRegion(cBegin: cTOMLParseError.source.begin, cEnd: cTOMLParseError.source.end)
 	}

Sources/TOMLKit/TOMLValue/TOMLValue.swift

@@ -29,9 +29,9 @@ public struct TOMLValue:
 	TOMLValueConvertible
 {
 	/// The pointer to the underlying `toml::node`.
-	internal let tomlValuePointer: OpaquePointer
+	let tomlValuePointer: OpaquePointer
 
-	internal var tomlInt: TOMLInt?
+	var tomlInt: TOMLInt?
 
 	public var type: TOMLType {
 		nodeType(self.tomlValuePointer).tomlType