-
Notifications
You must be signed in to change notification settings - Fork 1
Add an ImagesLifecycleTask to pass options along to source set tasks
#75
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
45 changes: 45 additions & 0 deletions
45
plugin/src/main/kotlin/xyz/block/microfilm/ImagesLifecycleTask.kt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /* | ||
| * Copyright (C) 2026 Block, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package xyz.block.microfilm | ||
|
|
||
| import org.gradle.api.DefaultTask | ||
| import org.gradle.api.provider.ListProperty | ||
| import org.gradle.api.tasks.Internal | ||
| import org.gradle.api.tasks.options.Option | ||
| import org.gradle.work.DisableCachingByDefault | ||
|
|
||
| /** | ||
| * An empty task that acts as an aggregator for a group of source set tasks. | ||
| * | ||
| * Gradle binds options to the exact task named on the command line. So if you run something like: | ||
| * ``` | ||
| * ./gradlew compressMicrofilm --images drawable-mdpi/my_image.png | ||
| * ``` | ||
| * | ||
| * The --images argument will not automatically be passed on to the `compressMicrofilmMain` or | ||
| * `compressMicrofilmDebug` tasks. [ImagesLifecycleTask] exists to capture the arguments and expose | ||
| * them to the source set tasks | ||
| */ | ||
| @DisableCachingByDefault(because = "This task has no outputs of its own") | ||
| internal abstract class ImagesLifecycleTask : DefaultTask() { | ||
| @get:Internal | ||
| @get:Option( | ||
| option = "images", | ||
| description = | ||
| "Restrict the task to the images matching these glob patterns, relative to the res directory.", | ||
| ) | ||
| abstract val imagePatterns: ListProperty<String> | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One thing that we could also do to take this a step further is have
CompressTask,DecompressTask, andVerifyTaskall extend this base class instead ofDefaultTask, so they're all guaranteed to share the same--imagesoption.Or instead of extending
ImagesLifecycleTaskdirectly, we could make something like aHasImagesOptioninterface that the lifecycle and source set tasks all implement.