├── focus-gradle-plugin ├── src │ ├── test │ │ ├── projects │ │ │ ├── happy-path │ │ │ │ ├── module │ │ │ │ │ └── build.gradle │ │ │ │ ├── build.gradle │ │ │ │ ├── settings-all.gradle │ │ │ │ └── settings.gradle │ │ │ ├── missing-settings-all │ │ │ │ ├── module │ │ │ │ │ └── build.gradle │ │ │ │ ├── build.gradle │ │ │ │ └── settings.gradle │ │ │ └── configuration-cache-compatible │ │ │ │ ├── module │ │ │ │ └── build.gradle │ │ │ │ ├── settings-all.gradle │ │ │ │ ├── build.gradle │ │ │ │ └── settings.gradle │ │ └── kotlin │ │ │ └── com │ │ │ └── dropbox │ │ │ └── focus │ │ │ └── FocusPluginTest.kt │ └── main │ │ └── kotlin │ │ └── com │ │ └── dropbox │ │ └── focus │ │ ├── FocusExtension.kt │ │ ├── FocusSubExtension.kt │ │ ├── ClearFocusTask.kt │ │ ├── FocusTask.kt │ │ ├── CreateFocusSettingsTask.kt │ │ └── FocusPlugin.kt ├── settings.gradle.kts ├── gradle.properties ├── build.gradle.kts └── api │ └── focus-gradle-plugin.api ├── sample ├── lib1a │ └── build.gradle ├── lib1b │ └── build.gradle ├── lib2a │ └── build.gradle ├── lib2c │ └── build.gradle ├── lib-shared │ └── build.gradle ├── lib-moved │ └── build.gradle.kts ├── lib2b │ └── build.gradle ├── app1 │ └── build.gradle ├── signin │ └── build.gradle └── app2 │ └── build.gradle ├── gradle ├── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties └── libs.versions.toml ├── .editorconfig ├── settings.gradle ├── settings-all.gradle.kts ├── .gitignore ├── RELEASING.md ├── .github ├── scripts │ └── checksum.sh └── workflows │ └── publish.yml ├── CHANGELOG.md ├── gradlew.bat ├── README.md ├── gradlew └── LICENSE.txt /focus-gradle-plugin/src/test/projects/happy-path/module/build.gradle: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/missing-settings-all/module/build.gradle: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/configuration-cache-compatible/module/build.gradle: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/configuration-cache-compatible/settings-all.gradle: -------------------------------------------------------------------------------- 1 | include(":module") 2 | -------------------------------------------------------------------------------- /sample/lib1a/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.jvm") 3 | } 4 | 5 | dependencies { 6 | } 7 | -------------------------------------------------------------------------------- /sample/lib1b/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.jvm") 3 | } 4 | 5 | dependencies { 6 | } 7 | -------------------------------------------------------------------------------- /sample/lib2a/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.jvm") 3 | } 4 | 5 | dependencies { 6 | } 7 | -------------------------------------------------------------------------------- /sample/lib2c/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.jvm") 3 | } 4 | 5 | dependencies { 6 | } 7 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/happy-path/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | alias(libs.plugins.kotlin.jvm) 3 | } 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dropbox/focus/main/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /sample/lib-shared/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.jvm") 3 | } 4 | 5 | dependencies { 6 | } 7 | -------------------------------------------------------------------------------- /sample/lib-moved/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.jvm") 3 | } 4 | 5 | dependencies { 6 | } 7 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/missing-settings-all/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | alias(libs.plugins.kotlin.jvm) 3 | } 4 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/configuration-cache-compatible/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | alias(libs.plugins.kotlin.jvm) 3 | } 4 | -------------------------------------------------------------------------------- /sample/lib2b/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.jvm") 3 | } 4 | 5 | dependencies { 6 | implementation project(':sample:lib2c') 7 | } 8 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/happy-path/settings-all.gradle: -------------------------------------------------------------------------------- 1 | include(":module") 2 | 3 | project(":module").projectDir = new File(rootDir, "build/notnowhere") 4 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_size = 2 5 | charset = utf-8 6 | trim_trailing_whitespace = true 7 | insert_final_newline = true 8 | 9 | [*.{kt, kts}] 10 | kotlin_imports_layout = ascii -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /sample/app1/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.jvm") 3 | id("application") 4 | } 5 | 6 | dependencies { 7 | implementation project(':sample:lib-shared') 8 | implementation project(':sample:lib1a') 9 | implementation project(':sample:lib1b') 10 | } 11 | -------------------------------------------------------------------------------- /sample/signin/build.gradle: -------------------------------------------------------------------------------- 1 | // This sample demonstrates an empty project that 2 | // simply allows you to focus a subset of projects. 3 | 4 | configurations.create("deps") 5 | 6 | dependencies { 7 | deps(project(":sample:lib1b")) 8 | deps(project(":sample:lib2b")) 9 | } 10 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/happy-path/settings.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.dropbox.focus' 3 | } 4 | 5 | dependencyResolutionManagement { 6 | versionCatalogs { 7 | create("libs") { 8 | from(files("../../../../../gradle/libs.versions.toml")) 9 | } 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/missing-settings-all/settings.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.dropbox.focus' 3 | } 4 | 5 | dependencyResolutionManagement { 6 | versionCatalogs { 7 | create("libs") { 8 | from(files("../../../../../gradle/libs.versions.toml")) 9 | } 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | includeBuild('focus-gradle-plugin') 3 | } 4 | 5 | plugins { 6 | id("com.dropbox.focus") 7 | } 8 | 9 | focus { 10 | allSettingsFileName = "settings-all.gradle.kts" 11 | focusFileName = "settings-focus.gradle" 12 | } 13 | 14 | rootProject.name = "focus-root" 15 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/projects/configuration-cache-compatible/settings.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.dropbox.focus' 3 | } 4 | 5 | dependencyResolutionManagement { 6 | versionCatalogs { 7 | create("libs") { 8 | from(files("../../../../../gradle/libs.versions.toml")) 9 | } 10 | } 11 | } 12 | -------------------------------------------------------------------------------- /sample/app2/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("org.jetbrains.kotlin.jvm") 3 | id("application") 4 | } 5 | 6 | dependencies { 7 | implementation project(':sample:lib-shared') 8 | implementation project(':sample:lib2a') 9 | implementation project(':sample:lib2b') 10 | implementation project(':sample:moved') 11 | } 12 | -------------------------------------------------------------------------------- /settings-all.gradle.kts: -------------------------------------------------------------------------------- 1 | include(":sample:app1") 2 | include(":sample:app2") 3 | include(":sample:lib1a") 4 | include(":sample:lib1b") 5 | include(":sample:lib2a") 6 | include(":sample:lib2b") 7 | include(":sample:lib2c") 8 | include(":sample:lib-shared") 9 | include(":sample:signin") 10 | 11 | include(":sample:moved") 12 | project(":sample:moved").projectDir = File("sample/lib-moved") 13 | -------------------------------------------------------------------------------- /focus-gradle-plugin/settings.gradle.kts: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | google() 4 | mavenCentral() 5 | gradlePluginPortal() 6 | } 7 | } 8 | 9 | rootProject.name = "focus-gradle-plugin" 10 | 11 | dependencyResolutionManagement { 12 | versionCatalogs { 13 | create("libs") { 14 | from(files("../gradle/libs.versions.toml")) 15 | } 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .classpath 2 | .gradle 3 | .project 4 | .settings 5 | eclipsebin 6 | 7 | bin 8 | gen 9 | build 10 | out 11 | lib 12 | reports 13 | 14 | settings-focus.gradle 15 | **/.focus 16 | 17 | .idea 18 | *.iml 19 | *.ipr 20 | *.iws 21 | classes 22 | local.properties 23 | 24 | obj 25 | 26 | .DS_Store 27 | 28 | node_modules 29 | 30 | # Special Mkdocs files 31 | docs/3.x 32 | docs/changelog.md 33 | docs/contributing.md 34 | -------------------------------------------------------------------------------- /RELEASING.md: -------------------------------------------------------------------------------- 1 | Releasing 2 | ========= 3 | 4 | 1. Change the version in `focus-gradle-plugin/gradle.properties` to a non-SNAPSHOT version. 5 | 2. Update the `CHANGELOG.md` for the impending release. 6 | 3. `git commit -am "Prepare for release X.Y.Z."` (where X.Y.Z is the new version) 7 | 4. `git tag -a X.Y.Z -m "Version X.Y.Z"` (where X.Y.Z is the new version) 8 | 5. `git push && git push --tags` to trigger CI to deploy the release. 9 | 7. Update the `gradle.properties` to the next SNAPSHOT version. 10 | 8. `git commit -am "Prepare next development version."` 11 | 9. `git push && git push --tags` 12 | -------------------------------------------------------------------------------- /.github/scripts/checksum.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | RESULT_FILE=$1 4 | 5 | if [[ -f ${RESULT_FILE} ]]; then 6 | rm ${RESULT_FILE} 7 | fi 8 | touch ${RESULT_FILE} 9 | 10 | checksum_file() { 11 | echo $(openssl md5 $1 | awk '{print $2}') 12 | } 13 | 14 | FILES=() 15 | while read -r -d ''; do 16 | FILES+=("$REPLY") 17 | done < <(find ../.. -type f \( -name "build.gradle*" -o -name "settings.gradle*" -o -name "gradle-wrapper.properties" \) -print0) 18 | 19 | # Loop through files and append MD5 to result file 20 | for FILE in ${FILES[@]}; do 21 | echo $(checksum_file ${FILE}) >> ${RESULT_FILE} 22 | done 23 | # Now sort the file so that it is idempotent. 24 | sort ${RESULT_FILE} -o ${RESULT_FILE} 25 | -------------------------------------------------------------------------------- /gradle/libs.versions.toml: -------------------------------------------------------------------------------- 1 | [versions] 2 | kotlin = "1.9.20" 3 | 4 | [libraries] 5 | junit = "junit:junit:4.13" 6 | truth = "com.google.truth:truth:1.1.3" 7 | kotlin-bom = { module = "org.jetbrains.kotlin:kotlin-bom", version.ref = "kotlin" } 8 | kotlin-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" } 9 | 10 | [plugins] 11 | dokka = { id = "org.jetbrains.dokka", version.ref = "kotlin" } 12 | kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" } 13 | mavenPublish = { id = "com.vanniktech.maven.publish", version = "0.29.0" } 14 | binaryCompatibilityValidator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version = "0.14.0" } 15 | 16 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/main/kotlin/com/dropbox/focus/FocusExtension.kt: -------------------------------------------------------------------------------- 1 | package com.dropbox.focus 2 | 3 | import javax.inject.Inject 4 | import org.gradle.api.model.ObjectFactory 5 | import org.gradle.api.provider.Property 6 | import org.gradle.kotlin.dsl.property 7 | 8 | private const val DEFAULT_FOCUS_FILENAME = ".focus" 9 | private const val DEFAULT_ALL_SETTINGS_FILENAME = "settings-all.gradle" 10 | 11 | public abstract class FocusExtension @Inject constructor(objects: ObjectFactory) { 12 | 13 | public val focusFileName: Property = objects.property().convention(DEFAULT_FOCUS_FILENAME) 14 | 15 | public val allSettingsFileName: Property = objects.property().convention(DEFAULT_ALL_SETTINGS_FILENAME) 16 | 17 | } 18 | -------------------------------------------------------------------------------- /focus-gradle-plugin/gradle.properties: -------------------------------------------------------------------------------- 1 | GROUP=com.dropbox.focus 2 | VERSION_NAME=0.7.1-SNAPSHOT 3 | 4 | POM_ARTIFACT_ID=focus 5 | POM_NAME=Focus 6 | POM_DESCRIPTION=A Gradle plugin that helps you speed up builds by excluding unnecessary modules. 7 | POM_PACKAGING=jar 8 | 9 | POM_URL=https://github.com/dropbox/focus 10 | POM_SCM_URL=https://github.com/dropbox/focus 11 | POM_SCM_CONNECTION=scm:git:git://github.com/dropbox/focus.git 12 | POM_SCM_DEV_CONNECTION=scm:git:ssh://git@github.com/dropbox/focus.git 13 | 14 | POM_LICENCE_NAME=The Apache Software License, Version 2.0 15 | POM_LICENCE_URL=https://www.apache.org/licenses/LICENSE-2.0.txt 16 | POM_LICENCE_DIST=repo 17 | 18 | POM_DEVELOPER_ID=dropbox 19 | POM_DEVELOPER_NAME=Dropbox, Inc. 20 | POM_DEVELOPER_URL=https://github.com/dropbox 21 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/main/kotlin/com/dropbox/focus/FocusSubExtension.kt: -------------------------------------------------------------------------------- 1 | package com.dropbox.focus 2 | 3 | import org.gradle.api.model.ObjectFactory 4 | import org.gradle.api.provider.Property 5 | import org.gradle.kotlin.dsl.property 6 | import javax.inject.Inject 7 | import org.gradle.api.file.ProjectLayout 8 | import org.gradle.api.file.RegularFileProperty 9 | 10 | public abstract class FocusSubExtension @Inject constructor( 11 | layout: ProjectLayout, 12 | objects: ObjectFactory 13 | ) { 14 | 15 | public val focusSettingsFile: RegularFileProperty = objects.fileProperty().convention( 16 | layout.buildDirectory.file("focus.settings.gradle") 17 | ) 18 | 19 | public val moduleToDirMapFile: RegularFileProperty = objects.fileProperty().convention( 20 | layout.buildDirectory.file("moduleToDirMap.csv") 21 | ) 22 | } 23 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/main/kotlin/com/dropbox/focus/ClearFocusTask.kt: -------------------------------------------------------------------------------- 1 | package com.dropbox.focus 2 | 3 | import java.io.File 4 | import org.gradle.api.DefaultTask 5 | import org.gradle.api.file.RegularFileProperty 6 | import org.gradle.api.provider.Property 7 | import org.gradle.api.provider.Provider 8 | import org.gradle.api.tasks.CacheableTask 9 | import org.gradle.api.tasks.Input 10 | import org.gradle.api.tasks.TaskAction 11 | 12 | @CacheableTask 13 | public abstract class ClearFocusTask : DefaultTask() { 14 | 15 | @get:Input 16 | public abstract val focusFilePath: Property 17 | 18 | @TaskAction 19 | public fun clearFocus() { 20 | val focusFile = File(focusFilePath.get()) 21 | if (focusFile.exists()) { 22 | focusFile.delete() 23 | } 24 | } 25 | 26 | public companion object { 27 | public operator fun invoke( 28 | focusFileName: Provider 29 | ): ClearFocusTask.() -> Unit = { 30 | group = FOCUS_TASK_GROUP 31 | this.focusFilePath.set( 32 | project.rootProject.layout.file(focusFileName.map { File(it) }).map { it.asFile.absolutePath } 33 | ) 34 | } 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/main/kotlin/com/dropbox/focus/FocusTask.kt: -------------------------------------------------------------------------------- 1 | package com.dropbox.focus 2 | 3 | import org.gradle.api.DefaultTask 4 | import org.gradle.api.file.DirectoryProperty 5 | import org.gradle.api.file.RegularFile 6 | import org.gradle.api.file.RegularFileProperty 7 | import org.gradle.api.provider.Property 8 | import org.gradle.api.provider.Provider 9 | import org.gradle.api.tasks.Input 10 | import org.gradle.api.tasks.InputDirectory 11 | import org.gradle.api.tasks.InputFile 12 | import org.gradle.api.tasks.OutputFile 13 | import org.gradle.api.tasks.TaskAction 14 | 15 | public abstract class FocusTask : DefaultTask() { 16 | 17 | @get:InputDirectory 18 | public abstract val rootProjectDir: DirectoryProperty 19 | 20 | @get:InputFile 21 | public abstract val moduleSettingsFile: RegularFileProperty 22 | 23 | @get:Input 24 | public abstract val rootFocusFileName: Property 25 | 26 | @get:OutputFile 27 | public abstract val focusFile: RegularFileProperty 28 | 29 | @TaskAction 30 | public fun focus() { 31 | focusFile.get().asFile.writer().use { writer -> 32 | writer.write(moduleSettingsFile.get().asFile.toRelativeString(rootProjectDir.get().asFile)) 33 | } 34 | } 35 | 36 | public companion object { 37 | public operator fun invoke( 38 | moduleSettingsFile: Provider, 39 | rootFocusFileName: Provider, 40 | ): FocusTask.() -> Unit = { 41 | group = FOCUS_TASK_GROUP 42 | 43 | this.rootProjectDir.set(project.rootProject.layout.projectDirectory) 44 | this.moduleSettingsFile.set(moduleSettingsFile) 45 | this.rootFocusFileName.set(rootFocusFileName) 46 | focusFile.set(project.rootProject.layout.projectDirectory.file(rootFocusFileName)) 47 | } 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | ## Version 0.7.0 4 | 5 | _2024-10-17_ 6 | 7 | * Updates build script generation to avoid files that are too large. (Thanks [@Mexator]) [#50](https://github.com/dropbox/focus/pull/50) 8 | 9 | ## Version 0.6.0 10 | 11 | _2024-06-06_ 12 | 13 | * Supports Windows file path separator (Thanks [@SimonMarquis]!) [#36](https://github.com/dropbox/focus/pull/36) 14 | * Adds support for Gradle 8.x. [#48](https://github.com/dropbox/focus/pull/48) 15 | 16 | ## Version 0.5.1 17 | 18 | _2022-05-19_ 19 | 20 | * Fix KGP dependency configuration. (Thanks [@ZacSweers]!) [#28](https://github.com/dropbox/focus/pull/28) 21 | 22 | ## Version 0.5.0 23 | 24 | _2022-05-18_ 25 | 26 | * Fixes issue with invalid escape characters in Windows path names. [#25](https://github.com/dropbox/focus/issues/25) 27 | * Adds tests [#16](https://github.com/dropbox/focus/pull/16) 28 | * Updates JVM release version [#15](https://github.com/dropbox/focus/pull/15) 29 | * Updates project references to use task inputs so tasks are compatible with Configuration Cache [#13](https://github.com/dropbox/focus/pull/13) 30 | 31 | ## Version 0.4.0 32 | 33 | _2022-03-10_ 34 | 35 | * Fix issue with transitive dependencies not get properly added to focus by [@joshafeinberg](https://github.com/joshafeinberg) in [#9](https://github.com/dropbox/focus/pull/9) 36 | 37 | ## Version 0.3.0 38 | 39 | _2022-03-07_ 40 | 41 | * Disable configuration caching on CreateFocusSettingsTask by [@ZacSweers](https://github.com/ZacSweers) in [#3](https://github.com/dropbox/focus/pull/3) 42 | * Fixes issue causing self resolving project dependencies to fail to be included. by [@rharter](https://github.com/rharter) in [#6](https://github.com/dropbox/focus/pull/6) 43 | * Update to new Sonatype host by [@changusmc](https://github.com/changusmc) in [#7](https://github.com/dropbox/focus/pull/7) 44 | 45 | ## Version 0.2.0 46 | 47 | _2022-02-10_ 48 | 49 | * Initial public release! 50 | -------------------------------------------------------------------------------- /focus-gradle-plugin/build.gradle.kts: -------------------------------------------------------------------------------- 1 | import com.vanniktech.maven.publish.SonatypeHost 2 | import org.jetbrains.kotlin.gradle.tasks.KotlinCompile 3 | 4 | plugins { 5 | `kotlin-dsl` 6 | `java-gradle-plugin` 7 | alias(libs.plugins.kotlin.jvm) 8 | alias(libs.plugins.dokka) 9 | alias(libs.plugins.mavenPublish) 10 | alias(libs.plugins.binaryCompatibilityValidator) 11 | } 12 | 13 | buildscript { 14 | repositories { 15 | mavenCentral() 16 | gradlePluginPortal() 17 | } 18 | } 19 | 20 | repositories { 21 | mavenCentral() 22 | gradlePluginPortal() 23 | } 24 | 25 | tasks.withType().configureEach { 26 | kotlinOptions { 27 | jvmTarget = "1.8" 28 | // Because Gradle's Kotlin handling is stupid, this falls out of date quickly 29 | apiVersion = "1.5" 30 | languageVersion = "1.5" 31 | } 32 | } 33 | 34 | java { 35 | toolchain { 36 | languageVersion.set(JavaLanguageVersion.of(11)) 37 | } 38 | } 39 | 40 | tasks.withType().configureEach { 41 | options.release.set(8) 42 | } 43 | 44 | kotlin { 45 | explicitApi() 46 | } 47 | 48 | gradlePlugin { 49 | plugins { 50 | plugins.create("focus") { 51 | id = "com.dropbox.focus" 52 | implementationClass = "com.dropbox.focus.FocusPlugin" 53 | } 54 | } 55 | } 56 | 57 | mavenPublishing { 58 | publishToMavenCentral(SonatypeHost.S01, true) 59 | signAllPublications() 60 | } 61 | 62 | dependencies { 63 | compileOnly(gradleApi()) 64 | implementation(platform(libs.kotlin.bom)) 65 | // Don't impose our version of KGP on consumers 66 | compileOnly(libs.kotlin.plugin) 67 | 68 | testImplementation(gradleTestKit()) 69 | testImplementation(platform(libs.kotlin.bom)) 70 | testImplementation(libs.kotlin.plugin) 71 | testImplementation(libs.junit) 72 | testImplementation(libs.truth) 73 | } 74 | 75 | tasks.register("printVersionName") { 76 | doLast { 77 | val VERSION_NAME: String by project 78 | println(VERSION_NAME) 79 | } 80 | } 81 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | 3 | on: 4 | push: 5 | branches: 6 | - main 7 | pull_request: 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | steps: 13 | - name: Checkout 14 | uses: actions/checkout@v4 15 | 16 | - name: Gradle Wrapper Validation 17 | uses: gradle/actions/wrapper-validation@v4 18 | 19 | - name: Install JDK 11 20 | uses: actions/setup-java@v4 21 | with: 22 | distribution: 'zulu' 23 | java-version: 11 24 | 25 | - name: Setup Gradle 26 | uses: gradle/actions/setup-gradle@v4 27 | 28 | - name: Test Plugin 29 | run: ./gradlew -p focus-gradle-plugin clean check --no-daemon --stacktrace 30 | 31 | - name: (Fail-only) Bundle test reports 32 | if: failure() 33 | run: find . -type d -name 'reports' | zip -@ -r build-reports.zip 34 | 35 | - name: (Fail-only) Upload the build report 36 | if: failure() 37 | uses: actions/upload-artifact@v4 38 | with: 39 | name: error-report 40 | path: build-reports.zip 41 | 42 | publish: 43 | runs-on: ubuntu-latest 44 | if: github.repository == 'dropbox/focus' && github.ref == 'refs/heads/main' && github.event_name != 'pull_request' 45 | needs: [build] 46 | steps: 47 | - name: Checkout 48 | uses: actions/checkout@v2 49 | 50 | - name: Install JDK 11 51 | uses: actions/setup-java@v4 52 | with: 53 | distribution: 'zulu' 54 | java-version: 11 55 | 56 | - name: Setup Gradle 57 | uses: gradle/actions/setup-gradle@v4 58 | 59 | - name: Publish release 60 | run: ./gradlew -p focus-gradle-plugin clean publish --no-daemon --no-parallel --no-configuration-cache --stacktrace 61 | env: 62 | ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }} 63 | ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }} 64 | ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }} 65 | ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }} 66 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/main/kotlin/com/dropbox/focus/CreateFocusSettingsTask.kt: -------------------------------------------------------------------------------- 1 | package com.dropbox.focus 2 | 3 | import org.gradle.api.DefaultTask 4 | import org.gradle.api.Project 5 | import org.gradle.api.artifacts.ProjectDependency 6 | import org.gradle.api.file.RegularFileProperty 7 | import org.gradle.api.tasks.OutputFile 8 | import org.gradle.api.tasks.TaskAction 9 | import org.gradle.work.DisableCachingByDefault 10 | 11 | @DisableCachingByDefault(because = "Not worth caching") 12 | public abstract class CreateFocusSettingsTask : DefaultTask() { 13 | 14 | @get:OutputFile 15 | public abstract val settingsFile: RegularFileProperty 16 | 17 | @get:OutputFile 18 | public abstract val modulesToDirMapFile: RegularFileProperty 19 | 20 | init { 21 | outputs.upToDateWhen { false } 22 | } 23 | 24 | @TaskAction 25 | public fun createFocusSettings() { 26 | val dependencies = project.collectDependencies().sortedBy { it.path } 27 | 28 | // generate CSV mapping from module name to its absolute path 29 | modulesToDirMapFile.get().asFile.writer().use { writer -> 30 | 31 | dependencies 32 | .forEach { dep -> 33 | val projectPath = dep.path 34 | val projectDir = dep.projectDir 35 | writer.appendLine("$projectPath,$projectDir") 36 | } 37 | } 38 | 39 | settingsFile.get().asFile.writer().use { writer -> 40 | writer.write("// ${project.path} specific settings\n") 41 | writer.appendLine("//") 42 | writer.appendLine("// This file is autogenerated by the focus task. Changes will be overwritten.") 43 | writer.appendLine() 44 | 45 | // language=groovy 46 | writer.append( 47 | """ 48 | File f = new File('${modulesToDirMapFile.get().asFile.absolutePath}') 49 | if (f.exists()) { 50 | f.eachLine { line -> 51 | var values = line.split(",") 52 | var module = values[0] 53 | var path = values[1] 54 | include(module) 55 | project(module).projectDir = new File(path) 56 | } 57 | } 58 | """.trimIndent() 59 | ) 60 | } 61 | } 62 | 63 | private fun Project.collectDependencies(): Set { 64 | val result = mutableSetOf() 65 | fun addDependent(project: Project) { 66 | val configuredProject = this.evaluationDependsOn(project.path) 67 | if (result.add(configuredProject)) { 68 | configuredProject.configurations.forEach { config -> 69 | config.dependencies 70 | .filterIsInstance() 71 | .map { it.dependencyProject } 72 | .forEach(::addDependent) 73 | } 74 | } 75 | } 76 | 77 | addDependent(this) 78 | return result 79 | } 80 | 81 | public companion object { 82 | public operator fun invoke(subExtension: FocusSubExtension): CreateFocusSettingsTask.() -> Unit = { 83 | group = FOCUS_TASK_GROUP 84 | settingsFile.set(subExtension.focusSettingsFile) 85 | modulesToDirMapFile.set(subExtension.moduleToDirMapFile) 86 | notCompatibleWithConfigurationCache("This reads configurations from the project at action-time.") 87 | } 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /focus-gradle-plugin/api/focus-gradle-plugin.api: -------------------------------------------------------------------------------- 1 | public abstract class com/dropbox/focus/ClearFocusTask : org/gradle/api/DefaultTask { 2 | public static final field Companion Lcom/dropbox/focus/ClearFocusTask$Companion; 3 | public fun ()V 4 | public final fun clearFocus ()V 5 | public abstract fun getFocusFilePath ()Lorg/gradle/api/provider/Property; 6 | } 7 | 8 | public final class com/dropbox/focus/ClearFocusTask$Companion { 9 | public final fun invoke (Lorg/gradle/api/provider/Provider;)Lkotlin/jvm/functions/Function1; 10 | } 11 | 12 | public abstract class com/dropbox/focus/CreateFocusSettingsTask : org/gradle/api/DefaultTask { 13 | public static final field Companion Lcom/dropbox/focus/CreateFocusSettingsTask$Companion; 14 | public fun ()V 15 | public final fun createFocusSettings ()V 16 | public abstract fun getModulesToDirMapFile ()Lorg/gradle/api/file/RegularFileProperty; 17 | public abstract fun getSettingsFile ()Lorg/gradle/api/file/RegularFileProperty; 18 | } 19 | 20 | public final class com/dropbox/focus/CreateFocusSettingsTask$Companion { 21 | public final fun invoke (Lcom/dropbox/focus/FocusSubExtension;)Lkotlin/jvm/functions/Function1; 22 | } 23 | 24 | public abstract class com/dropbox/focus/FocusExtension { 25 | public fun (Lorg/gradle/api/model/ObjectFactory;)V 26 | public final fun getAllSettingsFileName ()Lorg/gradle/api/provider/Property; 27 | public final fun getFocusFileName ()Lorg/gradle/api/provider/Property; 28 | } 29 | 30 | public final class com/dropbox/focus/FocusPlugin : org/gradle/api/Plugin { 31 | public fun ()V 32 | public synthetic fun apply (Ljava/lang/Object;)V 33 | public fun apply (Lorg/gradle/api/initialization/Settings;)V 34 | } 35 | 36 | public final class com/dropbox/focus/FocusPlugin$apply$1$1$1$1$inlined$sam$i$org_gradle_api_Action$0 : org/gradle/api/Action { 37 | public fun (Lkotlin/jvm/functions/Function1;)V 38 | public final synthetic fun execute (Ljava/lang/Object;)V 39 | } 40 | 41 | public final class com/dropbox/focus/FocusPlugin$apply$1$1$1$inlined$sam$i$org_gradle_api_Action$0 : org/gradle/api/Action { 42 | public fun (Lkotlin/jvm/functions/Function1;)V 43 | public final synthetic fun execute (Ljava/lang/Object;)V 44 | } 45 | 46 | public abstract class com/dropbox/focus/FocusSubExtension { 47 | public fun (Lorg/gradle/api/file/ProjectLayout;Lorg/gradle/api/model/ObjectFactory;)V 48 | public final fun getFocusSettingsFile ()Lorg/gradle/api/file/RegularFileProperty; 49 | public final fun getModuleToDirMapFile ()Lorg/gradle/api/file/RegularFileProperty; 50 | } 51 | 52 | public abstract class com/dropbox/focus/FocusTask : org/gradle/api/DefaultTask { 53 | public static final field Companion Lcom/dropbox/focus/FocusTask$Companion; 54 | public fun ()V 55 | public final fun focus ()V 56 | public abstract fun getFocusFile ()Lorg/gradle/api/file/RegularFileProperty; 57 | public abstract fun getModuleSettingsFile ()Lorg/gradle/api/file/RegularFileProperty; 58 | public abstract fun getRootFocusFileName ()Lorg/gradle/api/provider/Property; 59 | public abstract fun getRootProjectDir ()Lorg/gradle/api/file/DirectoryProperty; 60 | } 61 | 62 | public final class com/dropbox/focus/FocusTask$Companion { 63 | public final fun invoke (Lorg/gradle/api/provider/Provider;Lorg/gradle/api/provider/Provider;)Lkotlin/jvm/functions/Function1; 64 | } 65 | 66 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/main/kotlin/com/dropbox/focus/FocusPlugin.kt: -------------------------------------------------------------------------------- 1 | package com.dropbox.focus 2 | 3 | import org.gradle.api.Plugin 4 | import org.gradle.api.initialization.Settings 5 | import org.gradle.kotlin.dsl.apply 6 | import org.gradle.kotlin.dsl.create 7 | import org.gradle.kotlin.dsl.register 8 | 9 | internal const val FOCUS_TASK_GROUP = "focus mode" 10 | internal const val CREATE_FOCUS_SETTINGS_TASK_NAME = "createFocusSettings" 11 | internal const val FOCUS_TASK_NAME = "focus" 12 | internal const val CLEAR_FOCUS_TASK_NAME = "clearFocus" 13 | internal val TASK_NAMES = setOf( 14 | CREATE_FOCUS_SETTINGS_TASK_NAME, 15 | FOCUS_TASK_NAME, 16 | CLEAR_FOCUS_TASK_NAME, 17 | ) 18 | 19 | /** 20 | * A Gradle plugin that generates module-specific `settings.gradle` files, allowing you to focus on a specific 21 | * feature or module without needing to sync the rest of your monorepo. 22 | * 23 | * It works by evaluating your project setup and creating a unique `settings.gradle` file for the module you want 24 | * to focus on, which only includes the dependencies required by that module. It then creates a `.focus` file that 25 | * references the currently focused module. 26 | * 27 | * With these files in place only the modules that you need will be configured by Gradle when you sync your project. 28 | * Deleting the `.focus` file, which can be done using the `clearFocus` task, will revert to using the includes file 29 | * to configure your entire project. 30 | * 31 | * This is optionally configurable vai the [focus][FocusExtension] extension. 32 | * 33 | * ```kotlin 34 | * focus { 35 | * // The name of the settings file that contains all of your standard `include` statements. 36 | * allSettingsFileName = "settings-all.gradle" // Default 37 | * 38 | * // The name of the file in your root project that identifies the generated settings file to use. 39 | * // This should be added to your .gitignore file. 40 | * focusFileName = ".focus" // Default 41 | * } 42 | * ``` 43 | * 44 | * The general workflow is: 45 | * 46 | * 1. Focus on the module you'd like to work in by running it's `focus` task. 47 | * 2. Repeat step 1 as you work in other modules. 48 | * 3. Either delete the `.focus` file, or call the `clearFocus` task to stop focusing. 49 | */ 50 | public class FocusPlugin : Plugin { 51 | override fun apply(target: Settings): Unit = target.run { 52 | val extension = extensions.create("focus") 53 | 54 | gradle.settingsEvaluated { 55 | val requestingFocusTask = startParameter.taskNames 56 | .map { it.substringAfterLast(":") } 57 | .any { it in TASK_NAMES } 58 | 59 | val focusFile = rootDir.resolve(extension.focusFileName.get()) 60 | if (!requestingFocusTask && focusFile.exists()) { 61 | apply(from = rootDir.resolve(focusFile.readText())) 62 | } else { 63 | apply(from = extension.allSettingsFileName) 64 | } 65 | 66 | gradle.rootProject { 67 | tasks.register(CLEAR_FOCUS_TASK_NAME, ClearFocusTask( 68 | focusFileName = extension.focusFileName 69 | )) 70 | 71 | subprojects { 72 | val subExtension = extensions.create("focus") 73 | val createFocusSettingsTask = tasks 74 | .register(CREATE_FOCUS_SETTINGS_TASK_NAME, CreateFocusSettingsTask(subExtension)) 75 | 76 | tasks.register(FOCUS_TASK_NAME, FocusTask( 77 | moduleSettingsFile = createFocusSettingsTask.flatMap { it.settingsFile }, 78 | rootFocusFileName = extension.focusFileName, 79 | )) 80 | } 81 | } 82 | } 83 | } 84 | } 85 | -------------------------------------------------------------------------------- /focus-gradle-plugin/src/test/kotlin/com/dropbox/focus/FocusPluginTest.kt: -------------------------------------------------------------------------------- 1 | package com.dropbox.focus 2 | 3 | import com.google.common.truth.Truth.assertThat 4 | import java.io.File 5 | import java.util.regex.Pattern 6 | import org.gradle.testkit.runner.BuildResult 7 | import org.gradle.testkit.runner.GradleRunner 8 | import org.junit.Before 9 | import org.junit.Rule 10 | import org.junit.Test 11 | import org.junit.rules.TemporaryFolder 12 | 13 | class FocusPluginTest { 14 | @get:Rule val buildDir = TemporaryFolder() 15 | private lateinit var gradleRunner: GradleRunner 16 | 17 | @Before 18 | fun setup() { 19 | gradleRunner = GradleRunner.create() 20 | .withTestKitDir(buildDir.root) 21 | .withPluginClasspath() 22 | } 23 | 24 | @Test 25 | fun configurationCache() { 26 | val fixtureRoot = File("src/test/projects/configuration-cache-compatible") 27 | 28 | gradleRunner 29 | .withArguments("--configuration-cache", "clearFocus") 30 | .withProjectDir(fixtureRoot) 31 | .build() 32 | 33 | val result = gradleRunner 34 | .withArguments("--configuration-cache", "clearFocus") 35 | .withProjectDir(fixtureRoot) 36 | .build() 37 | 38 | assertThat(result.output).contains("Reusing configuration cache.") 39 | } 40 | 41 | @Test 42 | fun missingSettingsAll() { 43 | val fixtureRoot = File("src/test/projects/missing-settings-all") 44 | 45 | val firstRun = gradleRunner 46 | .withArguments("clearFocus") 47 | .runFixture(fixtureRoot) { buildAndFail() } 48 | 49 | assertThat(firstRun.output).contains("Could not read script") 50 | assertThat(firstRun.output).contains("as it does not exist.") 51 | } 52 | 53 | @Test 54 | fun allPathLiteralsAreSingleQuote() { 55 | val fixtureRoot = File("src/test/projects/happy-path") 56 | gradleRunner 57 | .withArguments(":module:focus") 58 | .runFixture(fixtureRoot) { build() } 59 | 60 | val focusFileContent = 61 | File("src/test/projects/happy-path/build/notnowhere/build/focus.settings.gradle").readText() 62 | // has at least one single-quote path literal 63 | assertThat(focusFileContent).matches(Pattern.compile(""".*new File\('.*'\).*""", Pattern.DOTALL)) 64 | // no double-quote path literals 65 | assertThat(focusFileContent).doesNotMatch(Pattern.compile(""".*new File\(".*"\).*""", Pattern.DOTALL)) 66 | } 67 | 68 | @Test 69 | fun happyPath_CsvCreated() { 70 | val fixtureRoot = File("src/test/projects/happy-path") 71 | 72 | gradleRunner 73 | .withArguments(":module:focus") 74 | .runFixture(fixtureRoot) { build() } 75 | 76 | val csvFileContents = File("src/test/projects/happy-path/build/notnowhere/build/moduleToDirMap.csv").readText() 77 | val absoluteFilePath = fixtureRoot.resolve("build/notnowhere").absolutePath.replace("\\", "\\\\") 78 | // language=csv 79 | assertThat(csvFileContents).contains(""":module,$absoluteFilePath""") 80 | } 81 | 82 | @Test 83 | fun happyPath_CsvRead() { 84 | val fixtureRoot = File("src/test/projects/happy-path") 85 | 86 | gradleRunner 87 | .withArguments(":module:focus") 88 | .runFixture(fixtureRoot) { build() } 89 | 90 | val csvFilePath = File("src/test/projects/happy-path/build/notnowhere/build/moduleToDirMap.csv").absolutePath 91 | val focusFileContent = File("src/test/projects/happy-path/build/notnowhere/build/focus.settings.gradle").readText() 92 | // language=groovy 93 | assertThat(focusFileContent).contains("""File f = new File('$csvFilePath')""") 94 | } 95 | 96 | private fun GradleRunner.runFixture( 97 | projectRoot: File, 98 | action: GradleRunner.() -> BuildResult, 99 | ): BuildResult { 100 | val settings = File(projectRoot, "settings.gradle") 101 | if (!settings.exists()) { 102 | settings.createNewFile() 103 | settings.deleteOnExit() 104 | } 105 | 106 | return withProjectDir(projectRoot).action() 107 | } 108 | } 109 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 🧘 Focus 2 | 3 | A Gradle plugin that generates module-specific `settings.gradle` files, allowing you to focus on a specific feature or module without needing to sync the rest of your monorepo. 4 | 5 | The Focus plugin evaluates your project setup and creates a unique `settings.gradle` file for the module you want to focus on, which only includes the dependencies required by that module. It then creates a `.focus` file that references the currently focused module. 6 | 7 | With these files in place only the modules that you need will be configured by Gradle when you sync your project. Deleting the `.focus` file, which can be done using the `clearFocus` task, will revert to using the includes file to configure your entire project. 8 | 9 | ### Setup 10 | 11 | Apply the plugin in your `settings.gradle` file. 12 | 13 | ```groovy 14 | // settings.gradle(.kts) 15 | pluginManagement { 16 | repositories { 17 | mavenCentral() 18 | gradlePluginPortal() 19 | } 20 | } 21 | 22 | plugins { 23 | id("com.dropbox.focus") version "0.4.0" 24 | } 25 | ``` 26 | 27 | Note that the plugin is currently published to Maven Central, so you need to add it to the repositories list in the `pluginsManagement` block. 28 | 29 | Move all non-required `include` statements into `settings-all.gradle`. Projects that are always included can remain in your main `settings.gradle` file. 30 | 31 | ```groovy 32 | // settings-all.gradle(.kts) 33 | include ':sample:app2' 34 | include ':sample:lib2c' 35 | include ':sample:lib-shared' 36 | 37 | include ':sample:moved' 38 | project(':sample:moved').projectDir = new File("sample/lib-moved") 39 | ``` 40 | 41 | Optionally configure the plugin if you'd like to use different settings files than the defaults: 42 | 43 | ```groovy 44 | // settings.gradle 45 | focus { 46 | // The name of the settings file 47 | allSettingsFileName = "settings-all.gradle" // Default 48 | focusFileName = ".focus" // Default 49 | } 50 | ``` 51 | 52 | ```kotlin 53 | // settings.gradle.kts 54 | configure { 55 | // The name of the settings file 56 | allSettingsFileName.set("settings-all.gradle") // Default 57 | focusFileName.set(".focus") // Default 58 | } 59 | ``` 60 | 61 | Whether or not you configure a custom focus file, it should be added to your `.gitignore` file as it's meant for a specific developer's workflow. 62 | 63 | ## Usage 64 | 65 | The Focus plugin adds a few tasks for you to interact with in your Gradle builds. Using these tasks you can create module specific settings files that will be automatically used by Gradle to configure only the modules which are required. 66 | 67 | For example, say you're currently working on the app module `:sample:app2` and only need to run that module and its dependencies. You can use the following flow to reduce the number of modules that are loaded and synced into your IDE to speed up development. 68 | 69 | ```shell 70 | # When you start work on the app2 module, bring it into focus 71 | ./gradlew :sample:app2:focus 72 | 73 | # Click the Sync Elephant to have your IDE reload the gradle config, and you'll only have 74 | # :sample:app2 and it's dependencies loaded by the IDE, allowing you to build and run the sample app 75 | # and it's tests without having to sync the rest of the project. 76 | 77 | # If you want to spend time in a specific dependency, you can bring that into focus and sync your 78 | # IDE for even more fine grained development 79 | ./gradlew :sample:lib2b:focus 80 | 81 | # When you want to clear focus and get back to the entire project, simply use the clearFocus task. 82 | ./gradlew clearFocus 83 | ``` 84 | 85 | ## Tasks 86 | 87 | ### focus 88 | 89 | A `focus` task is added to all subprojects, and allows you to focus on just that module. 90 | 91 | ### createFocusSettings 92 | 93 | A `createFocusSettings` task is created for each subproject, and is responsible for finding a 94 | module's dependencies and creating a module-specific settings file. This is a dependency of the 95 | `focus` task and likely not necessary to call on its own. 96 | 97 | ### clearFocus 98 | 99 | A `clearFocus` task is added to the root project, and allows you to remove any previously focused 100 | modules. 101 | 102 | ## License 103 | 104 | Copyright (c) 2022 Dropbox, Inc. 105 | 106 | Licensed under the Apache License, Version 2.0 (the "License"); 107 | you may not use this file except in compliance with the License. 108 | You may obtain a copy of the License at 109 | 110 | http://www.apache.org/licenses/LICENSE-2.0 111 | 112 | Unless required by applicable law or agreed to in writing, software 113 | distributed under the License is distributed on an "AS IS" BASIS, 114 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 115 | See the License for the specific language governing permissions and 116 | limitations under the License. 117 | 118 | 119 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Use "xargs" to parse quoted args. 209 | # 210 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 211 | # 212 | # In Bash we could simply go: 213 | # 214 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 215 | # set -- "${ARGS[@]}" "$@" 216 | # 217 | # but POSIX shell has neither arrays nor command substitution, so instead we 218 | # post-process each arg (as a line of input to sed) to backslash-escape any 219 | # character that might be a shell metacharacter, then use eval to reverse 220 | # that process (while maintaining the separation between arguments), and wrap 221 | # the whole thing up as a single "set" statement. 222 | # 223 | # This will of course break if any of these variables contains a newline or 224 | # an unmatched quote. 225 | # 226 | 227 | eval "set -- $( 228 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 229 | xargs -n1 | 230 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 231 | tr '\n' ' ' 232 | )" '"$@"' 233 | 234 | exec "$JAVACMD" "$@" 235 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS --------------------------------------------------------------------------------