GitHub/SwiftFormat
1
0
Fork 0
mirror of https://github.com/nicklockwood/SwiftFormat.git synced 2026-06-16 10:34:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added --quiet mode

Browse Source
This commit is contained in:
Nick Lockwood
2018-09-05 10:24:42 +01:00
parent 32a6fef424
commit 89971bb463
3 changed files with 77 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Sources/Arguments.swift
+1
View File
@@ -428,6 +428,7 @@ let commandLineArguments = [
"output",
"cache",
"verbose",
"quiet",
"dryrun",
"lint",
// Misc
Sources/CommandLine.swift
+47 -28
View File
@@ -64,8 +64,11 @@ public struct CLI {
}
}
private var quietMode = false
private func print(_ message: String, as type: CLI.OutputType = .info) {
CLI.print(message, type)
if !quietMode || [.content, .error].contains(type) {
CLI.print(message, type)
}
}
private func printWarnings(_ errors: [Error]) {
@@ -81,9 +84,9 @@ public enum ExitCode: Int32 {
case error = 70 // EX_SOFTWARE
}
func printHelp() {
func printHelp(as type: CLI.OutputType) {
print("")
print("""
swiftformat, version \(version)
copyright (c) 2016 Nick Lockwood
@@ -105,6 +108,7 @@ func printHelp() {
--conflictmarkers merge conflict markers, either "reject" (default) or "ignore"
--cache path to cache file, or "clear" or "ignore" the default cache
--verbose display detailed formatting output and warnings/errors
--quiet disables non-critical output messages and warnings
--dryrun run in "dry" mode (without actually changing any files)
--lint returns non-zero exit code if files would be changed
@@ -147,8 +151,8 @@ func printHelp() {
--trimwhitespace trim trailing space. "always" (default) or "nonblank-lines"
--wraparguments wrap function args. "beforefirst", "afterfirst", "preserve"
--wrapcollections wrap array/dict. "beforefirst", "afterfirst", "preserve"
""")
""", as: type)
print("")
}
func timeEvent(block: () throws -> Void) rethrows -> TimeInterval {
@@ -171,7 +175,7 @@ private func serializeOptions(_ options: Options, to outputURL: URL?) throws {
throw FormatError.writing("failed to write options to \(outputURL.path)")
}
} else {
print(serialize(options: options, excludingDefaults: true, separator: " "))
print(serialize(options: options, excludingDefaults: true, separator: " "), as: .content)
print("")
}
}
@@ -182,8 +186,14 @@ func processArguments(_ args: [String], in directory: String) -> ExitCode {
var dryrun = false
var lint = false
quietMode = false
defer {
// Reset quiet mode on exit to prevent side-effects between unit tests
quietMode = false
}
func printRunningMessage() {
print("running swiftformat...")
print("running swiftformat...", as: .info)
if lint {
print("(lint mode - no files will be changed)", as: .warning)
} else if dryrun {
@@ -195,16 +205,19 @@ func processArguments(_ args: [String], in directory: String) -> ExitCode {
// Get arguments
var args = try preprocessArguments(args, commandLineArguments)
// Show help
if args["help"] != nil {
printHelp()
return .ok
// Input path(s)
var inputURLs = [URL]()
while let inputPath = args[String(inputURLs.count + 1)] {
inputURLs += try parsePaths(inputPath, for: "input", in: directory)
}
// Show version
if args["version"] != nil {
print("swiftformat, version \(version)")
return .ok
// Quiet mode
if let arg = args["quiet"] {
quietMode = true
if !arg.isEmpty {
// quiet doesn't take an argument, so treat argument as another input path
inputURLs += try parsePaths(arg, for: "input", in: directory)
}
}
// Warnings
@@ -212,6 +225,18 @@ func processArguments(_ args: [String], in directory: String) -> ExitCode {
print(warning, as: .warning)
}
// Show help
if args["help"] != nil {
printHelp(as: .content)
return .ok
}
// Show version
if args["version"] != nil {
print("swiftformat, version \(version)", as: .content)
return .ok
}
// Display rules (must be checked before merging config)
let showRules: Bool = args["rules"].map {
if $0 == "" {
@@ -253,7 +278,7 @@ func processArguments(_ args: [String], in directory: String) -> ExitCode {
print("")
let rules = options.rules ?? allRules.subtracting(FormatRules.disabledByDefault)
for name in Array(allRules).sorted() {
print(" \(name)\(rules.contains(name) ? "" : " (disabled)")")
print(" \(name)\(rules.contains(name) ? "" : " (disabled)")", as: .content)
}
print("")
return .ok
@@ -265,12 +290,6 @@ func processArguments(_ args: [String], in directory: String) -> ExitCode {
overrides[key] = args[key]
}
// Input path(s)
var inputURLs = [URL]()
while let inputPath = args[String(inputURLs.count + 1)] {
inputURLs += try parsePaths(inputPath, for: "input", in: directory)
}
// Verbose
if let arg = args["verbose"] {
verbose = true
@@ -279,7 +298,7 @@ func processArguments(_ args: [String], in directory: String) -> ExitCode {
inputURLs += try parsePaths(arg, for: "input", in: directory)
}
if inputURLs.isEmpty, args["output"] ?? "" != "" {
throw FormatError.options("--verbose option has no effect unless an output file is specified")
print("--verbose option has no effect unless an output file is specified", as: .warning)
}
}
@@ -322,7 +341,7 @@ func processArguments(_ args: [String], in directory: String) -> ExitCode {
inputURLs += try parsePaths(arg, for: "input", in: directory)
}
if inputURLs.count > 0 {
print("inferring swiftformat options from source file(s)...")
print("inferring swiftformat options from source file(s)...", as: .info)
var filesParsed = 0, formatOptions = FormatOptions.default, errors = [Error]()
let fileOptions = options.fileOptions ?? .default
let time = formatTime(timeEvent {
@@ -343,7 +362,7 @@ func processArguments(_ args: [String], in directory: String) -> ExitCode {
break
}
}
print("options inferred from \(filesParsed)/\(filesChecked) files in \(time)")
print("options inferred from \(filesParsed)/\(filesChecked) files in \(time)", as: .info)
print("")
var options = options
options.formatOptions = formatOptions
@@ -453,7 +472,7 @@ func processArguments(_ args: [String], in directory: String) -> ExitCode {
} else if args["inferoptions"] != nil {
throw FormatError.options("--inferoptions requires one or more input files")
} else {
printHelp()
printHelp(as: .info)
}
return .ok
}
@@ -593,7 +612,7 @@ func processInput(_ inputURLs: [URL],
}
// Logging skipped files
let skippedHandler: FileEnumerationHandler? = verbose ? { inputURL, _, _ in
print("skipping \(inputURL.path)")
print("skipping \(inputURL.path)", as: .info)
print("-- ignored", as: .success)
return {}
} : nil
@@ -627,7 +646,7 @@ func processInput(_ inputURLs: [URL],
}()
do {
if verbose {
print("formatting \(inputURL.path)")
print("formatting \(inputURL.path)", as: .info)
}
var cacheHash: String?
var sourceHash: String?
Tests/CommandLineTests.swift
+29 -4
View File
@@ -74,7 +74,7 @@ class CommandLineTests: XCTestCase {
XCTAssertLessThanOrEqual(line.count, 80, line)
}
}
printHelp()
printHelp(as: .content)
}
func testHelpOptionsImplemented() {
@@ -84,7 +84,7 @@ class CommandLineTests: XCTestCase {
XCTAssertTrue(commandLineArguments.contains(name), name)
}
}
printHelp()
printHelp(as: .content)
}
func testHelpOptionsDocumented() {
@@ -100,7 +100,7 @@ class CommandLineTests: XCTestCase {
}
}
}
printHelp()
printHelp(as: .content)
XCTAssert(arguments.isEmpty, "\(arguments.joined(separator: ","))")
}
@@ -187,7 +187,7 @@ class CommandLineTests: XCTestCase {
XCTAssertNotEqual(computeHash(input), computeHash(output))
}
// MARK: end-to-end tests
// MARK: end-to-end formatting
func testFormatting() {
CLI.print = { _, _ in }
@@ -200,10 +200,35 @@ class CommandLineTests: XCTestCase {
XCTAssertEqual(CLI.run(in: sourceDirectory.path, with: args), .ok)
}
// MARK: rules
func testRulesNotMarkedAsDisabled() {
CLI.print = { message, _ in
XCTAssert(message.contains("trailingClosures") || !message.contains("(disabled)"))
}
XCTAssertEqual(CLI.run(in: sourceDirectory.path, with: "--rules"), .ok)
}
// MARK: quiet mode
func testQuietModeNoOutput() {
CLI.print = { message, _ in
XCTFail(message)
}
XCTAssertEqual(CLI.run(in: sourceDirectory.path, with: "--quiet --dryrun"), .ok)
}
func testQuietModeAllowsContent() {
CLI.print = { message, type in
XCTAssertEqual(type, .content, message)
}
XCTAssertEqual(CLI.run(in: sourceDirectory.path, with: "--quiet --help"), .ok)
}
func testQuietModeAllowsErrors() {
CLI.print = { message, type in
XCTAssertEqual(type, .error, message)
}
XCTAssertEqual(CLI.run(in: sourceDirectory.path, with: "foobar.swift --quiet"), .error)
}
}