find-cli 1.5.0 → 1.6.3

package/README.md

@@ -58,6 +58,14 @@ Options:
   --quietly|-q                             Do not show the directory and file path matching
 
   --format|-f                              Formatted output, shown only once the search completes.
+
+  --glob|-g                                Treat the argument as a glob, which is the default.
+
+  --regex|-g                               Treat the argument as a regular expression.
+
+  --string|-s                              Treat the argument as a string.
+
+  --interactive|-i                         Interactive mode, allowing the argument to be provided via stdin.
 ```
 
 ### Setup
@@ -147,6 +155,39 @@ Here is a list of some of the conversions:
 Character classes and alternatives are also supported. 
 Their conversions are more or less standard.
 
+### Command line considerations
+
+Node is only supplied with the parsed command string and since shells remove double quotes, the following...
+
+    find -q "START_OF_CONTENT"
+
+...may as well be:
+
+    find -q START_OF_CONTENT
+
+In either case the argument will be treated as a glob because Find does not see any double quotes.
+
+There are two ways around this.
+
+1. You can use the interactive mode:
+
+```
+find -qi
+```
+
+This will allow you to input `"START_OF_CONTENT"` by hand, so to speak. Since Node is now reading `stdin` rather than a parsed command string, the quotes will remain.
+
+2. Use the `-s` flag:
+
+```
+find -qs START_OF_CONTENT
+```
+
+This coerces Find into treating the argument as a string irregardless of the missing double quotes.
+
+There is also the `-r` flag for regular expressions if you do not want to type the `/` regular expression delimiters, by the way. 
+And lastly, the `-g` flag for globs is provided for the sake of completeness but since globs are the default it is never really needed.
+
 ## Contact
 
 * james.smith@djalbat.com

package/bin/abbreviations.js

@@ -1,11 +1,15 @@
 "use strict";
 
-const { HELP_OPTION, FORMAT_OPTION, VERSION_OPTION, DRY_RUN_OPTION, QUIETLY_OPTION } = require("./options");
+const { HELP_OPTION, GLOB_OPTION, REGEX_OPTION, STRING_OPTION, FORMAT_OPTION, VERSION_OPTION, DRY_RUN_OPTION, QUIETLY_OPTION, INTERACTIVE_OPTION } = require("./options");
 
 module.exports = {
   "h": HELP_OPTION,
+  "g": GLOB_OPTION,
+  "r": REGEX_OPTION,
+  "s": STRING_OPTION,
   "f": FORMAT_OPTION,
   "v": VERSION_OPTION,
   "d": DRY_RUN_OPTION,
-  "q": QUIETLY_OPTION
+  "q": QUIETLY_OPTION,
+  "i": INTERACTIVE_OPTION
 };

package/bin/action/find.js

@@ -2,14 +2,16 @@
 
 const ruleOperation = require("../operation/rule"),
       findOperation = require("../operation/find"),
+      rulePromptOperation = require("../operation/prompt/rule"),
       readConfigurationOperation = require("../operation/readConfiguration");
 
 const { S, EMPTY_STRING } = require("../constants"),
       { executeOperations } = require("../utilities/operation");
 
-function findAction(string, dryRun, format, quietly) {
+function findAction(string, dryRun, format, quietly, interactive) {
   const operations = [
           ruleOperation,
+          rulePromptOperation,
           readConfigurationOperation,
           findOperation
         ],
@@ -24,6 +26,7 @@ function findAction(string, dryRun, format, quietly) {
           dryRun,
           format,
           quietly,
+          interactive,
           rule,
           lines,
           linesTotal,

package/bin/action/help.js

@@ -31,6 +31,14 @@ Options:
 
   --format|-f                              Formatted output, shown only once the search completes.
 
+  --glob|-g                                Treat the argument as a glob, which is the default.
+
+  --regex|-g                               Treat the argument as a regular expression.
+
+  --string|-s                              Treat the argument as a string.
+
+  --interactive|-i                         Interactive mode, allowing the argument to be provided via stdin.
+
 Further information:
 
 Please see the readme file on GitHub:

package/bin/defaults.js

@@ -1,15 +1,21 @@
 "use strict";
 
 const DEFAULT_HELP = false,
+      DEFAULT_REGEX = false,
+      DEFAULT_STRING = false,
       DEFAULT_FORMAT = false,
       DEFAULT_VERSION = false,
       DEFAULT_DRY_RUN = false,
-      DEFAULT_QUIETLY = false;
+      DEFAULT_QUIETLY = false,
+      DEFAULT_INTERACTIVE = false;
 
 module.exports = {
   DEFAULT_HELP,
+  DEFAULT_REGEX,
+  DEFAULT_STRING,
   DEFAULT_FORMAT,
   DEFAULT_VERSION,
   DEFAULT_DRY_RUN,
-  DEFAULT_QUIETLY
+  DEFAULT_QUIETLY,
+  DEFAULT_INTERACTIVE
 };

package/bin/isIgnored/asynchronous.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const rulePromptOperation = require("../operation/prompt/rule"),
+const pathRulePromptOperation = require("../operation/prompt/pathRule"),
       updatePathRulesOperation = require("../operation/updatePatRules"),
       ignoreOrPermitPathPromptOperation = require("../operation/prompt/ignoreOrPermitPath");
 
@@ -33,25 +33,25 @@ module.exports = {
 function asynchronousIsPathIgnored(path, directory, context, callback) {
   const operations = [
           ignoreOrPermitPathPromptOperation,
-          rulePromptOperation,
+          pathRulePromptOperation,
           updatePathRulesOperation
         ],
-        rule = null,
+        pathRule = null,
         pathIgnored = null;
 
   Object.assign(context, {
-    rule,
     path,
     directory,
+    pathRule,
     pathIgnored
   });
 
   executeOperations(operations, (completed) => {
     const { pathIgnored } = context;
 
-    delete context.rule;
     delete context.path;
     delete context.directory;
+    delete context.pathRule;
     delete context.pathIgnored;
 
     callback(pathIgnored);

package/bin/main.js

@@ -9,7 +9,7 @@ const findAction = require("./action/find"),
       removeRootDirectoryPathAction = require("./action/removeRootDirectoryPath");
 
 const { NO_ARGUMENT_GIVEN_MESSAGE, COMMAND_NOT_RECOGNISED_MESSAGE } = require("./messages"),
-      { DEFAULT_FORMAT, DEFAULT_DRY_RUN, DEFAULT_QUIETLY } = require("./defaults"),
+      { DEFAULT_REGEX, DEFAULT_STRING, DEFAULT_FORMAT, DEFAULT_DRY_RUN, DEFAULT_QUIETLY, DEFAULT_INTERACTIVE } = require("./defaults"),
       { FIND_COMMAND,
         HELP_COMMAND,
         VERSION_COMMAND,
@@ -19,7 +19,9 @@ const { NO_ARGUMENT_GIVEN_MESSAGE, COMMAND_NOT_RECOGNISED_MESSAGE } = require(".
         REMOVE_ROOT_DIRECTORY_PATH_COMMAND } = require("./commands");
 
 function main(command, argument, options) {
-  const { format = DEFAULT_FORMAT, dryRun = DEFAULT_DRY_RUN, quietly = DEFAULT_QUIETLY } = options;
+  const { format = DEFAULT_FORMAT, dryRun = DEFAULT_DRY_RUN, quietly = DEFAULT_QUIETLY, interactive = DEFAULT_INTERACTIVE } = options;
+
+  let { regex = DEFAULT_REGEX, string = DEFAULT_STRING } = options;
 
   switch (command) {
     case HELP_COMMAND: {
@@ -63,14 +65,26 @@ function main(command, argument, options) {
     }
 
     case FIND_COMMAND: {
-      if ((argument === null) && !dryRun) {
-        console.log(NO_ARGUMENT_GIVEN_MESSAGE);
-      } else {
-        const string = argument;  ///
+      if (argument === null) {
+        if (!dryRun && !interactive) {
+          console.log(NO_ARGUMENT_GIVEN_MESSAGE);
+
+          break;
+        }
+      }
 
-        findAction(string, dryRun, format, quietly);
+      if (false) {
+        ///
+      } else if (string) {
+        argument = `"${argument}"`;
+      } else if (regex) {
+        argument = `/${argument}/`;
       }
 
+      string = argument;  ///
+
+      findAction(string, dryRun, format, quietly, interactive);
+
       break;
     }
 

package/bin/operation/find.js

@@ -19,7 +19,11 @@ function findOperation(proceed, abort, context) {
         synchronous = findInEntries(entryPaths, (pathIgnored) => {
           if (pathIgnored === null) {
             abort();
+
+            return;
           }
+
+          proceed();
         }, context);
 
   if (synchronous) {

package/bin/operation/prompt/pathRule.js

@@ -0,0 +1,51 @@
+"use strict";
+
+const { shellUtilities } = require("necessary");
+
+const { validateGlobStringOrPattern } = require("../../utilities/validate"),
+      { GLOB_STRING_OR_REGEX_DESCRIPTION } = require("../../descriptions"),
+      { ruleFromStringAnchoredAndDirectory } = require("../../utilities/rule"),
+      { INVALID_GLOB_REGEX_OR_STRING_MESSAGE } = require("../../messages");
+
+const { prompt } = shellUtilities;
+
+function pathRulePromptOperation(proceed, abort, context) {
+  const { path, directory } = context,
+        anchored = true,
+        description = GLOB_STRING_OR_REGEX_DESCRIPTION,
+        errorMessage = INVALID_GLOB_REGEX_OR_STRING_MESSAGE,
+        initialAnswer = path,  ///
+        validationFunction = (answer) => {
+          const valid = validateGlobStringOrPattern(answer, anchored, directory);
+
+          return valid;
+        },
+        options = {
+          description,
+          errorMessage,
+          initialAnswer,
+          validationFunction
+        };
+
+  prompt(options, (answer) => {
+    const valid = (answer !== null);
+
+    if(!valid) {
+      abort();
+
+      return;
+    }
+
+    const string = answer,  ///
+          rule = ruleFromStringAnchoredAndDirectory(string, anchored, directory),
+          pathRule = rule;  ///
+
+    Object.assign(context, {
+      pathRule
+    });
+
+    proceed();
+  });
+}
+
+module.exports = pathRulePromptOperation;

package/bin/operation/prompt/rule.js

@@ -2,20 +2,36 @@
 
 const { shellUtilities } = require("necessary");
 
-const { ruleFromStringAnchoredAndDirectory } = require("../../utilities/rule"),
-      { validateGlobStringOrPattern } = require("../../utilities/validate"),
+const { validateGlobStringOrPattern } = require("../../utilities/validate"),
       { GLOB_STRING_OR_REGEX_DESCRIPTION } = require("../../descriptions"),
+      { ruleFromStringAnchoredAndDirectory } = require("../../utilities/rule"),
       { INVALID_GLOB_REGEX_OR_STRING_MESSAGE } = require("../../messages");
 
 const { prompt } = shellUtilities;
 
 function rulePromptOperation(proceed, abort, context) {
-  const { path, directory } = context,
+  const { dryRun } = context;
+
+  if (dryRun) {
+    proceed();
+
+    return;
+  }
+
+  const { interactive } = context;
+
+  if (!interactive) {
+    proceed();
+
+    return;
+  }
+
+  const { path, anchored, directory } = context,
         description = GLOB_STRING_OR_REGEX_DESCRIPTION,
         errorMessage = INVALID_GLOB_REGEX_OR_STRING_MESSAGE,
         initialAnswer = path,  ///
         validationFunction = (answer) => {
-          const valid = validateGlobStringOrPattern(answer, directory);
+          const valid = validateGlobStringOrPattern(answer, anchored, directory);
 
           return valid;
         },
@@ -36,7 +52,6 @@ function rulePromptOperation(proceed, abort, context) {
     }
 
     const string = answer,  ///
-          anchored = true,
           rule = ruleFromStringAnchoredAndDirectory(string, anchored, directory);
 
     Object.assign(context, {

package/bin/operation/rule.js

@@ -11,9 +11,17 @@ function ruleOperation(proceed, abort, context) {
     return;
   }
 
+  const { interactive } = context;
+
+  if (interactive) {
+    proceed();
+
+    return;
+  }
+
   const { string } = context,
+        anchored = true,
         directory = false,
-        anchored = false,
         rule = ruleFromStringAnchoredAndDirectory(string, anchored, directory);
 
   if (rule === null) {

package/bin/operation/updatePatRules.js

@@ -6,28 +6,28 @@ const { updateIgnoredFilePathRules,
         updatePermittedDirectoryPathRules } = require("../configuration");
 
 function updatePathRulesOperation(proceed, abort, context) {
-  const { rule, directory, pathIgnored } = context;
+  const { pathRule, directory, pathIgnored } = context;
 
   pathIgnored ?
-    addIgnoreRule(rule, directory, context) :
-      addPermitRule(rule, directory, context);
+    addIgnoreRule(pathRule, directory, context) :
+      addPermitRule(pathRule, directory, context);
 
   proceed();
 }
 
 module.exports = updatePathRulesOperation;
 
-function addIgnoreRule(rule, directory, context) {
+function addIgnoreRule(pathRule, directory, context) {
   if (directory) {
     const { ignoredDirectoryPathRules } = context,
-          ignoredDirectoryPathRule = rule;  ///
+          ignoredDirectoryPathRule = pathRule;  ///
 
     ignoredDirectoryPathRules.push(ignoredDirectoryPathRule);
 
     updateIgnoredDirectoryPathRules(ignoredDirectoryPathRules);
   } else {
     const { ignoredFilePathRules } = context,
-          ignoredFilePathRule = rule;  ///
+          ignoredFilePathRule = pathRule;  ///
 
     ignoredFilePathRules.push(ignoredFilePathRule);
 
@@ -35,17 +35,17 @@ function addIgnoreRule(rule, directory, context) {
   }
 }
 
-function addPermitRule(rule, directory, context) {
+function addPermitRule(pathRule, directory, context) {
   if (directory) {
     const { permittedDirectoryPathRules } = context,
-          permittedDirectoryPathRule = rule;  ///
+          permittedDirectoryPathRule = pathRule;  ///
 
     permittedDirectoryPathRules.push(permittedDirectoryPathRule);
 
     updatePermittedDirectoryPathRules(permittedDirectoryPathRules);
   } else {
     const { permittedFilePathRules } = context,
-          permittedFilePathRule = rule;  ///
+          permittedFilePathRule = pathRule;  ///
 
     permittedFilePathRules.push(permittedFilePathRule);
 

package/bin/options.js

@@ -1,15 +1,23 @@
 "use strict";
 
 const HELP_OPTION = "help",
+      GLOB_OPTION = "glob",
+      REGEX_OPTION = "regex",
+      STRING_OPTION = "string",
       FORMAT_OPTION = "format",
       VERSION_OPTION = "version",
       QUIETLY_OPTION = "quietly",
-      DRY_RUN_OPTION = "dry-run";
+      DRY_RUN_OPTION = "dry-run",
+      INTERACTIVE_OPTION = "interactive";
 
 module.exports = {
   HELP_OPTION,
+  GLOB_OPTION,
+  REGEX_OPTION,
+  STRING_OPTION,
   FORMAT_OPTION,
   VERSION_OPTION,
   QUIETLY_OPTION,
-  DRY_RUN_OPTION
+  DRY_RUN_OPTION,
+  INTERACTIVE_OPTION
 };

package/bin/utilities/validate.js

@@ -39,9 +39,8 @@ function validateRootDirectoryPath(answer) {
   return valid;
 }
 
-function validateGlobStringOrPattern(answer, directory) {
+function validateGlobStringOrPattern(answer, anchored, directory) {
   const string = answer,  ///
-        anchored = false,
         rule = ruleFromStringAnchoredAndDirectory(string, anchored, directory),
         valid = (rule !== null)
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "find-cli",
   "author": "James Smith",
-  "version": "1.5.0",
+  "version": "1.6.3",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/find-cli",
   "description": "An alternative to grep.",