Optional snapshot root directory gradle property

[brenpearson]

Allows the consumer of the Paparazzi library to specify where they want the snapshots to be saved. This includes creating a gradle plugin extension for Paparazzi with this property in it, we can add other configurable properties to this extension in future.

This can be set as shown in the consumer's gradle file

paparazzi {
    snapshotRootDirectory = file("where/I/want/the/snapshots")
}

[brenpearson]

Seems like in PrepareResourcesTask to add this as an InputDirectory the directory has to exist, so in that case I have to add this to create the snapshot directory here instead of waiting until the task to take/verify the snapshots. Thoughts on if this is fine?

[TWiStErRob]

you went from a Provider to a Provider that's resolved in configuration phase. This is happening too early here I think. I think this would be something like:

val snapshotOutputDir = extension.snapshotRootDirectory.orElse(project.layout.projectDirectory.dir("src/test/snapshots"))

and maybe that solves your need to create the dir too.

[TWiStErRob]

but it might be even better if the default was set up with snapshotRootDirectory.convention when the extension is registered:

val extension = project.extensions.create("paparazzi", PaparazziPluginExtension::class.java)
extension.snapshotRootDirectory.convention(project.layout.projectDirectory.dir("src/test/snapshots"))

[JavierSegoviaCordoba]

Is there any blocker for this PR?

[TWiStErRob]

try to use DirectoryProperty

[JavierSegoviaCordoba]

In Sqldelight I moved to ConfigurableFileCollection as a recommendation from @hfhbd to emulate how srcDirs works on Java and Kotlin Gradle plugins.

[TWiStErRob]

But this is a single output directory, srcDirs are multiple inputs, feels very different.

[JavierSegoviaCordoba]

@brenpearson do you still have interest in this?

I can fork your implementation if you lack of time to continue working on this.

[brenpearson]

@JavierSegoviaCordoba I'm not going to be able to update this within the next couple of weeks. If you have time then by all means, otherwise I'll come back and take a look in probably 2 weeks time 🙏

[JavierSegoviaCordoba]

Can I push on this branch or should I create a new PR? @brenpearson commits are preserved in both cases.

EDIT: As there are conflicts, I am going to create a different PR and I will share the link here.

[JavierSegoviaCordoba]

Updated PR with @TWiStErRob suggestion: #736