Runtime Swift5 - Swiftgen

Template Information

Name	Description
File name	plist/runtime-swift5.stencil
Configuration example	<pre>plist:
inputs: path/to/plist/dir-or-file
outputs:

templateName: runtime-swift5
output: Plist.swift</pre> |

When to use it

When you need to generate Swift 5 code.
Loads the data from the Plist file in the current bundle at runtime.
If you need other functionality, such as loading a file in your Documents folder, or handling Optional properties, you should write your own custom template (guide).

Customization

You can customize some elements of this template by overriding the following parameters when invoking swiftgen. See the dedicated documentation.

Parameter Name	Default Value	Description
`bundle`	`BundleToken.bundle`	Allows you to set from which bundle Plist files are loaded from. By default, it'll point to the same bundle as where the generated code is. Note: ignored if `lookupFunction` parameter is set.
`enumName`	`PlistFiles`	Allows you to change the name of the generated `enum` containing all files.
`forceFileNameEnum`	N/A	Setting this parameter will generate an `enum <FileName>` even if only one FileName was provided as input.
`lookupFunction`	N/A¹	Allows you to set your own custom lookup function. The function needs to have as signature: `(path: String) -> URL?`. The parameters of your function can have any name (or even no external name), but if it has named parameters, you must provide the complete function signature, including those named parameters – e.g. `myPlistFinder(path:)`. Note: if you define this parameter, the `bundle` parameter will be ignored.
`preservePath`	N/A	Setting this parameter will disable the basename filter applied to all file paths. Use this if you added your data folder as a "folder reference" in your Xcode project, making that folder hierarchy preserved once copied in the build app bundle. The path will be relative to the folder you provided to SwiftGen.
`publicAccess`	N/A	If set, the generated constants will be marked as `public`. Otherwise, they'll be declared `internal`.

If you don't provide a lookupFunction, we will use url(forResource:withExtension:) on the bundle parameter instead.

Generated Code

Extract:

swift

internal enum PlistFiles {
  internal enum Configuration {
    private static let _document = PlistDocument(path: "configuration.plist")
    internal static let environment: String = _document["Environment"]
    internal static let options: [String: Any] = _document["Options"]
  }
  internal enum ShoppingList {
    internal static let items: [String] = arrayFromPlist(at: "shopping-list.plist")
  }
}

Full generated code

Usage example

swift

// This will be an array
let foo = PlistFiles.ShoppingList.items

// This will be an String
let bar = PlistFiles.Configuration.environment