PORTFOLIO-29267: [FigmaGen] Поддержать выгрузку токенов с Github.

Package.resolved

@@ -18,6 +18,15 @@
         "version" : "0.13.7"
       }
     },
+    {
+      "identity" : "keychainaccess",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/kishikawakatsumi/KeychainAccess.git",
+      "state" : {
+        "revision" : "84e546727d66f1adc5439debad16270d0fdd04e7",
+        "version" : "4.2.2"
+      }
+    },
     {
       "identity" : "komondor",
       "kind" : "remoteSourceControl",

Package.swift

@@ -19,7 +19,8 @@ let package = Package(
         .package(url: "https://github.com/SwiftGen/StencilSwiftKit.git", from: "2.7.2"),
         .package(url: "https://github.com/mxcl/PromiseKit.git", from: "8.0.0"),
         .package(url: "https://github.com/almazrafi/DictionaryCoder.git", from: "1.0.0"),
-        .package(url: "https://github.com/nicklockwood/Expression.git", from: "0.13.0")
+        .package(url: "https://github.com/nicklockwood/Expression.git", from: "0.13.0"),
+        .package(url: "https://github.com/kishikawakatsumi/KeychainAccess.git", from: "4.2.2")
     ],
     targets: [
         .executableTarget(
@@ -34,7 +35,12 @@ let package = Package(
                 "PromiseKit",
                 "DictionaryCoder",
                 "FigmaGenTools",
-                "Expression"
+                "Expression",
+                .product(
+                    name: "KeychainAccess",
+                    package: "KeychainAccess",
+                    condition: .when(platforms: [.macOS])
+                )
             ],
             path: "Sources/FigmaGen"
         ),
@@ -43,7 +49,12 @@ let package = Package(
             dependencies: [
                 "SwiftCLI",
                 "PathKit",
-                "PromiseKit"
+                "PromiseKit",
+                .product(
+                    name: "KeychainAccess",
+                    package: "KeychainAccess",
+                    condition: .when(platforms: [.macOS])
+                )
             ],
             path: "Sources/FigmaGenTools"
         ),

README.md

@@ -33,6 +33,8 @@ Currently, FigmaGen supports the following entities:
 - [Text styles](#text-styles)
 - [Shadow styles](#shadow-styles)
 - [Images](#images)
+- [Tokens](#tokens)
+- [Working on FigmaGen](#Working-on-FigmaGen)
 - [Communication](#communication)
 - [License](#license)
 
@@ -491,6 +493,113 @@ Key  | Type | Default value | Description
 `imageTypeName` | String | UIImage | Image type name. If the target platform is macOS, specify `NSImage`.
 `publicAccess` | Boolean | false | Adds `public` access modifier to the declarations in the generated file.
 
+## Tokens
+
+Configuration sections for generationg Tokens:
+- `accessToken`: an access token string that is needed to execute Figma API requests (see [Figma access token](#figma-access-token)).
+- `file`: URL of a Figma file, which data will be used to generate code (see [Figma file](#figma-file)).
+- `remoteRepoConfig`: parameters that will be used to generate tokens from remote file (see [Remote repository parameters](#remote-repository-parameters))
+- `templates`: parameters of styles for generation (see [Parameters of styles](#parameters-of-styles-for-generation)) 
+
+### Token parameters
+Sample configuration:
+```yaml
+tokens:
+  accessToken: 25961-4ac9fbc9-3bd8-4c43-bbe2-95e477f8a067
+  file: https://www.figma.com/file/61xw2FQn61Xr7VVFYwiHHy/FigmaGen-Demo
+  remoteRepoConfig: { [remote repository parameters](#remote-repository-parameters) }
+  templates:
+    colors: 
+        { standard configuration set}
+    baseColors: 
+        { standard configuration set }
+    fontFamilies: 
+        { standard configuration set }
+    typographies: 
+        { standard configuration set }
+    boxShadows: 
+        { standard configuration set }
+    spacing: 
+        { standard configuration set }
+    theme: 
+        { standard configuration set }
+```
+
+### Parameters of styles for generation
+
+Sample configuration for color styles:
+```yaml
+    colors:
+      destination: ./Generated/ColorTokens.swift
+      templateOptions:
+        publicAccess: true
+```
+
+### Remote repository parameters
+
+Remote repository section:
+- `owner`: owner of the remote repository
+- `repo`: name of the remote repository
+- `branch`: name of the branch in remote repository
+- `filePath`: file name or path to the file in remote repository
+- `accessToken`: an access token string or object that is needed to execute GitHub API requests 
+
+Remote repository parameters structure:
+```yaml
+  remoteRepoConfig: 
+    owner: { your repository owner }
+    repo: { your repository name }
+    branch: { your repository branch }
+    filePath: { your repository file path }
+    accessToken: { your GitHub access token }
+    # OR
+    accessToken:
+      env: { your repository environment }
+      keychain:
+        service: { service name }
+        key: { key name }
+```
+
+Sample configuration for remote repository parameters with string `accessToken`:
+```yaml
+  remoteRepoConfig: 
+    owner: hhru
+    repo: FigmaGen
+    branch: master
+    filePath: tokens.json
+    accessToken: ghp_259614ac9fbc93bd84c43bbe2bt53m0TaM4A
+```
+
+Sample configuration for remote repository parameters with object `accessToken`:
+```yaml
+  remoteRepoConfig: 
+    owner: hhru
+    repo: FigmaGen
+    branch: master
+    filePath: tokens.json
+    accessToken:
+      env: GITHUB_API
+      keychain:
+        service: GitHub Token
+        key: hh
+```
+
+## Working on FigmaGen
+
+To work on FigmaGen you need to open the `Package.swift` file, select the `figmagen` scheme and edit the scheme 
+
+####
+![](Docs/Choose_and_Edit_Scheme.png)
+
+#### Arguments for generating tokens with FigmaGen from file configurations
+![](Docs/Generate_from_config.png)
+
+#### Arguments for generating tokens with FigmaGen using a Figma file
+![](Docs/Generate_tokens_from_Figma.png)
+
+#### Arguments for generating tokens with FigmaGen using a Github file
+![](Docs/Generate_tokens_from_GitHub_file.png)
+
 ---
 
 ## Communication

Sources/FigmaGen/Commands/GenerationConfigurableCommand.swift

@@ -59,7 +59,7 @@ extension GenerationConfigurableCommand {
             return nil
         }
 
-        return .value(accessToken)
+        return AccessTokenConfiguration(value: accessToken)
     }
 
     private func resolveTemplateOptions() -> [String: Any] {

Sources/FigmaGen/Commands/TokensCommand.swift

@@ -25,6 +25,41 @@ final class TokensCommand: AsyncExecutableCommand {
             """
     )
 
+    let remoteFileOwnerKey = Key<String>(
+        "--remoteFileOwner",
+        description: """
+            Remote Repo owner key to generate text styles from.
+            """
+    )
+
+    let remoteFileRepoKey = Key<String>(
+        "--remoteFileRepo",
+        description: """
+            Remote Repo key to generate text styles from.
+            """
+    )
+
+    let remoteFileBranchKey = Key<String>(
+        "--remoteFileBranch",
+        description: """
+            Remote Repo branch to generate text styles from.
+            """
+    )
+
+    let remoteFilePathKey = Key<String>(
+        "--remoteFilePath",
+        description: """
+            Remote Repo file key to generate text styles from.
+            """
+    )
+
+    let remoteRepoAccessTokenKey = Key<String>(
+        "--remoteRepoAccessToken",
+        description: """
+            Remote Repo personal access token to make requests to the GitHub.
+            """
+    )
+
     let accessToken = Key<String>(
         "--accessToken",
         description: """
@@ -228,6 +263,7 @@ extension TokensCommand {
     var configuration: TokensConfiguration {
         TokensConfiguration(
             file: resolveFileConfiguration(),
+            remoteRepoConfig: resolveRemoteRepoConfiguration(),
             accessToken: resolveAccessTokenConfiguration(),
             templates: TokensTemplateConfiguration(
                 colors: [
@@ -298,12 +334,32 @@ extension TokensCommand {
         )
     }
 
+    private func resolveRemoteRepoConfiguration() -> RemoteRepoConfiguration? {
+        guard
+            let fileOwner = remoteFileOwnerKey.value,
+            let fileRepo = remoteFileRepoKey.value,
+            let fileBranch = remoteFileBranchKey.value,
+            let filePath = remoteFilePathKey.value,
+            let remoteRepoAccessToken = remoteRepoAccessTokenKey.value
+        else {
+            return nil
+        }
+
+        return RemoteRepoConfiguration(
+            owner: fileOwner,
+            repo: fileRepo,
+            branch: fileBranch,
+            filePath: filePath,
+            accessToken: AccessTokenConfiguration(value: remoteRepoAccessToken)
+        )
+    }
+
     private func resolveAccessTokenConfiguration() -> AccessTokenConfiguration? {
         guard let accessToken = accessToken.value else {
             return nil
         }
 
-        return .value(accessToken)
+        return AccessTokenConfiguration(value: accessToken)
     }
 
     private func resolveTemplateOptions(_ templateOptionsValues: [String]) -> [String: Any] {

Sources/FigmaGen/Dependencies.swift

@@ -7,6 +7,9 @@ enum Dependencies {
 
     static let dataProvider: DataProvider = DefaultDataProvider()
 
+    static let gitHubHTTPService: GitHubHTTPService = HTTPService()
+    static let gitHubAPIProvider: RemoteRepoProvider = GitHubAPIProvider(httpService: gitHubHTTPService)
+
     static let figmaHTTPService: FigmaHTTPService = HTTPService()
     static let figmaAPIProvider: FigmaAPIProvider = DefaultFigmaAPIProvider(httpService: figmaHTTPService)
 
@@ -58,7 +61,8 @@ enum Dependencies {
     )
 
     static let tokensProvider: TokensProvider = DefaultTokensProvider(
-        apiProvider: figmaAPIProvider
+        figmaApiProvider: figmaAPIProvider,
+        gitHubApiProvider: gitHubAPIProvider
     )
 
     // MARK: -

Sources/FigmaGen/Generators/GenerationParametersError.swift

@@ -6,6 +6,7 @@ enum GenerationParametersError: Error, CustomStringConvertible {
 
     case invalidFileConfiguration
     case invalidAccessToken
+    case invalidGitHubAccessToken
 
     // MARK: - Instance Properties
 
@@ -16,6 +17,9 @@ enum GenerationParametersError: Error, CustomStringConvertible {
 
         case .invalidAccessToken:
             return "Figma access token cannot be empty or nil"
+
+        case .invalidGitHubAccessToken:
+            return "GitHiub access token cannot be empty or nil"
         }
     }
 }

Sources/FigmaGen/Generators/Tokens/DefaultTokensGenerator.swift

@@ -43,7 +43,7 @@ final class DefaultTokensGenerator: TokensGenerator {
     // MARK: - Instance Methods
 
     private func generate(parameters: TokensGenerationParameters) async throws {
-        let tokenValues = try await tokensProvider.fetchTokens(from: parameters.file)
+        let tokenValues = try await fetchTokens(from: parameters)
 
         try generateColorsTokens(parameters: parameters, tokenValues: tokenValues)
         try generateBaseColorsTokens(parameters: parameters, tokenValues: tokenValues)
@@ -54,6 +54,16 @@ final class DefaultTokensGenerator: TokensGenerator {
         try generateSpacingTokens(parameters: parameters, tokenValues: tokenValues)
     }
 
+    private func fetchTokens(from parameters: TokensGenerationParameters) async throws -> TokenValues {
+        if let file = parameters.file {
+            return try await tokensProvider.fetchTokens(from: file)
+        } else if let remoteFile = parameters.remoteFile {
+            return try await tokensProvider.fetchTokens(from: remoteFile)
+        } else {
+            throw GenerationParametersError.invalidFileConfiguration
+        }
+    }
+
     private func generateSpacingTokens(parameters: TokensGenerationParameters, tokenValues: TokenValues) throws {
         try generateTokens(
             spacingTokensGenerator,

Sources/FigmaGen/Generators/Tokens/GenerationParametersResolver/DefaultTokensGenerationParametersResolver.swift

@@ -21,19 +21,38 @@ final class DefaultTokensGenerationParametersResolver: TokensGenerationParameter
 
     // swiftlint:disable:next function_body_length
     func resolveGenerationParameters(from configuration: TokensConfiguration) throws -> TokensGenerationParameters {
-        guard let fileConfiguration = configuration.file else {
-            throw GenerationParametersError.invalidFileConfiguration
+
+        let file = try configuration.file.map { fileConfiguration in
+            guard let accessToken = accessTokenResolver.resolveAccessToken(from: configuration.accessToken) else {
+                throw GenerationParametersError.invalidAccessToken
+            }
+
+            return FileParameters(
+                key: fileConfiguration.key,
+                version: fileConfiguration.version,
+                accessToken: accessToken
+            )
         }
 
-        guard let accessToken = accessTokenResolver.resolveAccessToken(from: configuration.accessToken) else {
-            throw GenerationParametersError.invalidAccessToken
+        let remoteFile = try configuration.remoteRepoConfig.map { remoteFileConfiguration in
+            guard
+                let accessToken = accessTokenResolver.resolveAccessToken(from: remoteFileConfiguration.accessToken)
+            else {
+                throw GenerationParametersError.invalidGitHubAccessToken
+            }
+
+            return RemoteFileParameters(
+                owner: remoteFileConfiguration.owner,
+                repo: remoteFileConfiguration.repo,
+                branch: remoteFileConfiguration.branch,
+                filePath: remoteFileConfiguration.filePath,
+                accessToken: accessToken
+            )
         }
 
-        let file = FileParameters(
-            key: fileConfiguration.key,
-            version: fileConfiguration.version,
-            accessToken: accessToken
-        )
+        if file.isNil && remoteFile.isNil {
+            throw GenerationParametersError.invalidFileConfiguration
+        }
 
         let colorRenderParameters = renderParametersResolver.resolveRenderParameters(
             templates: configuration.templates?.colors,
@@ -72,6 +91,7 @@ final class DefaultTokensGenerationParametersResolver: TokensGenerationParameter
 
         return TokensGenerationParameters(
             file: file,
+            remoteFile: remoteFile,
             tokens: TokensGenerationParameters.TokensParameters(
                 colorRenderParameters: colorRenderParameters,
                 baseColorRenderParameters: baseColorRenderParameters,