SwiftColorGen

A tool that generate code for Swift projects, designed to improve the maintainability of UIColors.

Please notice, this tool still under development. It's on a validation phase, where I'll test it integrated with existing iOS projects to see how useful it is. Feedbacks are appreciated. Also notice this tool not only generates new code, but also updates existing storyboard files, so keep your code under versioning control to avoid any data loss!

Motivation
The solution
Demo
Using the CLI
Installation (CocoaPods)
Contributing
License

Motivation

Manage colors in iOS projects can be challenging. It would be useful to reuse colors in different places in the storyboard and also access them programmatically. In code, you can group the colors in one place, but it's common to have the same color redefined in many places in the storyboards. When you need to update a color, you need to remember to replace them everywhere and because of that, it becomes hard to maintain.

Since Xcode 9, we are able to define a color asset in the Assets catalog, allowing us to reuse a color inside the storyboards and access them programmatically. Though, this still isn't perfect:

To access the colors programmatically, we use a string with the Asset name. If we rename the Asset, we need to remember to replace the strings referring the old asset
If we rename an Asset, we also need to manually replace the references to them in the storyboards
In an existing project with no color assets defined, we need to group all the colors in the storyboards, manually create the asset colors and replace them everywhere.

The solution

SwiftColorGen reads all storyboard files to find common colors, it creates them in a .xcassets folder (without any duplications) and refer them back in the storyboard. Then, it creates an UIColor extension allowing to access the same colors programmatically. It automatically puts a name to the colors found. The name will be the closest webcolor name, measuring the color distance between them. But, the user still can rename the colors and it will keep the storyboards updated.

The rules for naming the colors dinamically:

The closest web color name (https://en.wikipedia.org/wiki/Web_colors) is considered to name the color
If the alpha value is less than 255, an "alpha suffix" will be appended to the color name, to avoid name collision
If two RGB's are close to the same web color, the name still will be used if they have different alphas
If two RGB's are close to the same web color and they also have the same alpha, the hex of the RGB will be used to avoid name collision

SwiftColorGen is written in Swift and requires Swift to run. These are the dependencies:

AEXML (to read and write XML)
CommandLine (to provide the command line interface)
SwiftColorGenLibrary (the core of the tool, placed in a separated repo)

Demo

That's the result of the code generation:

Collecting the colors on Storyboard and generating the Assets

Generating the Swift file

Automatic renaming

Custom colors + multiple replace

Code generated

The tool should generate something like:

// Don't change. Auto generated file. SwiftColorGen
import UIKit

extension UIColor {
    /// Color #FFC034 (alpha 255)
    static var goldColor: UIColor {
        return UIColor(named: "Gold") ?? .clear
    }

    /// Color #8D00FF (alpha 255)
    static var darkVioletColor: UIColor {
        return UIColor(named: "DarkViolet") ?? .clear
    }

    /// Color #00FF00 (alpha 255)
    static var myCoolGreen: UIColor {
        return UIColor(named: "MyCoolGreen") ?? .clear
    }
}

You will probably want to rename the color and run the tool again, but you can just create another extension on another file referring the generated code:

extension UIColor {
    static var myTextColor: UIColor {
        return .darkVioletColor
    }
}

Here a complete video with the tool in action:

Using the CLI

First, install the dependencies:

$ swift package update

Build it:

$ swift build

Then run passing the appropriate parameters (if you prefer, you can also use the binary generated inside the .build folder):

Usage: swift run SwiftColorGen [options]
-o --outputFile (required):
    Path to the output Swift file
-b --baseFolder (optional):
    Path to the folder where the storyboards are located. Defaults to the current working directory
-a --assetsFolder (optional):
    Path to the assets folder. Defaults to the first .xcassets found under the base folder

Example:

$ swift run SwiftColorGen -o Example/Generated.swift

Notice that OS X 10.12 is required to run, because of a dependency from a NSColor method (used to convert between different color spaces)

Installation

You can install the tool using CocoaPods and then add a Build Phase step, that runs SwiftColorGen every time the project is built.

CocoaPods

CocoaPods is a dependency manager for Cocoa projects.

To integrate SwiftColorGen into your Xcode project, specify it in your Podfile:

pod 'SwiftColorGen'

Install the dependencies:

$ pod install

In Xcode: Click on your project in the file list, choose your target under TARGETS, click the Build Phases tab and add a New Run Script Phase by clicking the little plus icon in the top left. Drag the New Run Script Phase above the Compile Sources phase and below Check Pods Manifest.lock, expand it and then call the tool with something like that:

"$PODS_ROOT/SwiftColorGen/swiftcg" -b "$SRCROOT" -o "$SRCROOT/CustomColors.swift"

Build your project and it's done. Remember to add the generated Swift file to Xcode, if it's not already there.

Contributing

This project still on a initial stage of development. Feel free to contribute by testing it and reporting bugs. If you want to help developing it, checkout the issues section. If you fixed some issue or made some enhancement, open a pull request.

License

SwiftColorGen is available under the MIT license. See the LICENSE file for more info.

fernandodelrio/SwiftColorGen

fernandodelrio

Reviews

Repository Details