chore(): swift 5.1, added platform to Package.swift; docs(readme): added spm installation section; feat(): made sdoutStream and stderrStream public; refactor(): fixed hashable conformance

Author: Christian Elies

ArgumentParserKit.podspec

@@ -2,17 +2,13 @@
 # Be sure to run `pod lib lint ArgumentParserKit.podspec' to ensure this is a
 # valid spec before submitting.
 #
-# Any lines starting with a # are optional, but their use is encouraged
-# To learn more about a Podspec see https://guides.cocoapods.org/syntax/podspec.html
-#
-
 Pod::Spec.new do |s|
   s.name             = 'ArgumentParserKit'
   s.version          = '1.0.0'
   s.summary          = 'Type-safe and easy way for parsing command line arguments in your macOS command line tools.'
 
   s.description      = <<-DESC
-					I think the ArgumentParser Apple hides inside their Swift Package Manager deserves more. That's why I extracted the relevant source code into a Pod to make it available to a larger audience.
+					I think the ArgumentParser Apple hides inside their Swift Package Manager deserves more. That's why I extracted the relevant source code into a Pod / Swift package to make it available to a larger audience.
 					The ArgumentParser offers a type-safe and easy way to parse arguments given via the command line to your program. Keep in mind that Apple itself makes clear that you use this private and maybe unstable API at your own risk.
                        DESC
 
@@ -22,7 +18,7 @@ Pod::Spec.new do |s|
   s.source           = { :git => 'https://github.com/crelies/ArgumentParserKit.git', :tag => s.version.to_s }
 
   s.cocoapods_version = '>= 1.4'
-  s.swift_version = '4.0'
+  s.swift_version = '5.1'
   s.platform = :osx
   s.osx.deployment_target = "10.10"
 

ArgumentParserKit/Classes/ArgumentParser.swift

@@ -287,8 +287,8 @@ protocol ArgumentProtocol: Hashable {
 extension ArgumentProtocol {
     // MARK: - Conformance for Hashable
 
-    public var hashValue: Int {
-        return name.hashValue
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(name)
     }
 
     public static func == (_ lhs: Self, _ rhs: Self) -> Bool {

ArgumentParserKit/Classes/OutputByteStream.swift

@@ -611,7 +611,7 @@ final class BufferedOutputByteStream: OutputByteStream {
 }
 
 /// Represents a stream which is backed to a file. Not for instantiating.
-class FileOutputByteStream: OutputByteStream {
+public class FileOutputByteStream: OutputByteStream {
 
     /// Closes the file flushing any buffered data.
     final func close() throws {
@@ -704,11 +704,11 @@ final class LocalFileOutputByteStream: FileOutputByteStream {
 }
 
 /// stdout stream instance.
-var stdoutStream: FileOutputByteStream = try! LocalFileOutputByteStream(
+public let stdoutStream: FileOutputByteStream = try! LocalFileOutputByteStream(
     filePointer: stdout,
     closeOnDeinit: false)
 
 /// stderr stream instance.
-var stderrStream: FileOutputByteStream = try! LocalFileOutputByteStream(
+public let stderrStream: FileOutputByteStream = try! LocalFileOutputByteStream(
     filePointer: stderr,
     closeOnDeinit: false)

Package.swift

@@ -4,6 +4,9 @@ import PackageDescription
 
 let package = Package(
     name: "ArgumentParserKit",
+    platforms: [
+        .macOS(.v10_10)
+    ],
     products: [
         .library(
             name: "ArgumentParserKit",

README.md

@@ -3,7 +3,7 @@
 Type-safe and easy way for parsing command line arguments in your macOS command line tools
 
 [![Version](https://img.shields.io/cocoapods/v/ArgumentParserKit.svg?longCache=true&style=flat-square)](http://cocoapods.org/pods/ArgumentParserKit)
-[![Swift4](https://img.shields.io/badge/swift4-compatible-orange.svg?longCache=true&style=flat-square)](https://developer.apple.com/swift)
+[![Swift5.1](https://img.shields.io/badge/swift5.1-compatible-orange.svg?longCache=true&style=flat-square)](https://developer.apple.com/swift)
 [![Platform](https://img.shields.io/badge/platform-macOS-lightgrey.svg?longCache=true&style=flat-square)](https://www.apple.com/de/macos)
 [![License](https://img.shields.io/badge/license-Apache%20License%20v2.0-lightgrey.svg?longCache=true&style=flat-square)](https://en.wikipedia.org/wiki/Apache_License)
 
@@ -102,17 +102,27 @@ func get<T>(_ argument: OptionArgument<T>) -> T?
 
 ## Requirements
 
-Deployment target has to be greater than or equal to 10.10.
+Deployment target has to be greater than or equal to macOS 10.10.
 
 ## Installation
 
+### Cocoapods
+
 ArgumentParserKit is available through [CocoaPods](https://cocoapods.org). To install
 it, simply add the following line to your Podfile:
 
 ```ruby
 pod 'ArgumentParserKit'
 ```
 
+### Swift package manager
+
+Add this **Swift package** as a dependency to your *Package.swift*
+
+```swift
+.package(url: "https://github.com/crelies/ArgumentParserKit.git", from: "1.0.0")
+```
+
 ## Further resources
 
 Take a look at [Parsing Command Line Arguments using the internal `ArgumentParser` inside of the `Swift Package Manager`](https://www.enekoalonso.com/articles/parsing-command-line-arguments-with-swift-package-manager-argument-parser)