Display a warning if an input directory does not exist. (#242)

* Display a warning for users if an input directory does not exist.

* Clarify that a path should lead to a directory, not a Swift file.

* Update Sources/swift-doc/Subcommands/Generate.swift

* Add changelog entry for #242

Co-authored-by: Mattt <mattt@me.com>

Author: Lukas-Stuehrk

Changelog.md

@@ -32,6 +32,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Changed serialization of `Symbol` to encode and decode `sourceRange` key
   instead of `sourceLocation` key.
   #237 by @mattt.
+- Changed commands to warn when invalid paths are passed.
+  #242 by @Lukas-Stuehrk.
 
 ### Deprecated
 

README.md

@@ -92,7 +92,7 @@ $ apt-get install -y libxml2-dev graphviz
     USAGE: swift doc generate [<inputs> ...] --module-name <module-name> [--output <output>] [--format <format>] [--base-url <base-url>]
 
     ARGUMENTS:
-      <inputs>                One or more paths to Swift files 
+      <inputs>                One or more paths to a directory containing Swift files. 
 
     OPTIONS:
       -n, --module-name <module-name>
@@ -150,7 +150,7 @@ pass the `--minimum-access-level` flag with the specified access level.
     USAGE: swift doc coverage [<inputs> ...] [--output <output>]
 
     ARGUMENTS:
-      <inputs>                One or more paths to Swift files 
+      <inputs>                One or more paths to a directory containing Swift files.
 
     OPTIONS:
       -o, --output <output>   The path for generated report 
@@ -202,7 +202,7 @@ please reach out by [opening an Issue][open an issue]!
     USAGE: swift doc diagram [<inputs> ...]
 
     ARGUMENTS:
-      <inputs>                One or more paths to Swift files 
+      <inputs>                One or more paths to a directory containing Swift files.
 
     OPTIONS:
       --minimum-access-level <minimum-access-level>

Sources/swift-doc/Subcommands/Coverage.swift

@@ -6,7 +6,7 @@ import SwiftDoc
 extension SwiftDoc {
     struct Coverage: ParsableCommand {
         struct Options: ParsableArguments {
-            @Argument(help: "One or more paths to Swift files")
+            @Argument(help: "One or more paths to a directory containing Swift files.")
             var inputs: [String]
 
             @Option(name: .shortAndLong,

Sources/swift-doc/Subcommands/Diagram.swift

@@ -7,7 +7,7 @@ import GraphViz
 extension SwiftDoc {
     struct Diagram: ParsableCommand {
         struct Options: ParsableArguments {
-            @Argument(help: "One or more paths to Swift files")
+            @Argument(help: "One or more paths to a directory containing Swift files.")
             var inputs: [String]
 
             @Option(name: .long,

Sources/swift-doc/Subcommands/Generate.swift

@@ -17,7 +17,7 @@ extension SwiftDoc {
     }
 
     struct Options: ParsableArguments {
-      @Argument(help: "One or more paths to Swift files")
+      @Argument(help: "One or more paths to a directory containing Swift files.")
       var inputs: [String]
 
       @Option(name: [.long, .customShort("n")],
@@ -47,6 +47,15 @@ extension SwiftDoc {
     var options: Options
 
     func run() throws {
+      for directory in options.inputs {
+        var isDirectory: ObjCBool = false
+        if !FileManager.default.fileExists(atPath: directory, isDirectory: &isDirectory) {
+          logger.warning("Input path \(directory) does not exist.")
+        } else if !isDirectory.boolValue {
+          logger.warning("Input path \(directory) is not a directory.")
+        }
+      }
+
       let module = try Module(name: options.moduleName, paths: options.inputs)
       let baseURL = options.baseURL