Skip to content

Commit 7631435

Browse files
marinofaggianamarinofaggiana
committed
added parameter consoleOnly
1 parent 7d8bd66 commit 7631435

2 files changed

Lines changed: 41 additions & 37 deletions

File tree

‎Sources/NextcloudKit/Log/NKLog.swift‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,43 +8,43 @@ import Foundation
88
// These functions internally use `NKLogFileManager.shared`.
99

1010
@inlinable
11-
public func nkLog(debug message: String, minimumLogLevel: NKLogLevel = .compact) {
12-
NKLogFileManager.shared.writeLog(debug: message, minimumLogLevel: minimumLogLevel)
11+
public func nkLog(debug message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
12+
NKLogFileManager.shared.writeLog(debug: message, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
1313
}
1414

1515
@inlinable
16-
public func nkLog(info message: String, minimumLogLevel: NKLogLevel = .compact) {
17-
NKLogFileManager.shared.writeLog(info: message, minimumLogLevel: minimumLogLevel)
16+
public func nkLog(info message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
17+
NKLogFileManager.shared.writeLog(info: message, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
1818
}
1919

2020
@inlinable
21-
public func nkLog(warning message: String, minimumLogLevel: NKLogLevel = .compact) {
22-
NKLogFileManager.shared.writeLog(warning: message, minimumLogLevel: minimumLogLevel)
21+
public func nkLog(warning message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
22+
NKLogFileManager.shared.writeLog(warning: message, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
2323
}
2424

2525
@inlinable
26-
public func nkLog(error message: String, minimumLogLevel: NKLogLevel = .compact) {
27-
NKLogFileManager.shared.writeLog(error: message, minimumLogLevel: minimumLogLevel)
26+
public func nkLog(error message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
27+
NKLogFileManager.shared.writeLog(error: message, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
2828
}
2929

3030
@inlinable
31-
public func nkLog(success message: String, minimumLogLevel: NKLogLevel = .compact) {
32-
NKLogFileManager.shared.writeLog(success: message, minimumLogLevel: minimumLogLevel)
31+
public func nkLog(success message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
32+
NKLogFileManager.shared.writeLog(success: message, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
3333
}
3434

3535
@inlinable
36-
public func nkLog(network message: String, minimumLogLevel: NKLogLevel = .compact) {
37-
NKLogFileManager.shared.writeLog(network: message, minimumLogLevel: minimumLogLevel)
36+
public func nkLog(network message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
37+
NKLogFileManager.shared.writeLog(network: message, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
3838
}
3939

4040
@inlinable
41-
public func nkLog(start message: String, minimumLogLevel: NKLogLevel = .compact) {
42-
NKLogFileManager.shared.writeLog(start: message, minimumLogLevel: minimumLogLevel)
41+
public func nkLog(start message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
42+
NKLogFileManager.shared.writeLog(start: message, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
4343
}
4444

4545
@inlinable
46-
public func nkLog(stop message: String, minimumLogLevel: NKLogLevel = .compact) {
47-
NKLogFileManager.shared.writeLog(stop: message, minimumLogLevel: minimumLogLevel)
46+
public func nkLog(stop message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
47+
NKLogFileManager.shared.writeLog(stop: message, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
4848
}
4949

5050
/// Logs a custom tagged message.
@@ -53,6 +53,6 @@ public func nkLog(stop message: String, minimumLogLevel: NKLogLevel = .compact)
5353
/// - emoji: the type tag .info, .debug, .warning, .error, .success ..
5454
/// - message: The message to log.
5555
@inlinable
56-
public func nkLog(tag: String, emoji: NKLogTagEmoji = .debug, message: String, minimumLogLevel: NKLogLevel = .compact) {
57-
NKLogFileManager.shared.writeLog(tag: tag, emoji: emoji, message: message, minimumLogLevel: minimumLogLevel)
56+
public func nkLog(tag: String, emoji: NKLogTagEmoji = .debug, message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
57+
NKLogFileManager.shared.writeLog(tag: tag, emoji: emoji, message: message, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
5858
}

‎Sources/NextcloudKit/Log/NKLogFileManager.swift‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -150,48 +150,48 @@ public final class NKLogFileManager: @unchecked Sendable {
150150

151151
// MARK: - Public API
152152

153-
public func writeLog(debug message: String, minimumLogLevel: NKLogLevel = .compact) {
154-
writeLog("[DEBUG] \(message)", minimumLogLevel: minimumLogLevel)
153+
public func writeLog(debug message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
154+
writeLog("[DEBUG] \(message)", minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
155155
}
156156

157-
public func writeLog(info message: String, minimumLogLevel: NKLogLevel = .compact) {
158-
writeLog("[INFO] \(message)", minimumLogLevel: minimumLogLevel)
157+
public func writeLog(info message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
158+
writeLog("[INFO] \(message)", minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
159159
}
160160

161-
public func writeLog(warning message: String, minimumLogLevel: NKLogLevel = .compact) {
162-
writeLog("[WARNING] \(message)", minimumLogLevel: minimumLogLevel)
161+
public func writeLog(warning message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
162+
writeLog("[WARNING] \(message)", minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
163163
}
164164

165-
public func writeLog(error message: String, minimumLogLevel: NKLogLevel = .compact) {
166-
writeLog("[ERROR] \(message)", minimumLogLevel: minimumLogLevel)
165+
public func writeLog(error message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
166+
writeLog("[ERROR] \(message)", minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
167167
}
168168

169-
public func writeLog(success message: String, minimumLogLevel: NKLogLevel = .compact) {
170-
writeLog("[SUCCESS] \(message)", minimumLogLevel: minimumLogLevel)
169+
public func writeLog(success message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
170+
writeLog("[SUCCESS] \(message)", minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
171171
}
172172

173-
public func writeLog(network message: String, minimumLogLevel: NKLogLevel = .compact) {
174-
writeLog("[NETWORK] \(message)", minimumLogLevel: minimumLogLevel)
173+
public func writeLog(network message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
174+
writeLog("[NETWORK] \(message)", minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
175175
}
176176

177-
public func writeLog(start message: String, minimumLogLevel: NKLogLevel = .compact) {
178-
writeLog("[START] \(message)", minimumLogLevel: minimumLogLevel)
177+
public func writeLog(start message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
178+
writeLog("[START] \(message)", minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
179179
}
180180

181-
public func writeLog(stop message: String, minimumLogLevel: NKLogLevel = .compact) {
182-
writeLog("[STOP] \(message)", minimumLogLevel: minimumLogLevel)
181+
public func writeLog(stop message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
182+
writeLog("[STOP] \(message)", minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
183183
}
184184

185185
/// Writes a tagged log message with a specific log level.
186186
/// - Parameters:
187187
/// - tag: A custom tag to classify the log message (e.g. "SYNC", "AUTH").
188188
/// - emoji: .info, .debug, .warning, .error, .success ..
189189
/// - message: The log message content.
190-
public func writeLog(tag: String, emoji: NKLogTagEmoji, message: String, minimumLogLevel: NKLogLevel = .compact) {
190+
public func writeLog(tag: String, emoji: NKLogTagEmoji, message: String, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
191191
guard !tag.isEmpty else { return }
192192

193193
let taggedMessage = "[\(tag.uppercased())] \(message)"
194-
writeLog(taggedMessage, emoji: emoji, minimumLogLevel: minimumLogLevel)
194+
writeLog(taggedMessage, emoji: emoji, minimumLogLevel: minimumLogLevel, consoleOnly: consoleOnly)
195195
}
196196

197197
/// Writes a log message with an optional typeTag to determine console emoji.
@@ -201,7 +201,7 @@ public final class NKLogFileManager: @unchecked Sendable {
201201
/// - Parameters:
202202
/// - message: The log message to record.
203203
/// - emoji: Optional type to determine console emoji (e.g. [INFO], [ERROR]).
204-
public func writeLog(_ message: String?, emoji: NKLogTagEmoji? = nil, minimumLogLevel: NKLogLevel = .compact) {
204+
public func writeLog(_ message: String?, emoji: NKLogTagEmoji? = nil, minimumLogLevel: NKLogLevel = .compact, consoleOnly: Bool = false) {
205205
guard logLevel != .disabled,
206206
let message = message else {
207207
return
@@ -226,6 +226,10 @@ public final class NKLogFileManager: @unchecked Sendable {
226226
let consoleLine = "[NKLOG] [\(consoleTimestamp)] \(emoji)\(visualMessage)"
227227
print(consoleLine)
228228

229+
if consoleOnly {
230+
return
231+
}
232+
229233
rotationQueue.sync {
230234
self.checkForRotation()
231235
}

0 commit comments

Comments
 (0)