find-cli 1.4.11 → 1.5.0

package/README.md

@@ -56,6 +56,8 @@ 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.
 ```
 
 ### Setup

package/bin/abbreviations.js

@@ -1,9 +1,10 @@
 "use strict";
 
-const { HELP_OPTION, VERSION_OPTION, DRY_RUN_OPTION, QUIETLY_OPTION } = require("./options");
+const { HELP_OPTION, FORMAT_OPTION, VERSION_OPTION, DRY_RUN_OPTION, QUIETLY_OPTION } = require("./options");
 
 module.exports = {
   "h": HELP_OPTION,
+  "f": FORMAT_OPTION,
   "v": VERSION_OPTION,
   "d": DRY_RUN_OPTION,
   "q": QUIETLY_OPTION

package/bin/action/find.js

@@ -7,7 +7,7 @@ const ruleOperation = require("../operation/rule"),
 const { S, EMPTY_STRING } = require("../constants"),
       { executeOperations } = require("../utilities/operation");
 
-function findAction(string, dryRun, quietly) {
+function findAction(string, dryRun, format, quietly) {
   const operations = [
           ruleOperation,
           readConfigurationOperation,
@@ -22,6 +22,7 @@ function findAction(string, dryRun, quietly) {
         context = {
           string,
           dryRun,
+          format,
           quietly,
           rule,
           lines,
@@ -32,13 +33,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 +65,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,8 @@ Options:
 
   --quietly|-q                             Do not show the directory and file path matching
 
+  --format|-f                              Formatted output, shown only once the search completes.
+
 Further information:
 
 Please see the readme file on GitHub:

package/bin/defaults.js

@@ -1,12 +1,14 @@
 "use strict";
 
 const DEFAULT_HELP = false,
+      DEFAULT_FORMAT = false,
       DEFAULT_VERSION = false,
       DEFAULT_DRY_RUN = false,
       DEFAULT_QUIETLY = false;
 
 module.exports = {
   DEFAULT_HELP,
+  DEFAULT_FORMAT,
   DEFAULT_VERSION,
   DEFAULT_DRY_RUN,
   DEFAULT_QUIETLY

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/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_FORMAT, DEFAULT_DRY_RUN, DEFAULT_QUIETLY } = require("./defaults"),
       { FIND_COMMAND,
         HELP_COMMAND,
         VERSION_COMMAND,
@@ -19,7 +19,7 @@ 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 } = options;
 
   switch (command) {
     case HELP_COMMAND: {
@@ -68,7 +68,7 @@ function main(command, argument, options) {
       } else {
         const string = argument;  ///
 
-        findAction(string, dryRun, quietly);
+        findAction(string, dryRun, format, quietly);
       }
 
       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/options.js

@@ -1,12 +1,14 @@
 "use strict";
 
 const HELP_OPTION = "help",
+      FORMAT_OPTION = "format",
       VERSION_OPTION = "version",
       QUIETLY_OPTION = "quietly",
       DRY_RUN_OPTION = "dry-run";
 
 module.exports = {
   HELP_OPTION,
+  FORMAT_OPTION,
   VERSION_OPTION,
   QUIETLY_OPTION,
   DRY_RUN_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/package.json

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