Merge pull request #1 from MFB-Technologies-Inc/feature/prepare-for-release

Feature/prepare for release

Author: roanutil

.devcontainer/devcontainer.json

@@ -0,0 +1,44 @@
+{
+	"name": "swift-argument-encoding",
+    "image": "swift:5.7",
+    "features": {
+        "ghcr.io/devcontainers/features/common-utils:2": {
+            "installZsh": "false",
+            "username": "vscode",
+            "userUid": "1000",
+            "userGid": "1000",
+            "upgradePackages": "false"
+        },
+        "ghcr.io/devcontainers/features/git:1": {
+            "version": "os-provided",
+            "ppa": "false"
+        }
+    },
+    "runArgs": [
+        "--cap-add=SYS_PTRACE",
+        "--security-opt",
+        "seccomp=unconfined"
+    ],
+    // Configure tool-specific properties.
+    "customizations": {
+        // Configure properties specific to VS Code.
+        "vscode": {
+            // Set *default* container specific settings.json values on container create.
+            "settings": {
+                "lldb.library": "/usr/lib/liblldb.so"
+            },
+            // Add the IDs of extensions you want installed when the container is created.
+            "extensions": [
+                "sswg.swift-lang"
+            ]
+        }
+    },
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+
+    // Use 'postCreateCommand' to run commands after the container is created.
+    "postCreateCommand": "swift --version",
+
+    // Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+    "remoteUser": "vscode"
+}

.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  library:
+    runs-on: macos-12
+    environment: default
+    strategy:
+      matrix:
+        xcode: ['14.2']
+        # Swift: 5.7  
+    steps:
+      - uses: actions/checkout@v3
+      - name: Format lint
+        run: swiftformat --lint .
+      - name: Lint
+        run: swiftlint .

.github/workflows/linux-test.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  library:
+    runs-on: ${{ matrix.os }}
+    environment: default
+    strategy:
+      matrix:
+        os: [ubuntu2004, ubuntu2204]
+    steps:
+      - name: Run Tests
+        run: swift test --enable-code-coverage --parallel

.github/workflows/macos-test.yml

@@ -0,0 +1,30 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  library:
+    runs-on: macos-12
+    environment: default
+    strategy:
+      matrix:
+        xcode: ['14.2']
+        # Swift: 5.7  
+    steps:
+      - uses: actions/checkout@v3
+      - name: Select Xcode ${{ matrix.xcode }}
+        run: sudo xcode-select -s /Applications/Xcode_${{ matrix.xcode }}.app
+      - name: Run Tests
+        run: swift test --enable-code-coverage --parallel
+      - name: Swift Coverage Report
+        run: xcrun llvm-cov export -format="lcov" .build/debug/swift-argument-encodingPackageTests.xctest/Contents/MacOS/swift-argument-encodingPackageTests -instr-profile .build/debug/codecov/default.profdata > coverage_report.lcov
+      - uses: codecov/codecov-action@v3
+        with:
+          fail_ci_if_error: true # optional (default = false)

Examples/Package.resolved

@@ -0,0 +1,32 @@
+// swift-tools-version: 5.7
+
+import PackageDescription
+
+let package = Package(
+    name: "swift-argument-encoding-examples",
+    platforms: [.macOS(.v12)],
+    products: [
+        .executable(name: "SwiftCommand", targets: ["SwiftCommand"]),
+    ],
+    dependencies: [
+        .argumentEncoding,
+    ],
+    targets: [
+        .executableTarget(
+            name: "SwiftCommand",
+            dependencies: [
+                .argumentEncoding,
+            ]
+        ),
+    ]
+)
+
+// MARK: Local
+
+extension Package.Dependency {
+    static let argumentEncoding: Package.Dependency = .package(name: "swift-argument-encoding", path: "../")
+}
+
+extension Target.Dependency {
+    static let argumentEncoding: Self = .product(name: "ArgumentEncoding", package: "swift-argument-encoding")
+}

Examples/Package.swift

@@ -0,0 +1,19 @@
+// RunCommand.swift
+// ArgumentEncoding
+//
+// Copyright © 2023 MFB Technologies, Inc. All rights reserved.
+
+import ArgumentEncoding
+
+struct RunCommand: CommandRepresentable {
+    let flagFormatter: FlagFormatter = .doubleDashPrefixKebabCase
+    let optionFormatter: OptionFormatter = .doubleDashPrefixKebabCase
+
+    let executable: Command
+}
+
+extension RunCommand: ExpressibleByStringLiteral {
+    init(stringLiteral value: StringLiteralType) {
+        self.init(executable: Command(rawValue: value))
+    }
+}

Examples/Sources/SwiftCommand/RunCommand.swift

@@ -0,0 +1,16 @@
+// SwiftCommand.swift
+// ArgumentEncoding
+//
+// Copyright © 2023 MFB Technologies, Inc. All rights reserved.
+
+import ArgumentEncoding
+
+enum SwiftCommand: TopLevelCommandRepresentable {
+    func commandValue() -> Command { "swift" }
+
+    var flagFormatter: FlagFormatter { .doubleDashPrefixKebabCase }
+    var optionFormatter: OptionFormatter { .doubleDashPrefixKebabCase }
+
+    case run(RunCommand)
+    case test(TestCommand)
+}

Examples/Sources/SwiftCommand/SwiftCommand.swift

@@ -0,0 +1,18 @@
+// TestCommand.swift
+// ArgumentEncoding
+//
+// Copyright © 2023 MFB Technologies, Inc. All rights reserved.
+
+import ArgumentEncoding
+
+struct TestCommand: CommandRepresentable {
+    let flagFormatter: FlagFormatter = .doubleDashPrefixKebabCase
+    let optionFormatter: OptionFormatter = .doubleDashPrefixKebabCase
+
+    @Flag var parallel: Bool = true
+    @Option var numWorkers: Int = 1
+    @Flag var showCodecovPath: Bool = false
+    var testProducts: [Command]
+}
+
+extension [Command]: ArgumentGroup {}

Examples/Sources/SwiftCommand/TestCommand.swift

@@ -0,0 +1,28 @@
+// main.swift
+// ArgumentEncoding
+//
+// Copyright © 2023 MFB Technologies, Inc. All rights reserved.
+
+let test = SwiftCommand.test(TestCommand(
+    parallel: true,
+    numWorkers: 4,
+    showCodecovPath: true,
+    testProducts: ["swiftlint"]
+))
+let run = SwiftCommand.run("swiftlint")
+print("""
+SwiftCommand.test(TestCommand(
+    parallel: true,
+    numWorkers: 4,
+    showCodecovPath: true,
+    testProducts: ["swiftlint"]
+))
+
+\(test.arguments())
+
+-------------------------------
+
+SwiftCommand.run("swiftlint")
+
+\(run.arguments())
+""")