Custom filenames pattern

subdan · subdan · commit bf39ae6cdd79 · 2020-09-25T23:16:54.000+03:00
Closes #27
diff --git a/CONFIG.md b/CONFIG.md
@@ -18,19 +18,28 @@ figma:
 
 # [optional] Common export parameters
 common:
+  # [optional]
   colors:
-    # RegExp pattern for color name validation before exporting 
+    # [optional] RegExp pattern for color name validation before exporting 
     nameValidateRegexp: '^[a-zA-Z_]+$' # RegExp pattern for: background, background_primary, widget_primary_background
+    # [optional] RegExp pattern for replacing. Supports only $n
+    nameReplaceRegexp: 'color_$1'
+  # [optional]
   icons:
-    # Name of the Figma's frame where icons components are located
+    # [optional] Name of the Figma's frame where icons components are located
     figmaFrameName: Colors
-    # RegExp pattern for icon name validation before exporting 
+    # [optional] RegExp pattern for icon name validation before exporting 
     nameValidateRegexp: '^(ic)_(\d\d)_([a-z0-9_]+)$' # RegExp pattern for: ic_24_icon_name, ic_24_icon
+    # [optional] RegExp pattern for replacing. Supports only $n
+    nameReplaceRegexp: 'icon_$2_$1'
+  # [optional]
   images:
-    # Name of the Figma's frame where image components are located
+    # [optional]Name of the Figma's frame where image components are located
     figmaFrameName: Illustrations
-    # RegExp pattern for image name validation before exporting
+    # [optional] RegExp pattern for image name validation before exporting
     nameValidateRegexp: '^(img)_([a-z0-9_]+)$' # RegExp pattern for: img_image_name
+    # [optional] RegExp pattern for replacing. Supports only $n
+    nameReplaceRegexp: 'image_$2'
 
 # [optional] iOS export parameters
 ios:
diff --git a/Examples/Example/figma-export.yaml b/Examples/Example/figma-export.yaml
@@ -5,15 +5,18 @@ figma:
 
 # [optional] Common export parameters
 common:
+  # [optional]
   colors:
-    # RegExp pattern for color name validation before exporting 
+    # [optional] RegExp pattern for color name validation before exporting. Use to validate color name in Figma file
     nameValidateRegexp: '^[a-zA-Z_]+$' # RegExp pattern for: background, background_primary, widget_primary_background
+  # [optional]
   icons:
-    # RegExp pattern for icon name validation before exporting 
+    # [optional] RegExp pattern for icon name validation before exporting. Use to validate icon name in Figma file
     nameValidateRegexp: '^(ic)_(\d\d)_([a-z0-9_]+)$' # RegExp pattern for: ic_24_icon_name, ic_24_icon
+  # [optional]
   images:
-    # RegExp pattern for image name validation before exporting
-    nameValidateRegexp: '^(img)_([a-z0-9_]+)$' # RegExp pattern for: img_image_name
+    # [optional] RegExp pattern for image name validation before exporting. Use to validate image name in Figma file
+    nameValidateRegexp: '^(img)_([a-z0-9_]+)$' # RegExp pattern for: img_zero_empty, img_widget_large
 
 # [optional] iOS export parameters
 ios:
@@ -64,4 +67,3 @@ ios:
     generateLabels: true
     # Path to directory where to place UILabel for each text style (font) (Requred if generateLabels = true)
     labelsDirectory: "./UIComponents/Source/"
-    
diff --git a/Package.swift b/Package.swift
@@ -57,6 +57,12 @@ let package = Package(
             dependencies: ["FigmaExportCore"]
         ),
         
