SwiftGenPlugin

https://github.com/swiftgen/swiftgenplugin
Admin
SwiftGenPlugin is a Swift Package Manager plugin that integrates SwiftGen code generation for Swift...
Tokens:2,955
Snippets:31
Trust Score:7.5
License:MIT
Update:6 months ago
Show doc for...
Tokens:
Raw
### Manual Code Generation with Command Plugin

Source: https://context7.com/swiftgen/swiftgenplugin/llms.txt

Manually invoke SwiftGen code generation using the `swift package generate-code-for-resources` command. This is useful for CI/CD or when explicit control over generation timing is needed. Automatic configuration discovery is supported.

```bash
# Run SwiftGen with automatic configuration discovery
# Scans for swiftgen.yml in package root and all target directories
swift package --allow-writing-to-package-directory generate-code-for-resources
```

```bash
# Run SwiftGen with a specific configuration file
swift package --allow-writing-to-package-directory generate-code-for-resources \
  --config Sources/MyApp/swiftgen.yml
```

```bash
# Pass additional SwiftGen arguments
swift package --allow-writing-to-package-directory generate-code-for-resources \
  --config swiftgen.yml \
  --verbose
```

```bash
# Example in CI/CD script
#!/bin/bash
set -e
echo "Generating type-safe resource accessors..."
swift package --allow-writing-to-package-directory generate-code-for-resources
echo "Building package..."
swift build
echo "Running tests..."
swift test
```

--------------------------------

### Define top-level SwiftGen configuration

Source: https://context7.com/swiftgen/swiftgenplugin/llms.txt

Create a swiftgen.yml file at the package root to define shared settings for all targets, using ${DERIVED_SOURCES_DIR} for the output directory.

```yaml
# swiftgen.yml (at package root, same level as Package.swift)
input_dir: Sources/MyApp/Resources
output_dir: ${DERIVED_SOURCES_DIR}

strings:
  inputs:
    - Base.lproj/Localizable.strings
    - Base.lproj/Localizable.stringsdict
  outputs:
    - templateName: structured-swift5
      output: Strings.generated.swift

xcassets:
  inputs:
    - Assets.xcassets
  outputs:
    templateName: swift5
    output: Assets.swift

fonts:
  inputs:
    - Fonts
  outputs:
    templateName: swift5
    output: Fonts.swift

files:
  inputs:
    - Videos
  outputs:
    templateName: structured-swift5
    output: Files.swift

ib:
  inputs: .
  outputs:
    - templateName: scenes-swift5
      output: Storyboards+Scenes.swift
    - templateName: segues-swift5
      output: Storyboards+Segues.swift
```

--------------------------------

### Configure SwiftGen for Assets

Source: https://context7.com/swiftgen/swiftgenplugin/llms.txt

This configuration file specifies the input directory for assets and the output directory for the generated Swift file. It uses a 'swift5' template for generating code.

```yaml
input_dir: Resources
output_dir: ${DERIVED_SOURCES_DIR}

xcassets:
  inputs:
    - FeatureAAssets.xcassets
  outputs:
    templateName: swift5
    output: FeatureAAssets.swift
```

--------------------------------

### Multi-Target Configuration Strategy in SwiftGen

Source: https://context7.com/swiftgen/swiftgenplugin/llms.txt

Configure SwiftGen for multi-target applications by combining a root-level configuration for shared resources with target-specific configurations. The plugin automatically processes both.

```swift
// Package.swift for multi-target setup
import PackageDescription

let package = Package(
    name: "MyMultiTargetApp",
    platforms: [.iOS(.v15)],
    dependencies: [
        .package(url: "https://github.com/SwiftGen/SwiftGenPlugin", from: "6.6.0")
    ],
    targets: [
        .target(
            name: "Core",
            dependencies: [],
            plugins: [.plugin(name: "SwiftGenPlugin", package: "SwiftGenPlugin")]
        ),
        .target(
            name: "FeatureA",
            dependencies: ["Core"],
            plugins: [.plugin(name: "SwiftGenPlugin", package: "SwiftGenPlugin")]
        ),
        .target(
            name: "FeatureB",
            dependencies: ["Core"],
            plugins: [.plugin(name: "SwiftGenPlugin", package: "SwiftGenPlugin")]
        )
    ]
)
```

```yaml
# swiftgen.yml (root - shared resources)
output_dir: ${DERIVED_SOURCES_DIR}

strings:
  inputs:
    - Sources/Core/Resources/Base.lproj/Common.strings
  outputs:
    - templateName: structured-swift5
      output: CommonStrings.swift
```

--------------------------------

### Configure SwiftGenPlugin as a build tool

Source: https://context7.com/swiftgen/swiftgenplugin/llms.txt

Add the plugin to the plugins array of specific targets to trigger automatic code generation before each build.

```swift
// Package.swift
import PackageDescription

let package = Package(
    name: "MyApp",
    dependencies: [
        .package(url: "https://github.com/SwiftGen/SwiftGenPlugin", from: "6.6.0")
    ],
    targets: [
        .target(
            name: "MyApp",
            dependencies: [],
            resources: [
                .process("Resources")
            ],
            plugins: [
                .plugin(name: "SwiftGenPlugin", package: "SwiftGenPlugin")
            ]
        ),
        .target(
            name: "MyFeature",
            dependencies: [],
            plugins: [
                .plugin(name: "SwiftGenPlugin", package: "SwiftGenPlugin")
            ]
        )
    ]
)
```

