diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 961f0ff..36deebd 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,7 +24,7 @@ jobs: head "https://github.com/${{ github.repository }}.git" license "MIT" - depends_on :xcode => ["14.0", :build] + depends_on :xcode => ["12.0", :build] def install system "make", "install", "prefix=#{prefix}" diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 3b150ab..be00eaa 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -5,7 +5,7 @@ on: jobs: BuildAndTest: - runs-on: macos-12 + runs-on: macos-latest steps: - uses: actions/checkout@v1 diff --git a/.swift-version b/.swift-version index 760606e..d346e2a 100644 --- a/.swift-version +++ b/.swift-version @@ -1 +1 @@ -5.7 +5.3 diff --git a/Package.resolved b/Package.resolved index 717a74e..a0484d0 100644 --- a/Package.resolved +++ b/Package.resolved @@ -1,23 +1,25 @@ { - "pins" : [ - { - "identity" : "rbbjson", - "kind" : "remoteSourceControl", - "location" : "https://github.com/robb/RBBJSON", - "state" : { - "branch" : "main", - "revision" : "102c970283e105d7c5be2e29630db29c808c20eb" + "object": { + "pins": [ + { + "package": "RBBJSON", + "repositoryURL": "https://github.com/robb/RBBJSON", + "state": { + "branch": "main", + "revision": "102c970283e105d7c5be2e29630db29c808c20eb", + "version": null + } + }, + { + "package": "swift-argument-parser", + "repositoryURL": "https://github.com/apple/swift-argument-parser", + "state": { + "branch": null, + "revision": "92646c0cdbaca076c8d3d0207891785b3379cbff", + "version": "0.3.1" + } } - }, - { - "identity" : "swift-argument-parser", - "kind" : "remoteSourceControl", - "location" : "https://github.com/apple/swift-argument-parser", - "state" : { - "revision" : "9f39744e025c7d377987f30b03770805dcb0bcd1", - "version" : "1.1.4" - } - } - ], - "version" : 2 + ] + }, + "version": 1 } diff --git a/Package.swift b/Package.swift index 05a09d5..d0b3184 100644 --- a/Package.swift +++ b/Package.swift @@ -1,4 +1,4 @@ -// swift-tools-version:5.7 +// swift-tools-version:5.3 // The swift-tools-version declares the minimum version of Swift required to build this package. import PackageDescription @@ -6,15 +6,21 @@ import PackageDescription let package = Package( name: "MakeColors", platforms: [ - .macOS("12.0"), + .macOS("10.15.4"), ], dependencies: [ - .package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "1.1.4")), - .package(url: "https://github.com/robb/RBBJSON", branch: "main"), + .package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "0.3.1")), + .package(url: "https://github.com/robb/RBBJSON", .branch("main")), ], targets: [ - .executableTarget( + .target( name: "MakeColors", + dependencies: [ + "LibMakeColors", + ] + ), + .target( + name: "LibMakeColors", dependencies: [ .product(name: "ArgumentParser", package: "swift-argument-parser"), ] @@ -22,7 +28,7 @@ let package = Package( .testTarget( name: "MakeColorsTests", dependencies: [ - "MakeColors", + "LibMakeColors", .product(name: "RBBJSON", package: "RBBJSON"), ] ), diff --git a/README.md b/README.md index b9b8980..3e4a710 100644 --- a/README.md +++ b/README.md @@ -109,6 +109,7 @@ The generated HTML looks like this: ## Future work +- Support other color formats (HSV, ...) - Calculate derived colors (blend, change hue/saturation/brightness/alpha) - Support for dark/light mode - Improved error reporting in the parser diff --git a/Sources/MakeColors/Extensions/FileWrapper+Extensions.swift b/Sources/LibMakeColors/Extensions/FileWrapper+Extensions.swift similarity index 100% rename from Sources/MakeColors/Extensions/FileWrapper+Extensions.swift rename to Sources/LibMakeColors/Extensions/FileWrapper+Extensions.swift diff --git a/Sources/MakeColors/Extensions/StringProtocol+Extensions.swift b/Sources/LibMakeColors/Extensions/StringProtocol+Extensions.swift similarity index 100% rename from Sources/MakeColors/Extensions/StringProtocol+Extensions.swift rename to Sources/LibMakeColors/Extensions/StringProtocol+Extensions.swift diff --git a/Sources/MakeColors/Generators/AndroidGenerator.swift b/Sources/LibMakeColors/Generators/AndroidGenerator.swift similarity index 100% rename from Sources/MakeColors/Generators/AndroidGenerator.swift rename to Sources/LibMakeColors/Generators/AndroidGenerator.swift diff --git a/Sources/MakeColors/Generators/AssetCatalogGenerator.swift b/Sources/LibMakeColors/Generators/AssetCatalogGenerator.swift similarity index 100% rename from Sources/MakeColors/Generators/AssetCatalogGenerator.swift rename to Sources/LibMakeColors/Generators/AssetCatalogGenerator.swift diff --git a/Sources/MakeColors/Generators/Generator.swift b/Sources/LibMakeColors/Generators/Generator.swift similarity index 85% rename from Sources/MakeColors/Generators/Generator.swift rename to Sources/LibMakeColors/Generators/Generator.swift index 085021b..8561ac3 100644 --- a/Sources/MakeColors/Generators/Generator.swift +++ b/Sources/LibMakeColors/Generators/Generator.swift @@ -1,6 +1,6 @@ import Foundation -protocol Generator: AnyObject { +protocol Generator: class { static var defaultExtension: String { get } static var option: String { get } @@ -9,7 +9,7 @@ protocol Generator: AnyObject { func generate(data: [String: ColorDef]) throws -> FileWrapper } -protocol Context: AnyObject { +protocol Context: class { var prefix: String? { get } } diff --git a/Sources/MakeColors/Generators/HTMLGenerator.swift b/Sources/LibMakeColors/Generators/HTMLGenerator.swift similarity index 100% rename from Sources/MakeColors/Generators/HTMLGenerator.swift rename to Sources/LibMakeColors/Generators/HTMLGenerator.swift diff --git a/Sources/MakeColors/MakeColors.swift b/Sources/LibMakeColors/MakeColors.swift similarity index 69% rename from Sources/MakeColors/MakeColors.swift rename to Sources/LibMakeColors/MakeColors.swift index 8b88849..a2db649 100644 --- a/Sources/MakeColors/MakeColors.swift +++ b/Sources/LibMakeColors/MakeColors.swift @@ -19,39 +19,6 @@ private struct GeneratorOption: EnumerableFlag, CustomStringConvertible { } } -private struct ImporterOption: CaseIterable, ExpressibleByArgument, CustomStringConvertible { - static let allCases: [ImporterOption] = [ - .list, - .init(type: FigmaImporter.self), - ] - - static let list = ImporterOption(type: ListImporter.self) - - let type: Importer.Type - - init(type: Importer.Type) { - self.type = type - } - - init?(argument: String) { - guard - let found = Self.allCases - .first(where: { $0.description.caseInsensitiveCompare(argument) == .orderedSame }) - else { - return nil - } - self = found - } - - var description: String { - type.option - } - - static func == (lhs: ImporterOption, rhs: ImporterOption) -> Bool { - lhs.type == rhs.type - } -} - enum Errors: Error { case syntaxError case duplicateColor(String) @@ -80,17 +47,13 @@ enum HelpTexts { ) } -@main -public final class MakeColors: AsyncParsableCommand, Context { +public final class MakeColors: ParsableCommand, Context { @Argument(help: HelpTexts.input) var input: String @Flag(help: "The formatter to use.") private var formatter = GeneratorOption.allCases[0] - @Option(help: "The importer to use.") - private var importer = ImporterOption.list - @Option(help: "Prefix for color names.") var prefix: String? @@ -102,9 +65,11 @@ public final class MakeColors: AsyncParsableCommand, Context { public init() {} - public func run() async throws { - let importer = try importer.type.init(source: input) - let data = try await importer.read() + public func run() throws { + let scanner = Scanner(string: try readInput()) + scanner.charactersToBeSkipped = .whitespaces + + let data = try scanner.colorList() if dump { try dump(data: data) @@ -113,7 +78,27 @@ public final class MakeColors: AsyncParsableCommand, Context { let generator = formatter.type.init(context: self) let fileWrapper = try generator.generate(data: data) - try writeOutput(fileWrapper, name: output ?? "\(importer.outputName).\(formatter.type.defaultExtension)") + try writeOutput(fileWrapper) + } + + func readInput() throws -> String { + if input == "-" { + return try readStdin() + } + + let url = URL(fileURLWithPath: input) + return try String(contentsOf: url) + } + + func readStdin() throws -> String { + guard + let data = try FileHandle.standardInput.readToEnd(), + let input = String(data: data, encoding: .utf8) + else { + throw Errors.cannotReadStdin + } + + return input } func dump(data: [String: ColorDef]) throws { @@ -133,7 +118,7 @@ public final class MakeColors: AsyncParsableCommand, Context { } } - func writeOutput(_ wrapper: FileWrapper, name: String) throws { + func writeOutput(_ wrapper: FileWrapper) throws { if shouldWriteToStdout { guard wrapper.isRegularFile, let contents = wrapper.regularFileContents else { throw Errors.cannotWriteWrapperToStdout @@ -141,10 +126,19 @@ public final class MakeColors: AsyncParsableCommand, Context { FileHandle.standardOutput.write(contents) } else { - let writeURL = URL(fileURLWithPath: name) + let writeURL = outputURL(extension: formatter.type.defaultExtension) try wrapper.write(to: writeURL, options: .atomic, originalContentsURL: nil) } } var shouldWriteToStdout: Bool { output == "-" || (input == "-" && output == nil) } + + func outputURL(extension: String) -> URL { + if let output = output { + return URL(fileURLWithPath: output) + } else { + let basename = URL(fileURLWithPath: input).deletingPathExtension().lastPathComponent + return URL(fileURLWithPath: basename).appendingPathExtension(`extension`) + } + } } diff --git a/Sources/MakeColors/Model/Color+HSV.swift b/Sources/LibMakeColors/Model/Color+HSV.swift similarity index 76% rename from Sources/MakeColors/Model/Color+HSV.swift rename to Sources/LibMakeColors/Model/Color+HSV.swift index 9251c03..8b9383f 100644 --- a/Sources/MakeColors/Model/Color+HSV.swift +++ b/Sources/LibMakeColors/Model/Color+HSV.swift @@ -2,35 +2,26 @@ extension Color { init(hue: Int, saturation: UInt8, value: UInt8, alpha: UInt8 = 0xFF) { let degrees = abs(hue % 360) - let saturation = Double(saturation) / 0xFF - let value = Double(value) / 0xFF - - // swiftlint:disable identifier_name - Wish I knew what these actually mean. - let C = saturation * value + let s = Double(saturation) / 0xFF + let v = Double(value) / 0xFF + let C = s * v let X = C * (1 - abs((Double(degrees) / 60).truncatingRemainder(dividingBy: 2) - 1)) - let m = value - C - // swiftlint:enable identifier_name + let m = v - C let result: (r: Double, g: Double, b: Double) switch degrees { case 0..<60: result = (C, X, 0) - case 60..<120: result = (X, C, 0) - case 120..<180: result = (0, C, X) - case 180..<240: result = (0, X, C) - case 240..<300: result = (X, 0, C) - case 300..<360: result = (C, 0, X) - default: fatalError("Degrees out of range") } diff --git a/Sources/MakeColors/Model/Color.swift b/Sources/LibMakeColors/Model/Color.swift similarity index 100% rename from Sources/MakeColors/Model/Color.swift rename to Sources/LibMakeColors/Model/Color.swift diff --git a/Sources/MakeColors/Importers/List/Scanner+ColorParser.swift b/Sources/LibMakeColors/Model/Scanner+ColorParser.swift similarity index 98% rename from Sources/MakeColors/Importers/List/Scanner+ColorParser.swift rename to Sources/LibMakeColors/Model/Scanner+ColorParser.swift index b3d43d7..9870824 100644 --- a/Sources/MakeColors/Importers/List/Scanner+ColorParser.swift +++ b/Sources/LibMakeColors/Model/Scanner+ColorParser.swift @@ -110,7 +110,7 @@ extension Scanner { func colorLine() -> (String, ColorDef)? { guard - let name = name(), + let name = self.name(), let def = colorDef(), endOfLine() else { @@ -168,7 +168,7 @@ extension Scanner { func commaSeparated() -> [UInt8]? { var result: [UInt8] = [] repeat { - guard let component = component() else { + guard let component = self.component() else { return nil } result.append(component) diff --git a/Sources/MakeColors/Importers/Figma/FigmaImporter.swift b/Sources/MakeColors/Importers/Figma/FigmaImporter.swift deleted file mode 100644 index c84339f..0000000 --- a/Sources/MakeColors/Importers/Figma/FigmaImporter.swift +++ /dev/null @@ -1,151 +0,0 @@ -import Foundation - -enum FigmaErrors: Error { - case invalidUrl - case missingToken - case invalidResponse - case missingColor(String) -} - -class FigmaImporter: Importer { - let key: String - let token: String - let outputName: String - - required init(source: String) throws { - // https://www.figma.com/file/:key/:title - guard - let url = URL(string: source), - url.host == "www.figma.com", - url.pathComponents.count >= 4, - url.pathComponents[1] == "file" - else { - throw FigmaErrors.invalidUrl - } - - key = url.pathComponents[2] - outputName = url.pathComponents[3] - - guard let token = ProcessInfo.processInfo.environment["FIGMA_TOKEN"] else { - throw FigmaErrors.missingToken - } - - self.token = token - } - - func read() async throws -> [String: ColorDef] { - let styles = try await request(StylesResponse.self, path: "/v1/files/\(key)/styles").meta.styles - .filter { $0.styleType == "FILL" } - - let ids = styles.map(\.nodeId).joined(separator: ",") - - let nodes = try await request( - NodesResponse.self, - path: "/v1/files/\(key)/nodes", - query: [URLQueryItem(name: "ids", value: ids)] - ) - .nodes - - var result: [String: ColorDef] = [:] - result.reserveCapacity(styles.count) - - for style in styles { - guard - let node = nodes[style.nodeId], - let fill = node.document.fills.first(where: { $0.type == "SOLID" }) - else { - throw FigmaErrors.missingColor(style.name) - } - - if node.document.fills.count > 1 { - print("Warning: Multiple fills defined for \(style.name)") - } - - if fill.blendMode != "NORMAL" { - print("Warning: Blend mode \(fill.blendMode) used for \(style.name)") - } - - guard !result.keys.contains(style.name) else { - throw Errors.duplicateColor(style.name) - } - - result[style.name] = .color(Color(fill.color)) - } - - return result - } - - func request(_: T.Type = T.self, path: String, query: [URLQueryItem]? = nil) async throws -> T { - var components = URLComponents() - components.scheme = "https" - components.host = "api.figma.com" - components.path = path - components.queryItems = query - - guard let url = components.url else { - fatalError("Cannot create url. Components: \(components)") - } - - var request = URLRequest(url: url) - request.setValue(token, forHTTPHeaderField: "X-Figma-Token") - - let (data, response) = try await URLSession.shared.data(for: request) - - guard let response = response as? HTTPURLResponse else { - fatalError("Non-HTTP-Response received: \(response)") - } - - guard response.statusCode == 200 else { - throw FigmaErrors.invalidResponse - } - - let decoder = JSONDecoder() - decoder.keyDecodingStrategy = .convertFromSnakeCase - return try decoder.decode(T.self, from: data) - } -} - -struct StylesResponse: Decodable { - var meta: Meta - struct Meta: Decodable { - var styles: [Style] - } - - struct Style: Decodable { - var nodeId: String - var styleType: String - var name: String - var description: String - } -} - -struct NodesResponse: Decodable { - var nodes: [String: Node] - - struct Node: Decodable { - var document: Document - } - - struct Document: Decodable { - var fills: [Fill] - } - - struct Fill: Decodable { - var blendMode: String - var type: String - var color: Color - } - - struct Color: Decodable { - var r, g, b, a: Float - } -} - -extension Color { - init(_ color: NodesResponse.Color) { - red = UInt8(truncatingIfNeeded: Int(color.r * 0xFF)) - green = UInt8(truncatingIfNeeded: Int(color.g * 0xFF)) - blue = UInt8(truncatingIfNeeded: Int(color.b * 0xFF)) - alpha = UInt8(truncatingIfNeeded: Int(color.a * 0xFF)) - } -} diff --git a/Sources/MakeColors/Importers/Importer.swift b/Sources/MakeColors/Importers/Importer.swift deleted file mode 100644 index 6c4d5d8..0000000 --- a/Sources/MakeColors/Importers/Importer.swift +++ /dev/null @@ -1,15 +0,0 @@ -protocol Importer { - init(source: String) throws - - func read() async throws -> [String: ColorDef] - - var outputName: String { get } - - static var option: String { get } -} - -extension Importer { - static var option: String { - String(describing: self).droppingSuffix("Importer").lowercased() - } -} diff --git a/Sources/MakeColors/Importers/List/ListImporter.swift b/Sources/MakeColors/Importers/List/ListImporter.swift deleted file mode 100644 index ef291b1..0000000 --- a/Sources/MakeColors/Importers/List/ListImporter.swift +++ /dev/null @@ -1,38 +0,0 @@ -import Foundation - -struct ListImporter: Importer { - let input: String - var outputName: String - - init(source: String) { - input = source - outputName = URL(fileURLWithPath: source).deletingPathExtension().lastPathComponent - } - - func read() throws -> [String: ColorDef] { - let scanner = Scanner(string: try readInput()) - scanner.charactersToBeSkipped = .whitespaces - - return try scanner.colorList() - } - - func readInput() throws -> String { - if input == "-" { - return try readStdin() - } - - let url = URL(fileURLWithPath: input) - return try String(contentsOf: url) - } - - func readStdin() throws -> String { - guard - let data = try FileHandle.standardInput.readToEnd(), - let input = String(data: data, encoding: .utf8) - else { - throw Errors.cannotReadStdin - } - - return input - } -} diff --git a/Sources/MakeColors/main.swift b/Sources/MakeColors/main.swift new file mode 100644 index 0000000..db25b90 --- /dev/null +++ b/Sources/MakeColors/main.swift @@ -0,0 +1,3 @@ +import LibMakeColors + +MakeColors.main() diff --git a/Tests/MakeColorsTests/AssetCatalogFormattingTest.swift b/Tests/MakeColorsTests/AssetCatalogFormattingTest.swift index d4f9f10..4c0e8e5 100644 --- a/Tests/MakeColorsTests/AssetCatalogFormattingTest.swift +++ b/Tests/MakeColorsTests/AssetCatalogFormattingTest.swift @@ -1,4 +1,4 @@ -@testable import MakeColors +@testable import LibMakeColors import RBBJSON import XCTest diff --git a/Tests/MakeColorsTests/ColorHSVTest.swift b/Tests/MakeColorsTests/ColorHSVTest.swift index 9eba183..d7bd9dc 100644 --- a/Tests/MakeColorsTests/ColorHSVTest.swift +++ b/Tests/MakeColorsTests/ColorHSVTest.swift @@ -1,4 +1,4 @@ -@testable import MakeColors +@testable import LibMakeColors import XCTest final class ColorHSVTest: XCTestCase { diff --git a/Tests/MakeColorsTests/ColorParserTest.swift b/Tests/MakeColorsTests/ColorParserTest.swift index 8c3756e..075c72d 100644 --- a/Tests/MakeColorsTests/ColorParserTest.swift +++ b/Tests/MakeColorsTests/ColorParserTest.swift @@ -1,4 +1,4 @@ -@testable import MakeColors +@testable import LibMakeColors import XCTest final class ColorParserTest: XCTestCase {