on error, suggest viewing usage instructions instead of displaying th…

…em by default
75lb · Jun 6, 2021 · 74e1467 · 74e1467
1 parent e818472
commit 74e1467
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 5 deletions.
diff --git a/index.mjs b/index.mjs
@@ -47,7 +47,7 @@ class Renamer {
     const fileSet = new FileSet()
     await fileSet.add(options.files)
     if (fileSet.notExisting.length) {
-      throw new Error(`Files do not exist: ${fileSet.notExisting.join(', ')}`)
+      throw new Error(`These paths or patterns do not exist: ${fileSet.notExisting.join(', ')}`)
     }
     const replaceChain = new ReplaceChain()
     await replaceChain.loadPlugins(options.chain)

diff --git a/lib/cli-app.mjs b/lib/cli-app.mjs
@@ -101,12 +101,10 @@ class CliApp {
           this.view.write('complete', stats, this.options)
         } catch (err) {
           this.halt(err)
-          this.printUsage(allOptionDefinitions, cliArgs.plugin)
         }
       }
     } catch (err) {
       this.halt(err)
-      this.printUsage()
     }
   }
 

diff --git a/lib/view/default.mjs b/lib/view/default.mjs
@@ -24,6 +24,7 @@ class DefaultView {
 
   logError (err) {
     this.log(chalk.red('ERROR: ' + err.message))
+    this.log(chalk.red('\nRun `renamer --help` for usage instructions.\n'))
   }
 
   logComplete (stats) {

diff --git a/test/cli-bad-input.mjs b/test/cli-bad-input.mjs
@@ -26,7 +26,7 @@ class TestView extends DefaultView {
   }
 }
 
-tom.test('invalid option: exit code set to 1, usage guide displayed, no file renamed', async function () {
+tom.test('invalid option: exit code set to 1, usage guide suggested, no file renamed', async function () {
   const fixturePath = createFixture(`${testRoot}/${this.index}/one`)
   const origCode = process.exitCode
   const logs = []
@@ -43,7 +43,7 @@ tom.test('invalid option: exit code set to 1, usage guide displayed, no file ren
   a.deepEqual(fs.existsSync(`${testRoot}/${this.index}/yeah`), false)
   a.equal(logs.length, 2)
   a.equal(/Unknown option: --broken/.test(logs[0]), true)
-  a.equal(/For detailed instructions/.test(logs[1]), true)
+  a.equal(/Run `renamer --help` for usage instructions/.test(logs[1]), true)
 })
 
 tom.test('--view: broken plugin', async function () {