Add SourceDocsLib & prepare for 1.0.0 (SourceDocs#42)

#### Breaking
- Add `SourceDocsLib` so it can be used by other Swift tools to generate documentation.

#### Enhancements
- Migrated from `Commandant` to [`Swift Argument Parser`](https://github.com/apple/swift-argument-parser) for command line parsing

#### Bug Fixes
- None

### Discussion
This pull requests is based in the work done by @designatednerd on SourceDocs#40, to move most code to `SourceDocsLib`, a new library that can be imported  y other Swift applications to generate documentation.

With the migration from **Commandant** to **Swift Argument Parser**, this pull request also sets the base for version 1.0.0. Command line arguments have not changed from prior versions of the tool.

Author: eneko

.swiftlint.yml

@@ -1,11 +1,9 @@
-included:
-  - Sources
-  - Tests
-
 excluded:
+  - .build
   - Tests/LinuxMain.swift
-  - Tests/UnitTests/XCTestManifests.swift
-  - Tests/BehavioralTests/XCTestManifests.swift
+  - Tests/SourceDocsLibTests/XCTestManifests.swift
+  - Tests/SourceDocsCLITests/XCTestManifests.swift
+
 
 opt_in_rules:
   - attributes
@@ -17,7 +15,6 @@ opt_in_rules:
   - first_where
   - force_unwrapping
   - joined_default_parameter
-  - let_var_whitespace
   - nimble_operator
   - no_extension_access_modifier
   - number_separator

.travis.yml

@@ -11,42 +11,42 @@ jobs:
   - stage: Continuous Integration
     name: SwiftPM macOS
     os: osx
-    osx_image: xcode10.3
+    osx_image: xcode11
     script:
     - swift test --parallel
   - stage: Continuous Integration
     name: SwiftPM Linux
-    os: Linux
+    os: linux
     dist: trusty
-    sudo: required
     install:
     - eval "$(curl -sL https://swiftenv.fuller.li/install.sh)"
-    - swiftenv install 5.0
-    - swiftenv local 5.0
+    - swiftenv install 5.1
+    - swiftenv local 5.1
     - swift --version
     script:
+    - swift build
     - swift test --parallel
   - stage: Continuous Integration
-    name: Code Coverage (Xcode 10.3)
+    name: Code Coverage
     os: osx
-    osx_image: xcode10.3
+    osx_image: xcode11
     script:
     - swift package generate-xcodeproj --enable-code-coverage
-    - xcodebuild -scheme SourceDocs-Package test
+    - xcodebuild -scheme SourceDocs-Package -quiet test
     after_success:
-    - bash <(curl -s https://codecov.io/bash) -J 'SourceDocs'
+    - bash <(curl -s https://codecov.io/bash) -J 'SourceDocsLib'
   - stage: Continuous Integration
     name: Installation with Homebrew (macOS)
     os: osx
-    osx_image: xcode10.3
+    osx_image: xcode11
     script:
     - brew update
     - brew install sourcedocs
     - sourcedocs version
   - stage: Continuous Integration
     name: Installation from Source (macOS)
     os: osx
-    osx_image: xcode10.3
+    osx_image: xcode11
     script:
     - git clone --depth 1 https://github.com/eneko/SourceDocs.git
     - cd SourceDocs

CHANGELOG.md

@@ -10,6 +10,18 @@
 - None
 
 
+## 1.0.0
+
+#### Breaking
+- Add `SourceDocsLib` so it can be used by other Swift tools to generate documentation.
+
+#### Enhancements
+- Migrated from `Commandant` to [`Swift Argument Parser`](https://github.com/apple/swift-argument-parser) for command line parsing.
+
+#### Bug Fixes
+- None
+
+
 ## 0.6.1
 
 #### Breaking

Makefile

@@ -1,5 +1,5 @@
 TOOL_NAME = sourcedocs
-VERSION = 0.6.1
+VERSION = 1.0.0
 
 PREFIX = /usr/local
 INSTALL_PATH = $(PREFIX)/bin/$(TOOL_NAME)
@@ -23,7 +23,8 @@ lint:
 	swiftlint lint --quiet --strict
 
 docs:
-	swift run sourcedocs generate --clean --spm-module SourceDocsDemo --output-folder docs/reference --module-name-path
+	swift run sourcedocs generate --clean --spm-module SourceDocsDemo --output-folder docs/reference --module-name-path --min-acl private
+	swift run sourcedocs generate --clean --spm-module SourceDocsLib --output-folder docs/reference --module-name-path
 
 xcode:
 	swift package generate-xcodeproj --enable-code-coverage

Package.resolved

@@ -10,15 +10,6 @@
           "version": "0.17.0"
         }
       },
-      {
-        "package": "Curry",
-        "repositoryURL": "https://github.com/thoughtbot/Curry.git",
-        "state": {
-          "branch": null,
-          "revision": "4331dd50bc1db007db664a23f32e6f3df93d4e1a",
-          "version": "4.0.2"
-        }
-      },
       {
         "package": "CwlCatchException",
         "repositoryURL": "https://github.com/mattgallagher/CwlCatchException.git",
@@ -78,8 +69,17 @@
         "repositoryURL": "https://github.com/jpsim/SourceKitten.git",
         "state": {
           "branch": null,
-          "revision": "356551fc513eb12ed779bb369f79cf86a3a01599",
-          "version": "0.27.0"
+          "revision": "77a4dbbb477a8110eb8765e3c44c70fb4929098f",
+          "version": "0.29.0"
+        }
+      },
+      {
+        "package": "swift-argument-parser",
+        "repositoryURL": "https://github.com/apple/swift-argument-parser",
+        "state": {
+          "branch": null,
+          "revision": "9f04d1ff1afbccd02279338a2c91e5f27c45e93a",
+          "version": "0.0.5"
         }
       },
       {

Package.swift

@@ -4,26 +4,21 @@ import PackageDescription
 let package = Package(
     name: "SourceDocs",
     products: [
-        .executable(name: "sourcedocs", targets: ["SourceDocs"]),
+        .executable(name: "sourcedocs", targets: ["SourceDocsCLI"]),
+        .library(name: "SourceDocsLib", targets: ["SourceDocsLib"])
     ],
     dependencies: [
-        .package(url: "https://github.com/jpsim/SourceKitten.git", from: "0.26.0"),
-        .package(url: "https://github.com/Carthage/Commandant.git", from: "0.15.0"),
+        .package(url: "https://github.com/apple/swift-argument-parser", from: "0.0.1"),
+        .package(url: "https://github.com/jpsim/SourceKitten.git", from: "0.29.0"),
         .package(url: "https://github.com/eneko/MarkdownGenerator.git", from: "0.4.0"),
         .package(url: "https://github.com/onevcat/Rainbow", from: "3.0.0"),
-        .package(url: "https://github.com/thoughtbot/Curry.git", from: "4.0.1"),
         .package(url: "https://github.com/eneko/System.git", from: "0.2.0")
     ],
     targets: [
-        .target(name: "SourceDocs", dependencies: [
-            "SourceKittenFramework",
-            "MarkdownGenerator",
-            "Rainbow",
-            "Commandant",
-            "Curry"
-            ]),
-        .testTarget(name: "BehavioralTests", dependencies: ["System"]),
-        .testTarget(name: "UnitTests", dependencies: ["SourceDocs"]),
+        .target(name: "SourceDocsCLI", dependencies: ["SourceDocsLib", "ArgumentParser", "Rainbow"]),
+        .target(name: "SourceDocsLib", dependencies: ["SourceKittenFramework", "MarkdownGenerator", "Rainbow"]),
         .target(name: "SourceDocsDemo", dependencies: []),
+        .testTarget(name: "SourceDocsCLITests", dependencies: ["System"]),
+        .testTarget(name: "SourceDocsLibTests", dependencies: ["SourceDocsLib"])
     ]
 )