Skip to content

Adding a verbose flag for displaying more messages in terminal #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adamjcampbell merged 7 commits into from
Aug 26, 2020
Merged

Adding a verbose flag for displaying more messages in terminal #220

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
59835fa
Adding --quiet flag
csjones Aug 17, 2020
e3739f0
Better help information
csjones Aug 17, 2020
84c8f97
Merge branch 'master' into csjones-quiet
csjones Aug 17, 2020
f3b5c87
Refactored quiet into verbose
csjones Aug 23, 2020
d6b5bea
Created PrintLevel, cleaned up duplicative logic
csjones Aug 26, 2020
d53dae7
Cleanup
csjones Aug 26, 2020
cdb7c32
Fixed swiftlint issues
csjones Aug 26, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion Sources/AppStoreConnectCLI/Commands/Certificates/ListCertificatesCommand.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,10 @@ struct ListCertificatesCommand: CommonParsableCommand {

let file = try certificateProcessor.write($0)

print("📥 Certificate '\($0.name ?? "")' downloaded to: \(file.path)")
// Command output is parsable by default. Only print if user is enabling verbosity or output is a `.table`
if common.verbose || common.outputFormat == .table {
Copy link
Contributor

@adamjcampbell adamjcampbell Aug 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We seem to have to use common.verbose || common.outputFormat == .table quite a bit here.
What do you think about making verbose be Bool? (defaulting to nil) and then we can add a computed var either a Bool or enum to check.

Thinking along these lines:

// CommonParsableCommand.swift

enum PrintLevel {
  case quiet
  case verbose
}

// CommonOptions

var printLevel: PrintLevel {
  switch verbose {
    case true:
      return .verbose
    case false:
      return .quiet
    case nil:
      return common.outputFormat == .table ? .verbose : .quiet
  }
}

// Usage

if common.printLevel == .verbose {
  ...
}

Copy link
Contributor Author

@csjones csjones Aug 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, this is a good suggestion and I'll make these changes with small tweaks. I'll leave verbose as a Bool and I'll resolve the common.outputFormat == .table ternary in the switch statement itself. Should look something like this:

// CommonOptions

var printLevel: PrintLevel {
  switch (verbose, outputFormat == .table) {
    case (true, _), (_, true):
      return .verbose
    case (false, false):
      return .quiet
  }
}

Copy link
Contributor

@adamjcampbell adamjcampbell Aug 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, thanks @csjones

print("📥 Certificate '\($0.name ?? "")' downloaded to: \(file.path)")
}
}
}

Expand Down
5 changes: 4 additions & 1 deletion Sources/AppStoreConnectCLI/Commands/Certificates/ReadCertificateCommand.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,10 @@ struct ReadCertificateCommand: CommonParsableCommand {

let file = try fileProcessor.write(certificate)

print("📥 Certificate '\(certificate.name ?? "")' downloaded to: \(file.path)")
// Command output is parsable by default. Only print if user is enabling verbosity or output is a `.table`
if common.verbose || common.outputFormat == .table {
print("📥 Certificate '\(certificate.name ?? "")' downloaded to: \(file.path)")
}
}

certificate.render(format: common.outputFormat)
Expand Down
7 changes: 5 additions & 2 deletions Sources/AppStoreConnectCLI/Commands/Certificates/RevokeCertificatesCommand.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,11 @@ struct RevokeCertificatesCommand: CommonParsableCommand {
let service = try makeService()
_ = try service.revokeCertificates(serials: serials)

serials.forEach {
print("🚮 Certificate `\($0)` revoked.")
// Command output is parsable by default. Only print if user is enabling verbosity or output is a `.table`
if common.verbose || common.outputFormat == .table {
serials.forEach {
print("🚮 Certificate `\($0)` revoked.")
}
}
}

Expand Down
4 changes: 4 additions & 0 deletions Sources/AppStoreConnectCLI/Commands/CommonParsableCommand.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,8 @@ struct CommonOptions: ParsableArguments {

@Flag(default: .table, help: "Display results in specified format.")
var outputFormat: OutputFormat

/// Used to print status messages. Defaults to `false`, except for `--table`, so all commands are parsable by default.
@Flag(name: .shortAndLong, help: "Display extra messages as command is running.")
var verbose: Bool
}
5 changes: 4 additions & 1 deletion Sources/AppStoreConnectCLI/Commands/Profiles/ListProfilesCommand.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,10 @@ struct ListProfilesCommand: CommonParsableCommand {
try profiles.forEach {
let file = try processor.write($0)

print("📥 Profile '\($0.name!)' downloaded to: \(file.path)")
// Command output is parsable by default. Only print if verbosity is enabled or output is a `.table`
if common.verbose || common.outputFormat == .table {
print("📥 Profile '\($0.name!)' downloaded to: \(file.path)")
}
}
}

Expand Down
3 changes: 2 additions & 1 deletion Sources/AppStoreConnectCLI/Commands/Users/SyncUsersCommand.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ struct SyncUsersCommand: CommonParsableCommand {
var dryRun: Bool

func run() throws {
if dryRun {
// Command output is parsable by default. Only print if user is enabling verbosity or output is a `.table`
if dryRun, common.verbose || common.outputFormat == .table {
print("## Dry run ##")
}

Expand Down
4 changes: 3 additions & 1 deletion Sources/AppStoreConnectCLI/Readers and Renderers/Renderers.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ protocol ResultRenderable: Codable {
extension ResultRenderable {
func renderAsJSON() -> String {
let jsonEncoder = JSONEncoder()
jsonEncoder.outputFormatting = [.prettyPrinted, .sortedKeys]
// Withholding `.prettyPrinted` to maintain output that is parsable by default.
// Consider adding the option `--pretty` if needed https://github.com/ittybittyapps/appstoreconnect-cli/issues/221
jsonEncoder.outputFormatting = [.sortedKeys]
let json = try! jsonEncoder.encode(self) // swiftlint:disable:this force_try
return String(data: json, encoding: .utf8)!
}
Expand Down