Automate the TODO format check and fix older format

config/detekt/detekt.yml

@@ -590,9 +590,9 @@ style:
                 value: 'FIXME:'
             -   reason: 'Forbidden STOPSHIP todo marker in comment, please address the problem before shipping the code.'
                 value: 'STOPSHIP:'
-            -   reason: 'TODO comments must reference a GitHub issue for tracking. Format: TODO(https://github.com/google/ground-android/issues/IssueNumber).'
-                value: '(TODO|TODO\(|TODO\(#)'
-        allowedPatterns: '^TODO\(https://github\.com/google/ground-android/issues/\d+\): .+'
+            -   reason: 'TODO comments must reference a GitHub issue for tracking. Format: TODO: and Issue URL: in next line.'
+                value: 'TODO:'
+        allowedPatterns: '^//\s*TODO:\s+.+'
     ForbiddenImport:
         active: false
         imports: [ ]

ground/build.gradle

@@ -79,7 +79,8 @@ android {
         minSdkVersion rootProject.androidMinSdk
         targetSdkVersion rootProject.androidTargetSdk
 
-        // TODO(https://github.com/google/ground-android/pull/985): Calculate version code manually
+        // TODO: Calculate version code manually
+        // Issue URL: https://github.com/google/ground-android/pull/985
         versionCode gitVersioner.versionCode
         versionName gitVersioner.versionName + " " + getCommitSha1()
         testInstrumentationRunner "com.google.android.ground.CustomTestRunner"
@@ -358,7 +359,8 @@ dependencies {
 
     implementation "com.google.guava:guava:33.0.0-android"
 
-    // TODO(https://github.com/google/ground-android/issues/1748): Move protos into shared module and set correct path here.
+    // TODO: Move protos into shared module and set correct path here.
+    // Issue URL: https://github.com/google/ground-android/issues/1748
     api("com.google.protobuf:protobuf-kotlin-lite:4.26.1")
 
     // Pulls protodefs from the specified commit in the ground-platform repo.

ground/src/main/java/com/google/android/ground/Config.kt

@@ -44,8 +44,9 @@ object Config {
    */
   const val CLUSTERING_ZOOM_THRESHOLD = 14f
 
-  // TODO(https://github.com/google/ground-android/issues/1730): Make sub-paths configurable and
-  // stop hardcoding here.
+  // TODO: Make sub-paths configurable and
+  //  stop hardcoding here.
+  // Issue URL: https://github.com/google/ground-android/issues/1730
   const val DEFAULT_MOG_TILE_LOCATION = "/offline-imagery/default"
   private const val DEFAULT_MOG_MIN_ZOOM = 8
   private const val DEFAULT_MOG_MAX_ZOOM = 14

ground/src/main/java/com/google/android/ground/MainActivity.kt

@@ -63,7 +63,8 @@ class MainActivity : AbstractActivity() {
   override fun onCreate(savedInstanceState: Bundle?) {
     // Make sure this is before calling super.onCreate()
     setTheme(R.style.AppTheme)
-    // TODO(https://github.com/google/ground-android/issues/620): Remove this to enable dark theme.
+    // TODO: Remove this to enable dark theme.
+    // Issue URL: https://github.com/google/ground-android/issues/620
     AppCompatDelegate.setDefaultNightMode(AppCompatDelegate.MODE_NIGHT_NO)
     super.onCreate(savedInstanceState)
 
@@ -122,8 +123,9 @@ class MainActivity : AbstractActivity() {
             var showDialog by remember { mutableStateOf(true) }
             if (showDialog) {
               PermissionDeniedDialog(
-                // TODO(https://github.com/google/ground-android/issues/2402): Read url from
-                // Firestore config/properties/signUpUrl
+                // TODO: Read url from
+                //  Firestore config/properties/signUpUrl
+                // Issue URL: https://github.com/google/ground-android/issues/2402
                 BuildConfig.SIGNUP_FORM_LINK,
                 onSignOut = {
                   showDialog = false

ground/src/main/java/com/google/android/ground/MainViewModel.kt

@@ -63,8 +63,9 @@ constructor(
 
   init {
     viewModelScope.launch {
-      // TODO(https://github.com/google/ground-android/issues/2624): Check auth status whenever
-      // fragments resumes
+      // TODO: Check auth status whenever
+      //  fragments resumes
+      // Issue URL: https://github.com/google/ground-android/issues/2624
       authenticationManager.signInState.collect {
         _navigationRequests.emit(onSignInStateChange(it))
       }
@@ -87,8 +88,9 @@ constructor(
       Timber.d("User cancelled sign in")
       MainUiState.OnUserSignedOut
     } else {
-      // TODO(https://github.com/google/ground-android/issues/1808): Display some error dialog to
-      // the user with a helpful user-readable message.
+      // TODO: Display some error dialog to
+      //  the user with a helpful user-readable message.
+      // Issue URL: https://github.com/google/ground-android/issues/1808
       onUserSignedOut()
     }
   }
@@ -102,10 +104,11 @@ constructor(
     surveyRepository.clearActiveSurvey()
     userRepository.clearUserPreferences()
 
-    // TODO(https://github.com/google/ground-android/issues/1691): Once multi-user login is
-    // supported, avoid clearing local db data. This is
+    // TODO: Once multi-user login is
+    //  supported, avoid clearing local db data. This is
     //  currently being done to prevent one user's data to be submitted as another user after
     //  re-login.
+    // Issue URL: https://github.com/google/ground-android/issues/1691
     viewModelScope.launch { withContext(ioDispatcher) { localDatabase.clearAllTables() } }
     return MainUiState.OnUserSignedOut
   }

ground/src/main/java/com/google/android/ground/model/geometry/Geometry.kt

@@ -123,7 +123,8 @@ data class LinearRing(val coordinates: List<Coordinates>) : Geometry {
   override fun isEmpty() = coordinates.isEmpty()
 
   override fun validate() {
-    // TODO(https://github.com/google/ground-android/issues/1647): Check for vertices count > 3
+    // TODO: Check for vertices count > 3
+    // Issue URL: https://github.com/google/ground-android/issues/1647
     if (coordinates.isEmpty()) {
       return
     }

ground/src/main/java/com/google/android/ground/model/job/Job.kt

@@ -41,9 +41,10 @@ data class Job(
   val tasksSorted: List<Task>
     get() = tasks.values.sortedBy { it.index }
 
-  // TODO(https://github.com/google/ground-android/issues/2216): Consider using nulls to indicate
-  // absence of value here instead of throwing
-  // an exception.
+  // TODO: Consider using nulls to indicate
+  //  absence of value here instead of throwing
+  //  an exception.
+  // Issue URL: https://github.com/google/ground-android/issues/2216
   fun getTask(id: String): Task = tasks[id] ?: throw TaskNotFoundException(id)
 
   /** Job must contain at-most 1 `AddLoiTask`. */

ground/src/main/java/com/google/android/ground/model/locationofinterest/LocationOfInterest.kt

@@ -58,7 +58,8 @@ data class LocationOfInterest(
    * Converts this LOI to a mutation that can be used to update this LOI in the remote and local
    * database.
    */
-  // TODO(https://github.com/google/ground-android/issues/2903): Remove this test-only method
+  // TODO: Remove this test-only method
+  // Issue URL: https://github.com/google/ground-android/issues/2903
   fun toMutation(type: Mutation.Type, userId: String): LocationOfInterestMutation =
     LocationOfInterestMutation(
       jobId = job.id,