Add subcommands

Package.swift

@@ -10,7 +10,9 @@ let package = Package(
         // 💧 A server-side Swift web framework.
         .package(url: "https://github.com/vapor/vapor.git", from: "5.0.0-beta.4"),
         // 📝 Customizable logging to the console.
-        .package(url: "https://github.com/vapor/console-kit.git", from: "5.0.0-beta"),{{#fluent}}
+        .package(url: "https://github.com/vapor/console-kit.git", from: "5.0.0-beta"),
+        // 🖥️ Straightforward, type-safe argument parsing for Swift.
+        .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.8.2"),{{#fluent}}
         // 📖 API package for reading configuration.
         .package(url: "https://github.com/apple/swift-configuration.git", from: "1.2.2"),
         // 🗄 An ORM for SQL and NoSQL databases.
@@ -27,6 +29,7 @@ let package = Package(
                 .product(name: "Fluent{{fluent.db.module}}Driver", package: "fluent-{{fluent.db.url}}-driver"),{{/fluent}}
                 .product(name: "Vapor", package: "vapor"),
                 .product(name: "ConsoleLogger", package: "console-kit"),
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
             ],
             swiftSettings: swiftSettings
         ),

Sources/App/Commands/Migrate.swift

@@ -0,0 +1,32 @@
+import ArgumentParser
+import Configuration
+import ConsoleLogger
+import Logging
+import Vapor
+
+struct Migrate: AsyncParsableCommand {
+    static let configuration = CommandConfiguration(abstract: "Prepare or revert your database migrations.")
+
+    @Flag var revert = false
+
+    /// Captures all unrecognized command-line arguments
+    /// for compatibility with other libraries that use Swift Configuration.
+    /// You don't need to pass them to your `ConfigReader`, it will automatically pick them up.
+    @Argument(parsing: .allUnrecognized, help: .private)
+    var other: [String] = []
+
+    mutating func run() async throws {
+        try await withLogger(.init(label: "vapor.logger.migrate")) { _ in
+            // `@Flag`s from ArgumentParser are ignored,
+            // they are used only for the `--help` screen.
+            let config = ConfigReader(providers: [
+                CommandLineArgumentsProvider(),
+                EnvironmentVariablesProvider(),
+            ])
+            ConsoleLogger.bootstrapWithConfigReader(config: config)
+            let app = try Application(configReader: config)
+            print("🚧 Work in progress 🚧")
+            try await app.shutdown()
+        }
+    }
+}

Sources/App/Commands/Routes.swift

@@ -0,0 +1,29 @@
+import ArgumentParser
+import Configuration
+import ConsoleLogger
+import Logging
+import Vapor
+
+struct Routes: AsyncParsableCommand {
+    static let configuration = CommandConfiguration(abstract: "Displays all registered routes.")
+
+    /// Captures all unrecognized command-line arguments
+    /// for compatibility with other libraries that use Swift Configuration.
+    /// You don't need to pass them to your `ConfigReader`, it will automatically pick them up.
+    @Argument(parsing: .allUnrecognized, help: .private)
+    var other: [String] = []
+
+    mutating func run() async throws {
+        try await withLogger(.init(label: "vapor.logger.routes")) { _ in
+            let config = ConfigReader(providers: [
+                CommandLineArgumentsProvider(),
+                EnvironmentVariablesProvider(),
+            ])
+            ConsoleLogger.bootstrapWithConfigReader(config: config)
+            let app = try Application(configReader: config)
+            try await configure(app)
+            print(app.routesASCIITable())
+            try await app.shutdown()
+        }
+    }
+}

Sources/App/Commands/Serve.swift

@@ -0,0 +1,49 @@
+import ArgumentParser
+import Configuration
+import ConsoleLogger
+import Logging
+import Vapor
+
+struct Serve: AsyncParsableCommand {
+    static let configuration = CommandConfiguration(abstract: "Begins serving the app over HTTP.")
+
+    @Option(help: "The hostname the server will run on.")
+    var hostname: String?
+
+    @Option(help: "The port the server will run on.")
+    var port: Int?
+
+    @Option(help: "Convenience for setting hostname and port together, in the format `hostname:port`.")
+    var bind: String?
+
+    @Option(help: "The path for the Unix domain socket file the server will bind to.")
+    var socketPath: String?
+
+    /// Captures all unrecognized command-line arguments
+    /// for compatibility with other libraries that use Swift Configuration.
+    /// You don't need to pass them to your `ConfigReader`, it will automatically pick them up.
+    @Argument(parsing: .allUnrecognized, help: .private)
+    var other: [String] = []
+
+    mutating func run() async throws {
+        try await withLogger(.init(label: "vapor.logger")) { _ in
+            // `@Option`s from ArgumentParser are ignored,
+            // they are used only for the `--help` screen.
+            let config = ConfigReader(providers: [
+                CommandLineArgumentsProvider(),
+                EnvironmentVariablesProvider(),
+            ])
+            ConsoleLogger.bootstrapWithConfigReader(config: config)
+
+            let app = try Application(configReader: config)
+            do {
+                try await configure(app)
+                try await app.run()
+                try await app.shutdown()
+            } catch {
+                try? await app.shutdown()
+                throw error
+            }
+        }
+    }
+}

Sources/App/configure.swift

@@ -16,11 +16,11 @@ func configure(_ app: Application) async throws {
     databases.use(
         DatabaseConfigurationFactory.postgres(
             configuration: .init(
-                hostname: databaseConfig.string(forKey: "host", default: "localhost"),
-                port: databaseConfig.int(forKey: "port", default: SQLPostgresConfiguration.ianaPortNumber),
-                username: databaseConfig.string(forKey: "username", default: "vapor_username"),
-                password: databaseConfig.string(forKey: "password", default: "vapor_password"),
-                database: databaseConfig.string(forKey: "name", default: "vapor_database"),
+                hostname: databaseConfig.string(forKey: "host", isSecret: true, default: "localhost"),
+                port: databaseConfig.int(forKey: "port", isSecret: true, default: SQLPostgresConfiguration.ianaPortNumber),
+                username: databaseConfig.string(forKey: "username", isSecret: true, default: "vapor_username"),
+                password: databaseConfig.string(forKey: "password", isSecret: true, default: "vapor_password"),
+                database: databaseConfig.string(forKey: "name", isSecret: true, default: "vapor_database"),
                 tls: .prefer(try .init(configuration: .clientDefault))
             )
         ),
@@ -29,11 +29,11 @@ func configure(_ app: Application) async throws {
 
     databases.use(
         DatabaseConfigurationFactory.mysql(
-            hostname: databaseConfig.string(forKey: "host", default: "localhost"),
-            port: databaseConfig.int(forKey: "port", default: MySQLConfiguration.ianaPortNumber),
-            username: databaseConfig.string(forKey: "username", default: "vapor_username"),
-            password: databaseConfig.string(forKey: "password", default: "vapor_password"),
-            database: databaseConfig.string(forKey: "name", default: "vapor_database")
+            hostname: databaseConfig.string(forKey: "host", isSecret: true, default: "localhost"),
+            port: databaseConfig.int(forKey: "port", isSecret: true, default: MySQLConfiguration.ianaPortNumber),
+            username: databaseConfig.string(forKey: "username", isSecret: true, default: "vapor_username"),
+            password: databaseConfig.string(forKey: "password", isSecret: true, default: "vapor_password"),
+            database: databaseConfig.string(forKey: "name", isSecret: true, default: "vapor_database")
         ),
         as: .mysql
     ){{/fluent.db.is_mysql}}{{#fluent.db.is_sqlite}}databases.use(DatabaseConfigurationFactory.sqlite(.file("db.sqlite")), as: .sqlite){{/fluent.db.is_sqlite}}

Sources/App/entrypoint.swift

@@ -1,27 +1,18 @@
+import ArgumentParser
 import Configuration
 import ConsoleLogger
 import Logging
 import Vapor
 
 @main
-enum Entrypoint {
-    static func main() async throws {
-        try await withLogger(.init(label: "vapor5.logger")) { _ in
-            let config = ConfigReader(providers: [
-                CommandLineArgumentsProvider(),
-                EnvironmentVariablesProvider(),
-            ])
-            ConsoleLogger.bootstrapWithConfigReader(config: config)
-
-            let app = try Application(configReader: config)
-            do {
-                try await configure(app)
-                try await app.run()
-                try await app.shutdown()
-            } catch {
-                try? await app.shutdown()
-                throw error
-            }
-        }
-    }
+struct Entrypoint: AsyncParsableCommand {
+    static let configuration = CommandConfiguration(
+        commandName: "{{name}}",
+        subcommands: [
+            Serve.self,
+            Routes.self,{{#fluent}}
+            Migrate.self,{{/fluent}}
+        ],
+        defaultSubcommand: Serve.self
+    )
 }

Tests/AppTests/AppTrait.swift

@@ -26,23 +26,23 @@ struct AppTrait: TestTrait, SuiteTrait, TestScoping {
             databases.use(
                 DatabaseConfigurationFactory.postgres(
                     configuration: .init(
-                        hostname: databaseConfig.string(forKey: "host", default: "localhost"),
-                        port: databaseConfig.int(forKey: "port", default: SQLPostgresConfiguration.ianaPortNumber),
-                        username: databaseConfig.string(forKey: "username", default: "vapor_username"),
-                        password: databaseConfig.string(forKey: "password", default: "vapor_password"),
-                        database: databaseConfig.string(forKey: "name", default: "vapor_database"),
+                        hostname: databaseConfig.string(forKey: "host", isSecret: true, default: "localhost"),
+                        port: databaseConfig.int(forKey: "port", isSecret: true, default: SQLPostgresConfiguration.ianaPortNumber),
+                        username: databaseConfig.string(forKey: "username", isSecret: true, default: "vapor_username"),
+                        password: databaseConfig.string(forKey: "password", isSecret: true, default: "vapor_password"),
+                        database: databaseConfig.string(forKey: "name", isSecret: true, default: "vapor_database"),
                         tls: .prefer(try .init(configuration: .clientDefault))
                     )
                 ),
                 as: .psql
             ){{/fluent.db.is_postgres}}{{#fluent.db.is_mysql}}let databaseConfig = application.configReader.scoped(to: "database")
             databases.use(
                 DatabaseConfigurationFactory.mysql(
-                    hostname: databaseConfig.string(forKey: "host", default: "localhost"),
-                    port: databaseConfig.int(forKey: "port", default: MySQLConfiguration.ianaPortNumber),
-                    username: databaseConfig.string(forKey: "username", default: "vapor_username"),
-                    password: databaseConfig.string(forKey: "password", default: "vapor_password"),
-                    database: databaseConfig.string(forKey: "name", default: "vapor_database")
+                    hostname: databaseConfig.string(forKey: "host", isSecret: true, default: "localhost"),
+                    port: databaseConfig.int(forKey: "port", isSecret: true, default: MySQLConfiguration.ianaPortNumber),
+                    username: databaseConfig.string(forKey: "username", isSecret: true, default: "vapor_username"),
+                    password: databaseConfig.string(forKey: "password", isSecret: true, default: "vapor_password"),
+                    database: databaseConfig.string(forKey: "name", isSecret: true, default: "vapor_database")
                 ),
                 as: .mysql
             ){{/fluent.db.is_mysql}}{{#fluent.db.is_sqlite}}databases.use(DatabaseConfigurationFactory.sqlite(.file("db.sqlite")), as: .sqlite){{/fluent.db.is_sqlite}}

manifest.yml

@@ -77,6 +77,12 @@ files:
             if: fluent
             files:
               - Databases+Vapor.swift
+          - folder: Commands
+            files:
+              - Serve.swift
+              - Routes.swift
+              - file: Migrate.swift
+                if: fluent
   - folder: Tests
     files:
       - folder: AppTests