+        // MARK: - Tests
+        
+        .testTarget(
+            name: "FigmaExportTests",
+            dependencies: ["FigmaExport"]
+        ),
         .testTarget(
             name: "FigmaExportCoreTests",
             dependencies: ["FigmaExportCore"]
diff --git a/Sources/FigmaExport/Helpers/ErrorGroup.swift b/Sources/FigmaExport/Helpers/ErrorGroup.swift
diff --git a/Sources/FigmaExport/Input/Params.swift b/Sources/FigmaExport/Input/Params.swift
@@ -1,4 +1,7 @@
 import Foundation
+import FigmaExportCore
+
+extension NameStyle: Decodable {}
 
 struct Params: Decodable {
 
@@ -10,28 +13,26 @@ struct Params: Decodable {
     struct Common: Decodable {
         struct Colors: Decodable {
             let nameValidateRegexp: String?
+            let nameReplaceRegexp: String?
         }
         
         struct Icons: Decodable {
             let nameValidateRegexp: String?
             let figmaFrameName: String?
+            let nameReplaceRegexp: String?
         }
         
         struct Images: Decodable {
             let nameValidateRegexp: String?
             let figmaFrameName: String?
+            let nameReplaceRegexp: String?
         }
         
         let colors: Colors?
         let icons: Icons?
         let images: Images?
     }
     
-    enum NameStyle: String, Decodable {
-        case camelCase = "camelCase"
-        case snakeCase = "snake_case"
-    }
-    
     enum VectorFormat: String, Decodable {
         case pdf
         case svg
diff --git a/Sources/FigmaExport/Subcommands/ExportColors.swift b/Sources/FigmaExport/Subcommands/ExportColors.swift
@@ -40,6 +40,7 @@ extension FigmaExportCommand {
                 let processor = ColorsProcessor(
                     platform: .ios,
                     nameValidateRegexp: params.common?.colors?.nameValidateRegexp,
+                    nameReplaceRegexp: params.common?.colors?.nameReplaceRegexp,
                     nameStyle: params.ios?.colors.nameStyle
                 )
                 let colorPairs = try processor.process(light: colors.light, dark: colors.dark).get()
@@ -55,6 +56,7 @@ extension FigmaExportCommand {
                 let processor = ColorsProcessor(
                     platform: .android,
                     nameValidateRegexp: params.common?.colors?.nameValidateRegexp,
+                    nameReplaceRegexp: params.common?.colors?.nameReplaceRegexp,
                     nameStyle: .snakeCase
                 )
                 let colorPairs = try processor.process(light: colors.light, dark: colors.dark).get()
diff --git a/Sources/FigmaExport/Subcommands/ExportIcons.swift b/Sources/FigmaExport/Subcommands/ExportIcons.swift
@@ -57,6 +57,7 @@ extension FigmaExportCommand {
             let processor = ImagesProcessor(
                 platform: .ios,
                 nameValidateRegexp: params.common?.icons?.nameValidateRegexp,
+                nameReplaceRegexp: params.common?.icons?.nameReplaceRegexp,
                 nameStyle: params.ios?.icons.nameStyle
             )
             let icons = try processor.process(assets: images).get()
@@ -112,6 +113,7 @@ extension FigmaExportCommand {
             let processor = ImagesProcessor(
                 platform: .android,
                 nameValidateRegexp: params.common?.icons?.nameValidateRegexp,
+                nameReplaceRegexp: params.common?.icons?.nameReplaceRegexp,
                 nameStyle: .snakeCase
             )
             let icons = try processor.process(light: images, dark: nil).get()
diff --git a/Sources/FigmaExport/Subcommands/ExportImages.swift b/Sources/FigmaExport/Subcommands/ExportImages.swift
@@ -57,6 +57,7 @@ extension FigmaExportCommand {
             let processor = ImagesProcessor(
                 platform: .ios,
                 nameValidateRegexp: params.common?.images?.nameValidateRegexp,
+                nameReplaceRegexp: params.common?.images?.nameReplaceRegexp,
                 nameStyle: params.ios?.images.nameStyle
             )
             let images = try processor.process(light: imagesTuple.light, dark: imagesTuple.dark).get()
@@ -109,6 +110,7 @@ extension FigmaExportCommand {
             let processor = ImagesProcessor(
                 platform: .android,
                 nameValidateRegexp: params.common?.images?.nameValidateRegexp,
+                nameReplaceRegexp: params.common?.images?.nameReplaceRegexp,
                 nameStyle: .snakeCase
             )
             let images = try processor.process(light: imagesTuple.light, dark: imagesTuple.dark).get()
diff --git a/Sources/FigmaExportCore/ErrorGroup.swift b/Sources/FigmaExportCore/ErrorGroup.swift
@@ -0,0 +1,15 @@
+import Foundation
+
+public struct ErrorGroup: LocalizedError {
+
+    public var all: [Error] = []
+    public var errorDescription: String? {
+        all.compactMap {
+            ($0 as? LocalizedError)?.errorDescription ?? $0.localizedDescription
+        }.joined(separator: "\n")
+    }
+    
+    public init(all: [Error] = []) {
+        self.all = all
+    }
+}
diff --git a/Sources/FigmaExportCore/Extensions/StringCase.swift b/Sources/FigmaExportCore/Extensions/StringCase.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-public extension String {
+extension String {
     /// A Boolean value indicating whether this string is considered snake case.
     ///
     /// For example, the following strings are all snake case:
@@ -71,7 +71,8 @@ public extension String {
         for character in Array<Character>(self) {
             if results.isEmpty && (character.isLetter || character.isNumber) {
                 results.append(String(character))
-            } else if (lastCharacter.isLetter || lastCharacter.isNumber) && character.isLowercase {
+            } else if ((lastCharacter.isLetter || lastCharacter.isNumber) && character.isLowercase) ||
+                        (lastCharacter.isNumber && character.isNumber) {
                 results[results.count - 1] = results[results.count - 1] + String(character)
             } else if (character.isLetter || character.isNumber) {
                 results.append(String(character))
diff --git a/Sources/FigmaExportCore/Extensions/SwiftReplace.swift b/Sources/FigmaExportCore/Extensions/SwiftReplace.swift
@@ -0,0 +1,28 @@
+//
+//  SwiftReplace.swift
+//
+//  Created by Brian Floersch on 12/7/18.
+//  Copyright © 2018 Brian Floersch. All rights reserved.
+//
+import Foundation
+
+extension String {
+    func replace(_ pattern: String, options: NSRegularExpression.Options = [], collector: ([String]) -> String) -> String {
+        guard let regex = try? NSRegularExpression(pattern: pattern, options: options) else { return self }
+        let matches = regex.matches(in: self, options: NSRegularExpression.MatchingOptions(rawValue: 0), range: NSMakeRange(0, (self as NSString).length))
+        guard matches.count > 0 else { return self }
+        var splitStart = startIndex
+        return matches.map { (match) -> (String, [String]) in
+            let range = Range(match.range, in: self)!
+            let split = String(self[splitStart ..< range.lowerBound])
+            splitStart = range.upperBound
+            return (split, (0 ..< match.numberOfRanges)
+                .compactMap { Range(match.range(at: $0), in: self) }
+                .map { String(self[$0]) }
+            )
+        }.reduce("") { "\($0)\($1.0)\(collector($1.1))" } + self[Range(matches.last!.range, in: self)!.upperBound ..< endIndex]
+    }
+    func replace(_ regexPattern: String, options: NSRegularExpression.Options = [], collector: @escaping () -> String) -> String {
+        return replace(regexPattern, options: options) { (_: [String]) in collector() }
+    }
+}
diff --git a/Sources/FigmaExportCore/NameStyle.swift b/Sources/FigmaExportCore/NameStyle.swift
@@ -0,0 +1,6 @@
+import Foundation
+
+public enum NameStyle: String {
+    case camelCase = "camelCase"
+    case snakeCase = "snake_case"
+}
diff --git a/Sources/FigmaExportCore/Processor/AssetsProcessor.swift b/Sources/FigmaExportCore/Processor/AssetsProcessor.swift
@@ -1,17 +1,15 @@
-import Foundation
-import FigmaExportCore
-
 /// Process asset name
-protocol AssetNameProcessable {
+public protocol AssetNameProcessable {
     
+    var nameReplaceRegexp: String? { get }
     var nameValidateRegexp: String? { get }
-    var nameStyle: Params.NameStyle? { get }
+    var nameStyle: NameStyle? { get }
     
     func isNameValid(_ name: String) -> Bool
-    func normalizeName(_ name: String, style: Params.NameStyle) -> String
+    func normalizeName(_ name: String, style: NameStyle) -> String
 }
 
-extension AssetNameProcessable {
+public extension AssetNameProcessable {
     
     func isNameValid(_ name: String) -> Bool {
         if let regexp = nameValidateRegexp {
@@ -21,7 +19,7 @@ extension AssetNameProcessable {
         }
     }
     
-    func normalizeName(_ name: String, style: Params.NameStyle) -> String {
+    func normalizeName(_ name: String, style: NameStyle) -> String {
         switch style {
         case .camelCase:
             return name.lowerCamelCased()
@@ -31,7 +29,7 @@ extension AssetNameProcessable {
     }
 }
 
-protocol AssetsProcessable: AssetNameProcessable {
+public protocol AssetsProcessable: AssetNameProcessable {
     associatedtype AssetType: Asset
     typealias ProcessingPairResult = Result<[AssetPair<AssetType>], ErrorGroup>
     typealias ProcessingResult = Result<[AssetType], ErrorGroup>
@@ -42,23 +40,39 @@ protocol AssetsProcessable: AssetNameProcessable {
     func process(assets: [AssetType]) -> ProcessingResult
 }
 
-struct ColorsProcessor: AssetsProcessable {
-    typealias AssetType = Color
+public struct ColorsProcessor: AssetsProcessable {
+    public typealias AssetType = Color
+    
+    public let platform: Platform
+    public let nameValidateRegexp: String?
+    public let nameReplaceRegexp: String?
+    public let nameStyle: NameStyle?
     
-    let platform: Platform
-    let nameValidateRegexp: String?
-    let nameStyle: Params.NameStyle?
+    public init(platform: Platform, nameValidateRegexp: String?, nameReplaceRegexp: String?, nameStyle: NameStyle?) {
+        self.platform = platform
+        self.nameValidateRegexp = nameValidateRegexp
+        self.nameReplaceRegexp = nameReplaceRegexp
+        self.nameStyle = nameStyle
+    }
 }
 
-struct ImagesProcessor: AssetsProcessable {
-    typealias AssetType = ImagePack
+public struct ImagesProcessor: AssetsProcessable {
+    public typealias AssetType = ImagePack
 
-    let platform: Platform
-    let nameValidateRegexp: String?
-    let nameStyle: Params.NameStyle?
+    public let platform: Platform
+    public let nameValidateRegexp: String?
+    public let nameReplaceRegexp: String?
+    public let nameStyle: NameStyle?
+    
+    public init(platform: Platform, nameValidateRegexp: String? = nil, nameReplaceRegexp: String? = nil, nameStyle: NameStyle?) {
+        self.platform = platform
+        self.nameValidateRegexp = nameValidateRegexp
+        self.nameReplaceRegexp = nameReplaceRegexp
+        self.nameStyle = nameStyle
+    }
 }
 
-extension AssetsProcessable {
+public extension AssetsProcessable {
 
     func process(light: [AssetType], dark: [AssetType]?) -> ProcessingPairResult {
         if let dark = dark {
@@ -107,6 +121,9 @@ extension AssetsProcessable {
             .filter { $0.platform == nil || $0.platform == platform }
             .map { asset -> AssetType in
                 var newAsset = asset
+                if let replaceRegExp = nameReplaceRegexp, let regexp = nameValidateRegexp {
+                    newAsset.name = self.replace(newAsset.name, matchRegExp: regexp, replaceRegExp: replaceRegExp)
+                }
                 if let style = nameStyle {
                     newAsset.name = self.normalizeName(newAsset.name, style: style)
                 }
@@ -115,6 +132,17 @@ extension AssetsProcessable {
         
         return .success(assets)
     }
+    
+    private func replace(_ name: String, matchRegExp: String, replaceRegExp: String) -> String {
+        let result = name.replace(matchRegExp) { array in
+            replaceRegExp.replace(#"\$(\d)"#) {
+                let index = Int($0[1])!
+                return array[index]
+            }
+        }
+        
+        return result
+    }
 
     private func validateAndMakePairs(light: [AssetType]) -> ProcessingPairResult {
         var errors = ErrorGroup()
@@ -218,8 +246,12 @@ extension AssetsProcessable {
 
                 var newLightAsset = lightAsset
 
+                if let replaceRegExp = nameReplaceRegexp, let regexp = nameValidateRegexp {
+                    newLightAsset.name = self.replace(newLightAsset.name, matchRegExp: regexp, replaceRegExp: replaceRegExp)
+                }
+                
                 if let style = nameStyle {
-                    newLightAsset.name = self.normalizeName(lightAsset.name, style: style)
+                    newLightAsset.name = self.normalizeName(newLightAsset.name, style: style)
                 }
 
                 return AssetPair(light: newLightAsset, dark: nil)
@@ -246,9 +278,14 @@ extension AssetsProcessable {
                 var newLightAsset = lightAsset
                 var newDarkAsset = darkAsset
 
+                if let replaceRegExp = nameReplaceRegexp, let regexp = nameValidateRegexp {
+                    newLightAsset.name = self.replace(newLightAsset.name, matchRegExp: regexp, replaceRegExp: replaceRegExp)
+                    newDarkAsset.name = self.replace(newDarkAsset.name, matchRegExp: regexp, replaceRegExp: replaceRegExp)
+                }
+                
                 if let style = nameStyle {
-                    newLightAsset.name = self.normalizeName(lightAsset.name, style: style)
-                    newDarkAsset.name = self.normalizeName(darkAsset.name, style: style)
+                    newLightAsset.name = self.normalizeName(newLightAsset.name, style: style)
+                    newDarkAsset.name = self.normalizeName(newDarkAsset.name, style: style)
                 }
 
                 return AssetPair(light: newLightAsset, dark: newDarkAsset)
diff --git a/Sources/FigmaExportCore/Processor/AssetsValidatorError.swift b/Sources/FigmaExportCore/Processor/AssetsValidatorError.swift
diff --git a/Tests/FigmaExportTests/AssetsProcessorTests.swift b/Tests/FigmaExportTests/AssetsProcessorTests.swift
