Add a manifest auto command which tries to zero config generate a manifest

Author: pvdz

src/commands/manifest/auto.ts

@@ -0,0 +1,74 @@
+import fs from 'node:fs'
+
+import meow from 'meow'
+
+import type { CliSubcommand } from '../../utils/meow-with-subcommands'
+import { scala } from './scala.ts'
+
+const description =
+  'Auto-detect build and attempt to generate manifest file'
+
+const help = (name: string) => `
+  Usage
+    $ ${name}
+
+  Tries to figure out what language your current repo uses. If it finds a
+  supported case then it will try to generate the manifest file for that
+  language with the default or detected settings.
+
+  This command takes no arguments except --verbose.
+`
+
+export const auto: CliSubcommand = {
+  description,
+  async run(argv, importMeta, { parentName }) {
+    // Allow `--verbose` to pass through
+    let verbose = false;
+    const args = argv.filter(arg => {
+      if (arg === '--verbose') {
+        verbose = true;
+        return false;
+      }
+      return true;
+    });
+
+    const name = `${parentName} auto`
+    if (args.length) {
+      // note: meow will exit if it prints the --help screen
+      meow(help(name), {
+        argv: ['--help'],
+        description,
+        importMeta
+      })
+    }
+
+    const subArgs = [];
+    if (verbose) subArgs.push('--verbose', '1');
+    const scalaDir = '.';
+    if (fs.existsSync(scalaDir)) {
+      console.log('Detected a Scala sbt build, running default Scala generator...')
+      subArgs.push(scalaDir)
+      await scala.run(subArgs, importMeta, {parentName})
+      return;
+    }
+
+    // Show new help screen and exit
+    meow(`
+      $ ${name}
+
+      Unfortunately this script did not discover a supported language in the
+      current folder.
+
+      - Make sure this script would work with your target build
+      - Make sure to run it from the correct folder
+      - Make sure the necessary build tools are available (\`PATH\`)
+
+      If that doesn't work, see \`${name} <lang> --help\` for config details
+    `, {
+      argv: ['--help'],
+      description,
+      importMeta
+    })
+  }
+}
+

src/commands/manifest/index.ts

@@ -4,9 +4,10 @@ import { scala } from './scala'
 import { meowWithSubcommands } from '../../utils/meow-with-subcommands'
 
 import type { CliSubcommand } from '../../utils/meow-with-subcommands'
+import { auto } from './auto.ts'
 
 const description =
-  'Generate a "Software Bill of Materials" for given file or dir'
+  'Generate a dependency manifest for given file or dir'
 const help = (name: string) => `
   Usage
 
@@ -25,10 +26,15 @@ const help = (name: string) => `
   Examples
 
     $ ${name} scala .
+
+  To have it auto-detect and attempt to run:
+
+    $ ${name} yolo
 `
 
 export const manifest: CliSubcommand = {
   description,
+  hidden: true,
   async run(argv, importMeta, { parentName }) {
     const name = `${parentName} manifest`
 
@@ -44,10 +50,18 @@ export const manifest: CliSubcommand = {
 
     await meowWithSubcommands(
       {
-        scala
+        scala,
+        auto
       },
       {
         argv,
+        aliases: {
+          yolo: {
+            description: auto.description,
+            hidden: true,
+            argv: ['auto']
+          }
+        },
         description,
         importMeta,
         name

src/commands/manifest/scala.ts

@@ -19,7 +19,7 @@ type ListDescription =
 const renamep = util.promisify(fs.rename)
 
 const description =
-  'Generate a "Software Bill of Materials" (`pom.xml`) from Scala\'s `build.sbt` file'
+  'Generate a manifest file (`pom.xml`) from Scala\'s `build.sbt` file'
 
 const scalaCmdFlags: Record<string, ListDescription> = {
   bin: {
@@ -84,6 +84,7 @@ const help = (name: string, flags: Record<string, ListDescription>) => `
 export const scala: CliSubcommand = {
   description,
   async run(argv, importMeta, { parentName }) {
+    // console.log('scala', argv, parentName)
     const name = `${parentName} scala`
     // note: meow will exit if it prints the --help screen
     const cli = meow(help(name, scalaCmdFlags), {
@@ -92,6 +93,10 @@ export const scala: CliSubcommand = {
       importMeta
     })
 
+    if (cli.flags['verbose']) {
+      console.log('[VERBOSE] cli.flags:', cli.flags, ', cli.input:', cli.input)
+    }
+
     const target = cli.input[0]
 
     if (!target) {
@@ -158,19 +163,22 @@ async function startConversion(
   verbose: boolean,
   sbtOpts: Array<string>
 ) {
-  const spinner = new Spinner()
-
   const rbin = path.resolve(bin)
   const rtarget = path.resolve(target)
   const rout = out === '-' ? '-' : path.resolve(out)
 
   if (verbose) {
-    spinner.clear()
-    console.log(`- Absolute bin path: \`${rbin}\``)
-    console.log(`- Absolute target path: \`${rtarget}\``)
-    console.log(`- Absolute out path: \`${rout}\``)
+    console.log(`[VERBOSE] - Absolute bin path: \`${rbin}\``)
+    console.log(`[VERBOSE] - Absolute target path: \`${rtarget}\``)
+    console.log(`[VERBOSE] - Absolute out path: \`${rout}\``)
+  } else {
+    console.log(`- executing: \`${bin}\``);
+    console.log(`- src dir: \`${target}\``)
+    console.log(`- dst dir: \`${out}\``)
   }
 
+  const spinner = new Spinner()
+
   spinner.start(`Running sbt from \`${bin}\` on \`${target}\`...`)
 
   try {
@@ -182,15 +190,19 @@ async function startConversion(
     })
     spinner.success()
     if (verbose) {
-      console.group('sbt stdout:')
+      console.group('[VERBOSE] sbt stdout:')
       console.log(output)
       console.groupEnd()
     }
 
     if (output.stderr) {
       spinner.error('There were errors while running sbt')
       // (In verbose mode, stderr was printed above, no need to repeat it)
-      if (!verbose) console.error(output.stderr)
+      if (!verbose) {
+        console.group('[VERBOSE] stderr:');
+        console.error(output.stderr)
+        console.groupEnd();
+      }
       process.exit(1)
     }
 
@@ -222,9 +234,11 @@ async function startConversion(
       spinner.start().success(`OK. File should be available in \`${out}\``)
     }
   } catch (e) {
-    spinner.error('There was an unexpected error while running this')
+    spinner.error('There was an unexpected error while running this' + (verbose ? '' : ' (use --verbose for details)'))
     if (verbose) {
+      console.group('[VERBOSE] error:');
       console.log(e)
+      console.groupEnd();
     }
     process.exit(1)
   }

src/utils/meow-with-subcommands.ts

@@ -9,6 +9,7 @@ import type { Options } from 'meow'
 
 interface CliAlias {
   description: string
+  hidden?: boolean
   argv: readonly string[]
 }
 
@@ -81,7 +82,7 @@ export async function meowWithSubcommands(
           ...toSortedObject(
             Object.fromEntries(
               Object.entries(aliases).filter(
-                entry => !subcommands[entry[1]?.argv[0]!]?.hidden
+                entry => !entry[1]?.hidden && !subcommands[entry[1]?.argv[0]!]?.hidden
               )
             )
           )