Improve cli consistency

Author: DZakh

jscomp/bsb/bsb_arg.ml

@@ -79,13 +79,13 @@ let stop_raise ~usage ~(error : error) (speclist : t) =
       Ext_buffer.output_buffer stdout b;
       exit 0
   | Unknown s ->
-      b +> "unknown option: '";
+      b +> "Unknown option \"";
       b +> s;
-      b +> "'.\n"
+      b +> "\".\n"
   | Missing s ->
-      b +> "option '";
+      b +> "Option \"";
       b +> s;
-      b +> "' needs an argument.\n");
+      b +> "\" needs an argument.\n");
   usage_b b ~usage speclist;
   bad_arg (Ext_buffer.contents b)
 

jscomp/build_tests/cli_help/input.js

@@ -22,9 +22,7 @@ const cliHelp =
   "\n" +
   "Run `rescript <subcommand> -h` for subcommand help. Examples:\n" +
   "  rescript build -h\n" +
-  "  rescript format -h\n" +
-  "The default `rescript` is equivalent to `rescript build` subcommand\n" +
-  "\n";
+  "  rescript format -h\n";
 
 const buildHelp =
   "Usage: rescript build <options> -- <ninja_options>\n" +
@@ -105,7 +103,7 @@ out = child_process.spawnSync(`../../../rescript`, ["build", "-wtf"], {
   encoding: "utf8",
   cwd: __dirname,
 });
-assert.equal(out.stderr, "Error: unknown option: '-wtf'.\n" + buildHelp + "\n");
+assert.equal(out.stderr, 'Error: Unknown option "-wtf".\n' + buildHelp + "\n");
 assert.equal(out.status, 2);
 
 // Shows cli help with --help arg
@@ -114,8 +112,7 @@ out = child_process.spawnSync(`../../../rescript`, ["--help"], {
   cwd: __dirname,
 });
 assert.equal(out.stdout, cliHelp);
-// FIXME: Should be 0
-assert.equal(out.status, 2);
+assert.equal(out.status, 0);
 
 // Shows cli help with -h arg
 out = child_process.spawnSync(`../../../rescript`, ["-h"], {
@@ -138,19 +135,15 @@ out = child_process.spawnSync(`../../../rescript`, ["built"], {
   encoding: "utf8",
   cwd: __dirname,
 });
-// Should write to stderr instead ???
-assert.equal(out.stdout, cliHelp);
-// FIXME: Should show a warning that it's an unknown command
+assert.equal(out.stderr, `Error: Unknown command or flag "built".\n` + cliHelp);
 assert.equal(out.status, 2);
 
 // Shows cli help with unknown args
 out = child_process.spawnSync(`../../../rescript`, ["-w"], {
   encoding: "utf8",
   cwd: __dirname,
 });
-// Should write to stderr instead ???
-assert.equal(out.stdout, cliHelp);
-// FIXME: Should show a warning that it's an unknown arg
+assert.equal(out.stderr, `Error: Unknown command or flag "-w".\n` + cliHelp);
 assert.equal(out.status, 2);
 
 // Shows clean help with --help arg
@@ -174,7 +167,7 @@ out = child_process.spawnSync(`../../../rescript`, ["clean", "-wtf"], {
   encoding: "utf8",
   cwd: __dirname,
 });
-assert.equal(out.stderr, "Error: unknown option: '-wtf'.\n" + cleanHelp + "\n");
+assert.equal(out.stderr, 'Error: Unknown option "-wtf".\n' + cleanHelp + "\n");
 assert.equal(out.status, 2);
 
 // Shows format help with --help arg

rescript

@@ -68,8 +68,8 @@ if (process.env.NINJA_ANSI_FORCED === undefined) {
 } else {
   dlog(`NINJA_ANSI_FORCED: "${process.env.NINJA_ANSI_FORCED}"`);
 }
-function help() {
-  console.log(`Usage: rescript <options> <subcommand>
+
+const helpMessage = `Usage: rescript <options> <subcommand>
 
 \`rescript\` is equivalent to \`rescript build\`
 
@@ -87,10 +87,7 @@ Subcommands:
 
 Run \`rescript <subcommand> -h\` for subcommand help. Examples:
   rescript build -h
-  rescript format -h
-The default \`rescript\` is equivalent to \`rescript build\` subcommand
-`);
-}
+  rescript format -h`;
 
 var isBuilding = false;
 function releaseBuild() {
@@ -545,13 +542,6 @@ Please pick a different one using the \`-ws [host:]port\` flag from bsb.`);
           bsc_exe
         );
         break;
-      case "dump":
-        require("./scripts/rescript_dump.js").main(
-          process.argv.slice(3),
-          rescript_exe,
-          bsc_exe
-        );
-        break;
       case "convert":
         require("./scripts/rescript_convert.js").main(
           process.argv.slice(3),
@@ -561,16 +551,20 @@ Please pick a different one using the \`-ws [host:]port\` flag from bsb.`);
         break;
       case "-h":
       case "-help":
+      case "--help":
       case "help":
-        help();
+        console.log(helpMessage);
         break;
       case "-v":
       case "-version":
+      case "--version":
+      case "version":
         console.log(require("./package.json").version);
         break;
       default:
-        console.error(`Unknown subcommand or flags: ${maybeSubcommand}`);
-        help();
+        console.error(
+          `Error: Unknown command or flag "${maybeSubcommand}".\n${helpMessage}`
+        );
         process.exit(2);
     }
   }