find-cli 1.4.11 → 1.6.2

package/README.md

@@ -56,6 +56,16 @@ Options:
   --dry-run|-d                             Traverse the directories and files only
 
   --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
@@ -145,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,10 +1,15 @@
 "use strict";
 
-const { HELP_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,19 +2,23 @@
 
 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, quietly) {
+function findAction(string, dryRun, format, quietly, interactive) {
   const operations = [
           ruleOperation,
+          rulePromptOperation,
           readConfigurationOperation,
           findOperation
         ],
         rule = null,
         lines = [],
+        anchored = false,
+        directory = false,
         linesTotal = 0,
         filesTotal = 0,
         directoriesTotal = 0,
@@ -22,9 +26,13 @@ function findAction(string, dryRun, quietly) {
         context = {
           string,
           dryRun,
+          format,
           quietly,
+          interactive,
           rule,
           lines,
+          anchored,
+          directory,
           linesTotal,
           filesTotal,
           directoriesTotal,
@@ -32,13 +40,15 @@ function findAction(string, dryRun, quietly) {
         };
 
   executeOperations(operations, (completed) => {
-    logLines(context);
+    if (format) {
+      logLines(context);
+    }
 
     if (!completed) {
       return;
     }
 
-    logTottals(context);
+    logTotals(context);
   }, context);
 }
 
@@ -62,13 +72,13 @@ function logLines(context) {
         requiredContentLength = maximumContentLength; ///
 
   lines.forEach((line) => {
-    const message = line.asMessage(requiredIndexLength, requiredContentLength);
+    const formattedMessage = line.asFormattedMessage(requiredIndexLength, requiredContentLength);
 
-    console.log(message);
+    console.log(formattedMessage);
   });
 }
 
-function logTottals(context) {
+function logTotals(context) {
   const { linesTotal, filesTotal, directoriesTotal, occurrencesTotal } = context,
         optionalS = (occurrencesTotal === 1) ?
                       EMPTY_STRING :

package/bin/action/help.js

@@ -29,6 +29,16 @@ 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.
+
 Further information:
 
 Please see the readme file on GitHub:

package/bin/defaults.js

@@ -1,13 +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/find.js

@@ -7,7 +7,7 @@ const Line = require("./line");
 const { readFile } = fileSystemUtilities;
 
 function find(filePath, context) {
-  const { rule } = context,
+  const { rule, format } = context,
         content = readFile(filePath),
         lines = linesFromContentAndFilePath(content, filePath);
 
@@ -26,11 +26,17 @@ function find(filePath, context) {
         occurrencesTotal
       });
 
-      const { lines } = context;
+      line.setOccurrences(occurrences);
 
-      lines.push(line);
+      if (!format) {
+        const message = line.asMessage();
 
-      line.setOccurrences(occurrences);
+        console.log(message);
+      } else {
+        const { lines } = context;
+
+        lines.push(line);
+      }
     }
 
     linesTotal++;

package/bin/isIgnored/asynchronous.js

@@ -37,12 +37,18 @@ function asynchronousIsPathIgnored(path, directory, context, callback) {
           updatePathRulesOperation
         ],
         rule = null,
+        dryRun = false,
+        anchored = true,
+        interactive = true,
         pathIgnored = null;
 
   Object.assign(context, {
-    rule,
     path,
     directory,
+    rule,
+    dryRun,
+    anchored,
+    interactive,
     pathIgnored
   });
 

package/bin/line.js

@@ -2,7 +2,7 @@
 
 const { arrayUtilities } = require("necessary");
 
-const { grey, blue, yellow, cyan } = require("./utilities/log"),
+const { grey, blue, yellow } = require("./utilities/log"),
       { EMPTY_STRING, SINGLE_SPACE } = require("./constants");
 
 const { backwardsForEach } = arrayUtilities;
@@ -128,7 +128,7 @@ class Line {
 
       gap = grey(gap);  ///
 
-      match = cyan(match);  ///
+      match = blue(match);  ///
 
       string = `${string}${match}${gap}`;
     });
@@ -142,13 +142,18 @@ class Line {
     const filePathLength = this.getFilePathLength(),
           paddingLength = requiredFilePathLength - filePathLength,
           padding = paddingFromPaddingLength(paddingLength),
-          filePath =  `${this.filePath}${padding}`,
-          formattedFilePath = blue(filePath);
+          formattedFilePath =  `${this.filePath}${padding}`;
 
     return formattedFilePath;
   }
 
-  asMessage(requiredIndexLength, requiredFilePathLength) {
+  asMessage() {
+    const message = `${this.filePath}  ${this.index} | ${this.content}`;
+
+    return message;
+  }
+
+  asFormattedMessage(requiredIndexLength, requiredFilePathLength) {
     const formattedIndex = this.getFormattedIndex(requiredIndexLength),
           formattedContent = this.getFormattedContent(),
           formattedFilePath = this.getFormattedFilePath(requiredFilePathLength),

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_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 { 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, 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

@@ -100,11 +100,19 @@ function findInFile(filePath, callback, context) {
     const { quietly } = context;
 
     if (!quietly) {
-      const { ruleString } = context;
+      let message;
 
-      let message = filePathIgnored ?
-                      red(`Ignore ${filePath}`) :
-                        green(`Permit ${filePath}`);
+      const { format, ruleString } = context;
+
+      message = filePathIgnored ?
+                  `Ignore ${filePath}`:
+                    `Permit ${filePath}`;
+
+      if (format) {
+        message = filePathIgnored ?
+                    red(message) :
+                      green(message);
+      }
 
       message = `${message} ${ruleString}`;
 
@@ -157,11 +165,19 @@ function findInDirectory(directoryPath, callback, context) {
       const { quietly } = context;
 
       if (!quietly) {
-        const { ruleString } = context;
+        let message;
+
+        const { format, ruleString } = context;
+
+        message = directoryPathIgnored ?
+                   `Ignore ${directoryPath}/` :
+                     `Permit ${directoryPath}/`;
 
-        let message = directoryPathIgnored ?
-                        red(`Ignore ${directoryPath}/`) :
-                          green(`Permit ${directoryPath}/`);
+        if (format) {
+          message = directoryPathIgnored ?
+                      red(message) :
+                        green(message);
+        }
 
         message = `${message} ${ruleString}`;
 

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,15 @@ function ruleOperation(proceed, abort, context) {
     return;
   }
 
-  const { string } = context,
-        directory = false,
-        anchored = false,
+  const { interactive } = context;
+
+  if (interactive) {
+    proceed();
+
+    return;
+  }
+
+  const { string, anchored, directory } = context,
         rule = ruleFromStringAnchoredAndDirectory(string, anchored, directory);
 
   if (rule === null) {

package/bin/options.js

@@ -1,13 +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/log.js

@@ -3,10 +3,8 @@
 const RED_FOREGROUND_COLOUR = "\u001b[31m",
       GREY_FOREGROUND_COLOUR = "\u001b[90m",
       BLUE_FOREGROUND_COLOUR = "\u001b[34m",
-      CYAN_FOREGROUND_COLOUR = "\u001b[36m",
       GREEN_FOREGROUND_COLOUR = "\u001b[32m",
       YELLOW_FOREGROUND_COLOUR = "\u001b[33m",
-      MAGENTA_FOREGROUND_COLOUR = "\u001b[35m",
       RESET_FOREGROUND_COLOUR = "\u001b[39m";
 
 function red(string) { return `${RED_FOREGROUND_COLOUR}${string}${RESET_FOREGROUND_COLOUR}`; }
@@ -15,20 +13,14 @@ function grey(string) { return `${GREY_FOREGROUND_COLOUR}${string}${RESET_FOREGR
 
 function blue(string) { return `${BLUE_FOREGROUND_COLOUR}${string}${RESET_FOREGROUND_COLOUR}`; }
 
-function cyan(string) { return `${CYAN_FOREGROUND_COLOUR}${string}${RESET_FOREGROUND_COLOUR}`; }
-
 function green(string) { return `${GREEN_FOREGROUND_COLOUR}${string}${RESET_FOREGROUND_COLOUR}`; }
 
 function yellow(string) { return `${YELLOW_FOREGROUND_COLOUR}${string}${RESET_FOREGROUND_COLOUR}`; }
 
-function magenta(string) { return `${MAGENTA_FOREGROUND_COLOUR}${string}${RESET_FOREGROUND_COLOUR}`; }
-
 module.exports = {
   red,
   grey,
   blue,
-  cyan,
   green,
-  yellow,
-  magenta
+  yellow
 };

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.4.11",
+  "version": "1.6.2",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/find-cli",
   "description": "An alternative to grep.",