--------------------------------

### Define target-specific SwiftGen configuration

Source: https://context7.com/swiftgen/swiftgenplugin/llms.txt

Place a swiftgen.yml file inside a target's source directory to apply custom generation rules specific to that target.

```yaml
# Sources/MyApp/swiftgen.yml (inside target directory)
input_dir: Resources
output_dir: ${DERIVED_SOURCES_DIR}

strings:
  inputs:
    - Base.lproj/Localizable.strings
  outputs:
    - templateName: structured-swift5
      output: Strings.generated.swift

xcassets:
  inputs:
    - Images.xcassets
    - Colors.xcassets
  outputs:
    templateName: swift5
    output: Assets.swift
    params:
      publicAccess: true

fonts:
  inputs:
    - CustomFonts
  outputs:
    templateName: swift5
    output: Fonts.swift
```

--------------------------------

### Configure target plugin

Source: https://github.com/swiftgen/swiftgenplugin/blob/stable/README.md

Add the SwiftGenPlugin to your target's plugins array in Package.swift.

```swift
  targets: [
    .target(
      name: "YourTargetName",
      dependencies: [],
      plugins: [
        .plugin(name: "SwiftGenPlugin", package: "SwiftGenPlugin")
      ]
    )
  ]
```

--------------------------------

### Invoke SwiftGen manually

Source: https://github.com/swiftgen/swiftgenplugin/blob/stable/README.md

Manually trigger code generation or provide a custom configuration file via the command line.

```bash
swift package --allow-writing-to-package-directory generate-code-for-resources
```

```bash
swift package --allow-writing-to-package-directory generate-code-for-resources --config MyConfig.yml
```

--------------------------------

### Using Generated Code in Swift

Source: https://context7.com/swiftgen/swiftgenplugin/llms.txt

Access generated assets, strings, and fonts using enums for type-safe access with IDE autocompletion. Ensure SwiftGenPlugin is configured for automatic generation.

```swift
import UIKit

class ProfileViewController: UIViewController {
    private let avatarImageView = UIImageView()
    private let nameLabel = UILabel()
    private let bioLabel = UILabel()

    override func viewDidLoad() {
        super.viewDidLoad()

        // Using generated asset catalogs (Assets.swift)
        avatarImageView.image = Asset.Icons.profilePlaceholder.image
        view.backgroundColor = Asset.Colors.background.color

        // Using generated localized strings (Strings.generated.swift)
        nameLabel.text = L10n.Profile.defaultName
        bioLabel.text = L10n.Profile.bio("John", 25)
        navigationItem.title = L10n.Profile.title

        // Using generated fonts (Fonts.swift)
        nameLabel.font = FontFamily.Roboto.bold.font(size: 18)
        bioLabel.font = FontFamily.Roboto.regular.font(size: 14)
    }

    func showError() {
        // Pluralization support via .stringsdict
        let errorMessage = L10n.Errors.itemCount(3)
        print(errorMessage)
    }
}
```

--------------------------------

### Environment Variables in SwiftGen Configuration

Source: https://context7.com/swiftgen/swiftgenplugin/llms.txt

Reference environment variables within your `swiftgen.yml` for dynamic path resolution and conditional generation. Available variables include PROJECT_DIR, TARGET_NAME, PRODUCT_MODULE_NAME, and DERIVED_SOURCES_DIR.

```yaml
# swiftgen.yml with environment variable usage
# Available environment variables:
#   ${PROJECT_DIR}        - Root directory of the package
#   ${TARGET_NAME}        - Name of the current target being built
#   ${PRODUCT_MODULE_NAME} - Module name of the target
#   ${DERIVED_SOURCES_DIR} - Plugin work directory for generated files

input_dir: ${PROJECT_DIR}/Sources/${TARGET_NAME}/Resources
output_dir: ${DERIVED_SOURCES_DIR}

strings:
  inputs:
    - en.lproj/Localizable.strings
  outputs:
    - templateName: structured-swift5
      output: ${TARGET_NAME}Strings.swift
      params:
        enumName: L10n
        publicAccess: true

xcassets:
  inputs:
    - Assets.xcassets
  outputs:
    templateName: swift5
    output: ${TARGET_NAME}Assets.swift
    params:
      enumName: Asset
      publicAccess: true
```

--------------------------------

### Add SwiftGenPlugin dependency

Source: https://github.com/swiftgen/swiftgenplugin/blob/stable/README.md

Include the SwiftGenPlugin package in your Package.swift dependencies.

```swift
  dependencies: [
    .package(url: "https://github.com/SwiftGen/SwiftGenPlugin", from: "6.6.0")
  ]
```

--------------------------------

### Add SwiftGenPlugin dependency to Package.swift

Source: https://context7.com/swiftgen/swiftgenplugin/llms.txt

Include the plugin in the dependencies and targets arrays of your Package.swift file to enable it for your package.

```swift
// Package.swift
import PackageDescription

let package = Package(
    name: "MyApp",
    platforms: [.iOS(.v15)],
    dependencies: [
        .package(url: "https://github.com/SwiftGen/SwiftGenPlugin", from: "6.6.0")
    ],
    targets: [
        .target(
            name: "MyApp",
            dependencies: [],
            plugins: [
                .plugin(name: "SwiftGenPlugin", package: "SwiftGenPlugin")
            ]
        )
    ]
)
```
Tokens:
Raw