improvement: accept files in annotate command (#39)

Author: kazupon

locales/en.json

@@ -15,6 +15,7 @@
   "annotated result detail options": "annotated result detail options",
   "the attributes to annotate": "the attributes to annotate",
   "'--type' is not supported except for 'custom-block'": "'--type' is not supported except for 'custom-block'",
+  "if you don't specify some files at the end of the command, the '—-source' option is required": "if you don't specify some files at the end of the command, the '—-source' option is required",
   "there is a parse error in {filename}": "there is a parse error in {filename}",
   "Unsupported '{type}' block content type: {actual}": "Unsupported '{type}' block content type: {actual}",
   "Detected lang mismatch in block `src` ('{src}') and block content ('{content}')": "Detected lang mismatch in block `src` ('{src}') and block content ('{content}')",

src/commands/annotate.ts

@@ -10,6 +10,7 @@ import {
   isSFCParserError,
   SFCAnnotateError
 } from '../api/annotate'
+import { defineFail, RequireError } from './fail'
 
 import type { Arguments, Argv } from 'yargs'
 import type { SFCBlock } from '@vue/compiler-sfc'
@@ -19,7 +20,7 @@ const debug = createDebug('@intlify/cli:annotate')
 export type AnnotateMode = 'custom-block'
 
 type AnnotateOptions = {
-  source: string
+  source?: string
   type?: string
   force?: boolean
   details?: boolean
@@ -38,8 +39,7 @@ export default function defineCommand() {
       .option('source', {
         type: 'string',
         alias: 's',
-        describe: t('the source path'),
-        demandOption: true
+        describe: t('the source path')
       })
       .option('type', {
         type: 'string',
@@ -61,6 +61,7 @@ export default function defineCommand() {
         alias: 'a',
         describe: t('the attributes to annotate')
       })
+      .fail(defineFail(RequireError))
   }
 
   const handler = async (args: Arguments<AnnotateOptions>): Promise<void> => {
@@ -73,12 +74,15 @@ export default function defineCommand() {
     debug('annotate args:', source, type, force, details, attrs)
 
     if ((type as AnnotateMode) !== 'custom-block') {
-      console.log(
-        chalk.bold.yellow(
-          t(`'--type' is not supported except for 'custom-block'`)
-        )
+      throw new RequireError(
+        `'--type' is not supported except for 'custom-block'`
+      )
+    }
+
+    if (source == null && args._.length === 1) {
+      throw new RequireError(
+        `if you don't specify some files at the end of the command, the '—-source' option is required`
       )
-      return
     }
 
     let counter = 0
@@ -92,7 +96,11 @@ export default function defineCommand() {
     let status: AnnoateStatus = 'fine'
     const onWarn = warnHnadler(() => (status = 'warn'))
 
-    const files = await globAsync(source)
+    const files =
+      source != null
+        ? await globAsync(source)
+        : [...args._].map(a => a.toString()).splice(1)
+
     for (const file of files) {
       const parsed = path.parse(file)
       if (parsed.ext !== '.vue') {

src/commands/fail.ts

@@ -0,0 +1,31 @@
+import chalk from 'chalk'
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type Constructor<T> = { new (...args: any[]): T }
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function typeGuard<T>(o: any, className: Constructor<T>): o is T {
+  return o instanceof className
+}
+
+export class RequireError extends Error {}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function defineFail(userError: any) {
+  return (msg: string, err: Error) => {
+    if (msg) {
+      // TODO: should refactor console message
+      console.error(msg)
+      console.warn(chalk.bold.red(msg))
+      process.exit(1)
+    } else {
+      if (typeGuard(err, userError)) {
+        console.warn(chalk.bold.yellow(err.message))
+        process.exit(0)
+      } else {
+        // preserve statck! see the https://github.com/yargs/yargs/blob/master/docs/api.md#failfn
+        throw err
+      }
+    }
+  }
+}