Cleanup TODO comments

Author: jdalton

src/commands/analytics/output-analytics.mts

@@ -108,7 +108,7 @@ export async function outputAnalytics(
   if (outputKind === 'markdown') {
     const serialized = renderMarkdown(fdata, time, repo)
 
-    // TODO: do we want to write to file even if there was an error...?
+    // TODO: Do we want to write to file even if there was an error...?
     if (filePath) {
       try {
         await fs.writeFile(filePath, serialized, 'utf8')

src/commands/manifest/cmd-manifest-auto.mts

@@ -67,8 +67,9 @@ async function run(
     importMeta,
     parentName,
   })
+  // TODO: Implement json/md further.
   const { json, markdown, verbose: verboseFlag } = cli.flags
-  const outputKind = getOutputKind(json, markdown) // TODO: impl json/md further
+  const outputKind = getOutputKind(json, markdown)
   const verbose = !!verboseFlag
   let [cwd = '.'] = cli.input
   // Note: path.resolve vs .join:

src/commands/manifest/cmd-manifest-gradle.mts

@@ -139,7 +139,7 @@ async function run(
     logger.groupEnd()
   }
 
-  // TODO: I'm not sure it's feasible to parse source file from stdin. We could
+  // TODO: We're not sure it's feasible to parse source file from stdin. We could
   //       try, store contents in a file in some folder, target that folder... what
   //       would the file name be?
 

src/commands/manifest/cmd-manifest-kotlin.mts

@@ -16,7 +16,7 @@ import type { CliCommandConfig } from '../../utils/meow-with-subcommands.mts'
 
 const { DRY_RUN_BAILING_NOW } = constants
 
-// TODO: we may want to dedupe some pieces for all gradle languages. I think it
+// TODO: We may want to dedupe some pieces for all gradle languages. I think it
 //       makes sense to have separate commands for them and I think it makes
 //       sense for the help panels to note the requested language, rather than
 //       `socket manifest kotlin` to print help screens with `gradle` as the
@@ -144,7 +144,7 @@ async function run(
     logger.groupEnd()
   }
 
-  // TODO: I'm not sure it's feasible to parse source file from stdin. We could
+  // TODO: We're not sure it's feasible to parse source file from stdin. We could
   //       try, store contents in a file in some folder, target that folder... what
   //       would the file name be?
 

src/commands/manifest/cmd-manifest-scala.mts

@@ -170,7 +170,7 @@ async function run(
     logger.groupEnd()
   }
 
-  // TODO: I'm not sure it's feasible to parse source file from stdin. We could
+  // TODO: We're not sure it's feasible to parse source file from stdin. We could
   //       try, store contents in a file in some folder, target that folder... what
   //       would the file name be?
 

src/commands/manifest/convert_gradle_to_maven.mts

@@ -17,7 +17,7 @@ export async function convertGradleToMaven({
   verbose: boolean
   gradleOpts: string[]
 }) {
-  // TODO: impl json/md
+  // TODO: Implement json/md.
 
   // Note: use resolve because the bin could be an absolute path, away from cwd
   // TODO: what about $PATH resolved commands? (`gradlew` without dir prefix)

src/commands/manifest/convert_sbt_to_maven.mts

@@ -17,7 +17,7 @@ export async function convertSbtToMaven({
   sbtOpts: string[]
   verbose: boolean
 }) {
-  // TODO: impl json/md
+  // TODO: Implement json/md.
 
   // Lazily access constants.spinner.
   const { spinner } = constants
@@ -68,8 +68,8 @@ export async function convertSbtToMaven({
       return
     }
     // Move the pom file to ...? initial cwd? loc will be an absolute path, or dump to stdout
-    // TODO: what to do with multiple output files? Do we want to dump them to stdout? Raw or with separators or ?
-    // TODO: maybe we can add an option to target a specific file to dump to stdout
+    // TODO: What do we do with multiple output files? Do we want to dump them to stdout? Raw or with separators or ?
+    // TODO: Maybe we can add an option to target a specific file to dump to stdout.
     if (out === '-' && poms.length === 1) {
       logger.log('Result:\n```')
       logger.log(await safeReadFile(poms[0]!))
@@ -100,7 +100,7 @@ export async function convertSbtToMaven({
       // } else {
       //   logger.log('Moving output pom file')
       // }
-      // TODO: do we prefer fs-extra? renaming can be gnarly on windows and fs-extra's version is better
+      // TODO: Do we prefer fs-extra? Renaming can be gnarly on windows and fs-extra's version is better.
       // await renamep(loc, out)
       logger.success(`Generated ${poms.length} pom files`)
       poms.forEach(fn => logger.log('-', fn))

src/commands/manifest/generate_auto_manifest.mts

@@ -48,9 +48,9 @@ export async function generateAutoManifest({
       'Detected a gradle build (Gradle, Kotlin, Scala), running default gradle generator...',
     )
     await convertGradleToMaven({
-      // Note: `gradlew` is more likely to be resolved against cwd
-      // Note: .resolve() wont butcher an absolute path
-      // TODO: `gradlew` (or anything else given) may want to resolve against PATH
+      // Note: `gradlew` is more likely to be resolved against cwd.
+      // Note: .resolve() won't butcher an absolute path.
+      // TODO: `gradlew` (or anything else given) may want to resolve against PATH.
       bin: sockJson.defaults?.manifest?.gradle?.bin
         ? path.resolve(cwd, sockJson.defaults.manifest.gradle.bin)
         : path.join(cwd, 'gradlew'),

src/commands/manifest/init.gradle

@@ -11,7 +11,7 @@
 initscript {
     repositories {
         // We need these repositories for Gradle's plugin resolution system
-        // TODO: it's not clear if we actually need them.
+        // TODO: It's not clear if we actually need them.
         gradlePluginPortal()
         mavenCentral()
         google()
@@ -95,7 +95,7 @@ gradle.allprojects { project ->
 
             // Find all relevant dependency configurations
             // We care about implementation, api, compile, and runtime configurations
-            // TODO: anything we're missing here? tests maybe?
+            // TODO: Anything we're missing here? Tests maybe?
             def relevantConfigs = p.configurations.findAll { config ->
                 !config.name.toLowerCase().contains('test') &&
                 (config.name.endsWith('Implementation') ||

src/commands/manifest/setup-manifest-config.mts

@@ -104,7 +104,7 @@ export async function setupManifestConfig(
     description: 'Exit setup',
   })
 
-  // TODO: use detected to list those first
+  // TODO: Use detected to list those first.
   const targetEco = (await select({
     message: 'Select eco system manifest generator to configure',
     choices,