Add reanalyze and doc subcommands to rescript cli

Author: aspeddro

analysis/reanalyze/src/Reanalyze.ml

@@ -106,11 +106,12 @@ let runAnalysisAndReport ~cmtRoot =
 let cli () =
   let analysisKindSet = ref false in
   let cmtRootRef = ref None in
-  let usage = "reanalyze version " ^ Version.version in
-  let versionAndExit () =
-    print_endline usage;
-    exit 0
-      [@@raises exit]
+  let usage =
+    {|Usage: rescript reanalyze [options]
+
+`rescript reanalyze` is powerful dead code analysis tools to maintain a clean, efficient, and distraction-free codebase
+
+Options:|}
   in
   let rec setAll cmtRoot =
     RunConfig.all ();
@@ -203,14 +204,12 @@ let cli () =
         "comma-separated-path-prefixes Report on files whose path has a prefix \
          in the list, overriding -suppress (no-op if -suppress is not \
          specified)" );
-      ("-version", Unit versionAndExit, "Show version information and exit");
-      ("--version", Unit versionAndExit, "Show version information and exit");
       ( "-write",
         Set Common.Cli.write,
         "Write @dead annotations directly in the source files" );
     ]
   in
-  Arg.parse speclist print_endline usage;
+  Arg.parse speclist (fun _ -> ()) usage;
   if !analysisKindSet = false then setConfig ();
   let cmtRoot = !cmtRootRef in
   runAnalysisAndReport ~cmtRoot

analysis/reanalyze/src/Version.ml

@@ -8,8 +8,9 @@
 
 import * as tty from "node:tty";
 import * as fs from "node:fs";
+import * as child_process from "node:child_process";
 
-import { bsc_exe, rescript_exe } from "./common/bins.js";
+import { bsc_exe, rescript_exe, rescript_tools_exe } from "./common/bins.js";
 import * as bsb from "./common/bsb.js";
 
 const cwd = process.cwd();
@@ -44,6 +45,8 @@ Subcommands:
   build
   clean
   format
+  doc
+  reanalyze
   dump
   help
 
@@ -125,6 +128,16 @@ if (
       mod.main(subcmdArgs, rescript_exe, bsc_exe);
       break;
     }
+    case "doc": {
+      const args = process.argv.slice(2);
+      child_process.spawnSync(rescript_tools_exe, args, { stdio: "inherit" });
+      break;
+    }
+    case "reanalyze": {
+      const args = process.argv.slice(2);
+      child_process.spawnSync(rescript_tools_exe, args, { stdio: "inherit" });
+      break;
+    }
     default: {
       console.error(`Error: Unknown command "${subcmd}".\n${helpMessage}`);
       process.exit(2);

cli/rescript.js

@@ -1,4 +1,3 @@
-
   Scanning AutoAnnotate.cmt Source:AutoAnnotate.res
   addVariantCaseDeclaration R AutoAnnotate.res:1:15 path:+AutoAnnotate.variant
   addRecordLabelDeclaration variant AutoAnnotate.res:4:15 path:+AutoAnnotate.record

tests/analysis_tests/tests-reanalyze/deadcode/expected/deadcode.txt

@@ -1,5 +1,4 @@
 
-
   Exception Analysis
   Exn.res:1:5-10
   raises might raise Not_found (Exn.res:1:19) and is not annotated with @raises(Not_found)

tests/analysis_tests/tests-reanalyze/deadcode/expected/exception.txt

@@ -19,6 +19,8 @@ const cliHelp =
   "  build\n" +
   "  clean\n" +
   "  format\n" +
+  "  doc\n" +
+  "  reanalyze\n" +
   "  dump\n" +
   "  help\n" +
   "\n" +

tests/build_tests/cli_help/input.js

@@ -1,11 +1,7 @@
 let docHelp =
-  {|ReScript Tools
-
-Output documentation to standard output
+  {|Usage: rescript doc [file]
 
-Usage: rescript-tools doc <FILE>
-
-Example: rescript-tools doc ./path/to/EntryPointLib.res|}
+`rescript doc` generate documentation and print to standard output|}
 
 let help =
   {|ReScript Tools
@@ -16,7 +12,6 @@ Commands:
 
 doc <file>            Generate documentation
 reanalyze             Reanalyze
--v, --version         Print version
 -h, --help            Print help|}
 
 let logAndExit = function
@@ -27,8 +22,6 @@ let logAndExit = function
     Printf.eprintf "%s\n" log;
     exit 1
 
-let version = Version.version
-
 let main () =
   match Sys.argv |> Array.to_list |> List.tl with
   | "doc" :: rest -> (
@@ -77,7 +70,6 @@ let main () =
     close_out oc;
     exit 0
   | ["-h"] | ["--help"] -> logAndExit (Ok help)
-  | ["-v"] | ["--version"] -> logAndExit (Ok version)
   | _ -> logAndExit (Error help)
 
 let () = main ()