Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 2.32 KB

Watch-a-folder-for-changes.md

File metadata and controls

32 lines (19 loc) · 2.32 KB
Raw

Run SwiftGen every time a folder is changed

To use SwiftGen we recommend that you use a Script Build Phase to make sure your generated files are always in sync with your sources.

But as an alternative, you may be interested in watching a specific directory instead, and invoke swiftgen when files in this watched directory change.

  • Prevents you having to trigger a build to make your constants up-to-date after (for example) adding new files or strings. This is supposing that you start the watcher every time you start developing on you project to start the watching and auto-update of your files.
  • This can also be super useful if you plan to create your own custom templates, as it will allow you to watch your template file and iterate to check what the generated code looks like very time you modify and save your template, allowing some trial-and-error mode until you reach exactly the desired output.

If you're interested in such a solution, we recommend to use kicker which is a very handy and fully-configurable tool to watch files and folders and automatically execute custom commands and recipes when files are added, removed or modified.

Examples

Watch your project resources and regenerate constants every time they change

To watch your resources folder and regenerate the constants for them every time your files have changed, you can use:

kicker -e "swiftgen" /path/to/your/project/resources

Create a custom template and look at the generated code live as you edit and save it

And if you're writing a custom template, you can use a command similar to the following to watch the template file you're writing and auto-regenerate the output using that same template every time you modify it:

kicker -e "swiftgen xcassets --templatePath /path/to/my/custom/template.stencil --output test-output.swift /path/to/Images.xcassets" /path/to/my/custom/template.stencil

This use of kicker (or any other tool allowing to do similar watching of a folder) can allow you to edit custom templates like you use Swift Playgrounds: you can split your screen or your favorite text editor (Sublime Text, Atom, …) in 2 windows, one containing the template you edit, the other containing the output, and see the test output on the second window being updated live.