GitHub - robbiehanson/XcodeColors: XcodeColors allows you to use colors in the Xcode debugging console. It's designed to aid in the debugging process. (original) (raw)

XcodeColors allows you to use colors in the Xcode debugging console.
It's designed to aid in the debugging process. For example:

You're not limited to a restricted color palate.
You can specify, in your source code, the exact RGB values you'd like to use.
You can specify foreground and/or background color(s).

XcodeColors is a simple plugin for Xcode 3, 4, 5, 6 & 7

XcodeColors installation instructions for Xcode 4, 5, 6 & 7:

Did you upgrade Xcode and now XcodeColors is "broken"? Get the fix here: XcodeUpdates.

XcodeColors installation instructions for Xcode 3:

Wow, you're still running Xcode 3?

See this page for installation instructions:
http://deepitpro.com/en/articles/XcodeColors/info/index.shtml

How to use XcodeColors

There are 3 ways to use XcodeColors:

  1. Manually specify the colors inside NSLog (or create custom macros)
  2. Use CocoaLumberjack (for Objective-C & Swift projects)
  3. Use CleanroomLogger (for Swift projects)

Option 1: Manual Use / Custom Macros

#define XCODE_COLORS_ESCAPE @"\033["
#define XCODE_COLORS_RESET_FG XCODE_COLORS_ESCAPE @"fg;" // Clear any foreground color
#define XCODE_COLORS_RESET_BG XCODE_COLORS_ESCAPE @"bg;" // Clear any background color
#define XCODE_COLORS_RESET XCODE_COLORS_ESCAPE @";" // Clear any foreground or background color
To manually colorize your log statements, you surround the log statements with the color options:
NSLog(XCODE_COLORS_ESCAPE @"fg0,0,255;" @"Blue text" XCODE_COLORS_RESET);
NSLog(XCODE_COLORS_ESCAPE @"bg220,0,0;" @"Red background" XCODE_COLORS_RESET);
NSLog(XCODE_COLORS_ESCAPE @"fg0,0,255;"
XCODE_COLORS_ESCAPE @"bg220,0,0;"
@"Blue text on red background"
XCODE_COLORS_RESET);
NSLog(XCODE_COLORS_ESCAPE @"fg209,57,168;" @"You can supply your own RGB values!" XCODE_COLORS_RESET);

#define LogBlue(frmt, ...) NSLog((XCODE_COLORS_ESCAPE @"fg0,0,255;" frmt XCODE_COLORS_RESET), ##VA_ARGS)
#define LogRed(frmt, ...) NSLog((XCODE_COLORS_ESCAPE @"fg255,0,0;" frmt XCODE_COLORS_RESET), ##VA_ARGS)
And then you could just replace NSLog with LogBlue like so:
LogBlue(@"Configuring sprocket...");
LogRed(@"Sprocket error: %@", error);

And then you can log within a Swift method like so:

```Swift
ColorLog.red("This is a log.")
ColorLog.blue("Number one hundred: \(100).")

```

Option 2: CocoaLumberjack

The CocoaLumberjack framework natively supports XcodeColors!
Lumberjack is a fast & simple, yet powerful & flexible logging framework for Mac and iOS.

From its GitHub page:

Lumberjack is similar in concept to other popular logging frameworks such as log4j, yet is designed specifically for Objective-C, and takes advantage of features such as multi-threading, grand central dispatch (if available), lockless atomic operations, and the dynamic nature of the Objective-C runtime.

In most cases it is an order of magnitude faster than NSLog.

It's super easy to use XcodeColors with Lumberjack!

And if color isn't available (e.g. XcodeColors isn't installed), then the framework just automatically does the right thing. So if you install XcodeColors on your machine, and enable colors in your team project, your teammates (without XcodeColors... yet) won't suffer, or even notice.

Plus Lumberjack colors automatically work if you run your application from within a terminal! (E.g. Terminal.app, not Xcode) If your terminal supports color (xterm-color or xterm-256color) like the Terminal.app in Lion, then Lumberjack automatically maps your color customizations to the closest available color supported by the shell!

// Enable XcodeColors setenv("XcodeColors", "YES", 0);

// Standard lumberjack initialization [DDLog addLogger:[DDTTYLogger sharedInstance]];

// And then enable colors [[DDTTYLogger sharedInstance] setColorsEnabled:YES];

// Check out default colors: // Error : Red // Warn : Orange

DDLogError(@"Paper jam"); // Red DDLogWarn(@"Toner is low"); // Orange DDLogInfo(@"Warming up printer (pre-customization)"); // Default (black) DDLogVerbose(@"Intializing protcol x26"); // Default (black)

// Now let's do some customization: // Info : Pink

#if TARGET_OS_IPHONE UIColor *pink = [UIColor colorWithRed:(255/255.0) green:(58/255.0) blue:(159/255.0) alpha:1.0]; #else NSColor *pink = [NSColor colorWithCalibratedRed:(255/255.0) green:(58/255.0) blue:(159/255.0) alpha:1.0]; #endif

[[DDTTYLogger sharedInstance] setForegroundColor:pink backgroundColor:nil forFlag:DDLogFlagInfo];

DDLogInfo(@"Warming up printer (post-customization)"); // Pink !

Option 3: CleanroomLogger

CleanroomLogger is a popular pure-Swift logging API for iOS, Mac OS X, tvOS and watchOS that is designed to be simple, extensible, lightweight and performant.

CleanroomLogger is a real console logger, meaning that it writes to the Apple System Log (ASL) facility and not just to standard output.

XcodeColors support is included in CleanroomLogger, and by default, when the XcodeColors environment variable is set to YES, CleanroomLogger will colorize log output based on the severity of the message:

CleanroomLogger's default XcodeColors log severity colorization

Let's say you had an AppDelegate.swift file with an import CleanroomLogger statement and the lines:

Log.verbose?.trace() Log.debug?.value(self) Log.info?.message("These pretzels are making me thirsty") Log.warning?.message("The ocean called, they're running out of shrimp!") Log.error?.message("The database connection failed")

With CleanroomLogger and XcodeColors, you would see colorized log output looking something like:

CleanroomLogger code example

CleanroomLogger lets developers supply their own ColorTable to customize the default color scheme. Default colorization can also be turned off entirely, and an XcodeColorsColorizer instance can be used to manually apply XcodeColors escape sequences to strings.

For further details, visit the CleanroomLogger API documentation.