doc-detective 2.11.0-dev.3 → 2.11.0-dev.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "doc-detective",
-  "version": "2.11.0-dev.3",
+  "version": "2.11.0-dev.4",
   "description": "Treat doc content as testable assertions to validate doc accuracy and product UX.",
   "bin": {
     "doc-detective": "src/index.js"
@@ -31,8 +31,8 @@
   },
   "homepage": "https://github.com/doc-detective/doc-detective#readme",
   "dependencies": {
-    "doc-detective-common": "^1.15.0-dev.0",
-    "doc-detective-core": "^2.11.0-dev.3",
+    "doc-detective-common": "^1.15.0-dev.1",
+    "doc-detective-core": "^2.11.0-dev.4",
     "prompt-sync": "^4.2.0",
     "yargs": "^17.7.2"
   },

package/src/index.js

@@ -1,10 +1,23 @@
-#!/usr/bin/env node
+#!/usr/bin/env node
 
 const { runTests, runCoverage } = require("doc-detective-core");
 const { setArgs, setConfig, outputResults, setMeta } = require("./utils");
 const { argv } = require("node:process");
 const path = require("path");
 const fs = require("fs");
+const prompt = require("prompt-sync")();
+
+function complete(commands) {
+  return function (str) {
+    var i;
+    var ret = [];
+    for (i=0; i< commands.length; i++) {
+      if (commands[i].indexOf(str) == 0)
+        ret.push(commands[i]);
+    }
+    return ret;
+  };
+};
 
 // Run
 setMeta();
@@ -17,7 +30,21 @@ async function main(argv) {
     (arg) => arg.endsWith("doc-detective") || arg.endsWith("index.js")
   );
   // `command` is the next argument after `doc-detective` or `src/index.js`
-  const command = argv[index + 1];
+  let command = argv[index + 1];
+  // If no command, prompt user to select a command
+  if (command !== "runTests" && command !== "runCoverage") {
+    const ask = `
+Welcome to Doc Detective. Choose a command:
+- 'runTests' - Run tests defined in specifications and documentation source files.
+- 'runCoverage' - Calculate test coverage of doc content.
+
+You can skip this next time by running 'npx doc-detective <command>'. You can also set 'defaultCommand' in your .doc-detective.json config file.
+
+For more info, visit https://doc-detective.com.
+
+Command: `;
+    command = prompt({ask, value: "runTests", autocomplete: complete(["runTests", "runCoverage"])});
+  }
   // Set args
   argv = setArgs(argv);
   // Get .doc-detective.json config, if it exists
@@ -41,7 +68,8 @@ async function main(argv) {
     outputReportType = "testResults";
     results = await runTests(config);
   } else {
-    throw new Error(`Command ${command} not found`);
+    console.error(`Sorry, that's not a recognized command. Please try again.`);
+    process.exit(1);
   }
   // Output results
   const outputPath = path.resolve(