find-cli 1.6.4 → 1.7.1

package/README.md

@@ -65,6 +65,8 @@ Options:
 
   --string|-s                              Treat the argument as a string.
 
+  --previous|-p                            Give a choice of previous rules.
+
   --interactive|-i                         Interactive mode, allowing the argument to be provided via stdin.
 ```
 

package/bin/abbreviations.js

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

package/bin/action/find.js

@@ -1,18 +1,20 @@
 "use strict";
 
-const ruleOperation = require("../operation/rule"),
-      findOperation = require("../operation/find"),
+const findOperation = require("../operation/find"),
+      ruleOperation = require("../operation/rule"),
       rulePromptOperation = require("../operation/prompt/rule"),
-      readConfigurationOperation = require("../operation/readConfiguration");
+      previousRuleOperation = require("../operation/previousRule"),
+      previousRulePromptOperation = require("../operation/prompt/previousRule");
 
 const { S, EMPTY_STRING } = require("../constants"),
       { executeOperations } = require("../utilities/operation");
 
-function findAction(string, dryRun, format, quietly, interactive) {
+function findAction(string, dryRun, format, quietly, previous, interactive) {
   const operations = [
           ruleOperation,
+          previousRulePromptOperation,
           rulePromptOperation,
-          readConfigurationOperation,
+          previousRuleOperation,
           findOperation
         ],
         rule = null,
@@ -26,6 +28,7 @@ function findAction(string, dryRun, format, quietly, interactive) {
           dryRun,
           format,
           quietly,
+          previous,
           interactive,
           rule,
           lines,

package/bin/action/help.js

@@ -37,6 +37,8 @@ Options:
 
   --string|-s                              Treat the argument as a string.
 
+  --previous|-p                            Give a choice of previous rules.
+
   --interactive|-i                         Interactive mode, allowing the argument to be provided via stdin.
 
 Further information:

package/bin/configuration/version_1_4.js

@@ -1,7 +1,6 @@
 "use strict";
 
-const { VERSION_1_4 } = require("../versions"),
-      { ROOT_DIRECTORY_PATH } = require("../constants");
+const { VERSION_1_4 } = require("../versions");
 
 function migrateConfigurationToVersion_1_4(configuration) {
   const { ignoredFilePathMatchers,
@@ -31,28 +30,6 @@ function migrateConfigurationToVersion_1_4(configuration) {
   return configuration;
 }
 
-function createConfiguration() {
-  const version = VERSION_1_4,  ///
-        rootDirectoryPaths = [
-          ROOT_DIRECTORY_PATH
-        ],
-        ignoredFilePathRules = [],
-        permittedFilePathRules = [],
-        ignoredDirectoryPathRules = [],
-        permittedDirectoryPathRules = [],
-        configuration = {
-          version,
-          rootDirectoryPaths,
-          ignoredFilePathRules,
-          permittedFilePathRules,
-          ignoredDirectoryPathRules,
-          permittedDirectoryPathRules
-        };
-
-  return configuration;
-}
-
 module.exports = {
-  createConfiguration,
   migrateConfigurationToVersion_1_4
 };

package/bin/configuration/version_1_7.js

@@ -0,0 +1,44 @@
+"use strict";
+
+const { VERSION_1_7 } = require("../versions"),
+      { ROOT_DIRECTORY_PATH } = require("../constants");
+
+function migrateConfigurationToVersion_1_7(configuration) {
+  const version = VERSION_1_7,
+        previousRules = [];
+
+  Object.assign(configuration, {
+    version,
+    previousRules
+  });
+
+  return configuration;
+}
+
+function createConfiguration() {
+  const version = VERSION_1_7,  ///
+        rootDirectoryPaths = [
+          ROOT_DIRECTORY_PATH
+        ],
+        previousRules = [],
+        ignoredFilePathRules = [],
+        permittedFilePathRules = [],
+        ignoredDirectoryPathRules = [],
+        permittedDirectoryPathRules = [],
+        configuration = {
+          version,
+          previousRules,
+          rootDirectoryPaths,
+          ignoredFilePathRules,
+          permittedFilePathRules,
+          ignoredDirectoryPathRules,
+          permittedDirectoryPathRules
+        };
+
+  return configuration;
+}
+
+module.exports = {
+  createConfiguration,
+  migrateConfigurationToVersion_1_7
+};

package/bin/configuration.js

@@ -7,13 +7,14 @@ const GlobRule = require("./rule/glob"),
       StringRule = require("./rule/string");
 
 const { FIND } = require("./constants"),
-      { createConfiguration } = require("./configuration/version_1_4"),
+      { createConfiguration } = require("./configuration/version_1_7"),
       { migrateConfigurationToVersion_1_1 } = require("./configuration/version_1_1"),
       { migrateConfigurationToVersion_1_2 } = require("./configuration/version_1_2"),
       { migrateConfigurationToVersion_1_3 } = require("./configuration/version_1_3"),
       { migrateConfigurationToVersion_1_4 } = require("./configuration/version_1_4"),
+      { migrateConfigurationToVersion_1_7 } = require("./configuration/version_1_7"),
       { CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE } = require("./messages"),
-      { VERSION_1_0, VERSION_1_1, VERSION_1_2, VERSION_1_3, VERSION_1_4 } = require("./versions");
+      { VERSION_1_0, VERSION_1_1, VERSION_1_2, VERSION_1_3, VERSION_1_4, VERSION_1_7 } = require("./versions");
 
 const { rc } = configurationUtilities,
       { migrate } = versionUtilities,
@@ -28,6 +29,18 @@ function retrieveRootDirectoryPaths() {
   return rootDirectoryPaths;
 }
 
+function retrievePreviousRules() {
+  const configuration = readConfigurationFile();
+
+  let { previousRules } = configuration;
+
+  const previousRulesJSON = previousRules;  ///
+
+  previousRules = rulesFromPathRulesJSON(previousRulesJSON);
+
+  return previousRules;
+}
+
 function retrieveIgnoredFilePathRules() {
   const configuration = readConfigurationFile();
 
@@ -82,6 +95,16 @@ function updateRootDirectoryPaths(rootDirectoryPaths) {
   });
 }
 
+function updatePreviousRules(previousRules) {
+  const previousRulesJSON = rulesJSONFromRules(previousRules);
+
+  previousRules = previousRulesJSON;  ///
+
+  updateConfigurationFile({
+    previousRules
+  });
+}
+
 function updateIgnoredFilePathRules(ignoredFilePathRules) {
   const ignoredFilePathRulesJSON = rulesJSONFromRules(ignoredFilePathRules);
 
@@ -138,9 +161,10 @@ function migrateConfigurationFile() {
           [ VERSION_1_0 ]: migrateConfigurationToVersion_1_1,
           [ VERSION_1_1 ]: migrateConfigurationToVersion_1_2,
           [ VERSION_1_2 ]: migrateConfigurationToVersion_1_3,
-          [ VERSION_1_3 ]: migrateConfigurationToVersion_1_4
+          [ VERSION_1_3 ]: migrateConfigurationToVersion_1_4,
+          [ VERSION_1_4 ]: migrateConfigurationToVersion_1_7
         },
-        latestVersion = VERSION_1_4;
+        latestVersion = VERSION_1_7;
 
   json = migrate(json, migrationMap, latestVersion);
 
@@ -166,10 +190,12 @@ function assertConfigurationFileExists() {
 
 module.exports = {
   retrieveRootDirectoryPaths,
+  retrievePreviousRules,
   retrieveIgnoredFilePathRules,
   retrievePermittedFilePathRules,
   retrieveIgnoredDirectoryPathRules,
   retrievePermittedDirectoryPathRules,
+  updatePreviousRules,
   updateRootDirectoryPaths,
   updateIgnoredFilePathRules,
   updatePermittedFilePathRules,

package/bin/constants.js

@@ -2,6 +2,7 @@
 
 const S = "s",
       ZERO = 0,
+      DATA = "data",
       FIND = "find",
       FILE = "file",
       G_FLAG = "g",
@@ -14,6 +15,7 @@ const S = "s",
 module.exports = {
   S,
   ZERO,
+  DATA,
   FIND,
   FILE,
   G_FLAG,

package/bin/defaults.js

@@ -7,6 +7,7 @@ const DEFAULT_HELP = false,
       DEFAULT_VERSION = false,
       DEFAULT_DRY_RUN = false,
       DEFAULT_QUIETLY = false,
+      DEFAULT_PREVIOUS = false,
       DEFAULT_INTERACTIVE = false;
 
 module.exports = {
@@ -17,5 +18,6 @@ module.exports = {
   DEFAULT_VERSION,
   DEFAULT_DRY_RUN,
   DEFAULT_QUIETLY,
+  DEFAULT_PREVIOUS,
   DEFAULT_INTERACTIVE
 };

package/bin/descriptions.js

@@ -2,10 +2,12 @@
 
 const GLOB_STRING_OR_REGEX_DESCRIPTION = `Glob, string or regex: `,
       ADD_ROOT_DIRECTORY_PATH_DESCRIPTION = `Root directory: `,
-      REMOVE_ROOT_DIRECTORY_PATH_DESCRIPTION = `Root directory index: `;
+      REMOVE_ROOT_DIRECTORY_PATH_DESCRIPTION = `Root directory index: `,
+      PREVIOUS_GLOB_STRING_OR_REGEX_DESCRIPTION = `Previous glob, string or regex: `;
 
 module.exports = {
   GLOB_STRING_OR_REGEX_DESCRIPTION,
   ADD_ROOT_DIRECTORY_PATH_DESCRIPTION,
-  REMOVE_ROOT_DIRECTORY_PATH_DESCRIPTION
+  REMOVE_ROOT_DIRECTORY_PATH_DESCRIPTION,
+  PREVIOUS_GLOB_STRING_OR_REGEX_DESCRIPTION
 };

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_REGEX, DEFAULT_STRING, DEFAULT_FORMAT, DEFAULT_DRY_RUN, DEFAULT_QUIETLY, DEFAULT_INTERACTIVE } = require("./defaults"),
+      { DEFAULT_REGEX, DEFAULT_STRING, DEFAULT_FORMAT, DEFAULT_DRY_RUN, DEFAULT_QUIETLY, DEFAULT_PREVIOUS, DEFAULT_INTERACTIVE } = 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 { format = DEFAULT_FORMAT, dryRun = DEFAULT_DRY_RUN, quietly = DEFAULT_QUIETLY, interactive = DEFAULT_INTERACTIVE } = options;
+  const { format = DEFAULT_FORMAT, dryRun = DEFAULT_DRY_RUN, quietly = DEFAULT_QUIETLY, previous = DEFAULT_PREVIOUS, interactive = DEFAULT_INTERACTIVE } = options;
 
   let { regex = DEFAULT_REGEX, string = DEFAULT_STRING } = options;
 
@@ -66,7 +66,7 @@ function main(command, argument, options) {
 
     case FIND_COMMAND: {
       if (argument === null) {
-        if (!dryRun && !interactive) {
+        if (!dryRun && !previous && !interactive) {
           console.log(NO_ARGUMENT_GIVEN_MESSAGE);
 
           break;
@@ -83,7 +83,7 @@ function main(command, argument, options) {
 
       string = argument;  ///
 
-      findAction(string, dryRun, format, quietly, interactive);
+      findAction(string, dryRun, format, quietly, previous, interactive);
 
       break;
     }

package/bin/messages.js

@@ -1,8 +1,9 @@
 "use strict";
 
 const NO_ARGUMENT_GIVEN_MESSAGE = "No argument has been given.",
-      COMMAND_NOT_RECOGNISED_MESSAGE = "The command is not recognised.",
+      NO_PREVIOUS_RULES_MESSAGE = "There are no previous rules.",
       NO_ROOT_DIRECTORY_PATHS_MESSAGE = "There are no root directory paths bar the default one.",
+      COMMAND_NOT_RECOGNISED_MESSAGE = "The command is not recognised.",
       CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE = "The action cannot be performed because the configuration file is missing. Run 'find initialise' to create one.",
       INVALID_IGNORE_OR_PERMIT_MESSAGE = "You must answer (i)gnore or (p)ermit.",
       INVALID_ROOT_DIRECTORY_PATH_MESSAGE = "Additional root directories must be globs of the form '../**/'.",
@@ -17,8 +18,9 @@ const NO_ARGUMENT_GIVEN_MESSAGE = "No argument has been given.",
 
 module.exports = {
   NO_ARGUMENT_GIVEN_MESSAGE,
-  COMMAND_NOT_RECOGNISED_MESSAGE,
+  NO_PREVIOUS_RULES_MESSAGE,
   NO_ROOT_DIRECTORY_PATHS_MESSAGE,
+  COMMAND_NOT_RECOGNISED_MESSAGE,
   CONFIGURATION_FILE_DOES_NOT_EXIST_MESSAGE,
   INVALID_IGNORE_OR_PERMIT_MESSAGE,
   INVALID_ROOT_DIRECTORY_PATH_MESSAGE,

package/bin/operation/find.js

@@ -1,22 +1,37 @@
 "use strict";
 
-const { fileSystemUtilities } = require("necessary");
-
-const find = require("../find");
-
-const { red, green } = require("../utilities/log"),
-      { synchronousIsFilePathIgnored, synchronousIsDirectoryPathIgnored } = require("../isIgnored/synchronous"),
-      { asynchronousIsFilePathIgnored, asynchronousIsDirectoryPathIgnored } = require("../isIgnored/asynchronous"),
-      { isDirectoryPathRootDirectoryPath, entryPathsFromEntryNamesAndDirectoryPath } = require("../utilities/path");
-
-const { readDirectory, isEntryDirectory } = fileSystemUtilities;
+const { findInEntries } = require("../utilities/find");
+const { retrieveRootDirectoryPaths,
+        retrieveIgnoredFilePathRules,
+        retrievePermittedFilePathRules,
+        retrieveIgnoredDirectoryPathRules,
+        retrievePermittedDirectoryPathRules } = require("../configuration");
 
 function findOperation(proceed, abort, context) {
-  const { rootDirectoryPaths } = context,
-        entryPaths = [  ///
+  const rootDirectoryPaths = retrieveRootDirectoryPaths(),
+        ignoredFilePathRules = retrieveIgnoredFilePathRules(),
+        permittedFilePathRules = retrievePermittedFilePathRules(),
+        ignoredDirectoryPathRules = retrieveIgnoredDirectoryPathRules(),
+        permittedDirectoryPathRules = retrievePermittedDirectoryPathRules();
+
+  Object.assign(context, {
+    rootDirectoryPaths,
+    ignoredFilePathRules,
+    permittedFilePathRules,
+    ignoredDirectoryPathRules,
+    permittedDirectoryPathRules
+  });
+
+  const entryPaths = [  ///
           ...rootDirectoryPaths
         ],
         synchronous = findInEntries(entryPaths, (pathIgnored) => {
+          delete context.rootDirectoryPaths;
+          delete context.ignoredFilePathRules;
+          delete context.permittedFilePathRules;
+          delete context.ignoredDirectoryPathRules;
+          delete context.permittedDirectoryPathRules;
+
           if (pathIgnored === null) {
             abort();
 
@@ -27,195 +42,14 @@ function findOperation(proceed, abort, context) {
         }, context);
 
   if (synchronous) {
+    delete context.rootDirectoryPaths;
+    delete context.ignoredFilePathRules;
+    delete context.permittedFilePathRules;
+    delete context.ignoredDirectoryPathRules;
+    delete context.permittedDirectoryPathRules;
+
     proceed();
   }
 }
 
 module.exports = findOperation;
-
-function findInEntries(entryPaths, callback, context) {
-  let synchronous = true;
-
-  let entryNamesLength;
-
-  entryNamesLength = entryPaths.length;
-
-  while (entryNamesLength > 0) {
-    const entryPath = entryPaths.shift();
-
-    synchronous = findInEntry(entryPath, entryPaths, callback, context);
-
-    if (!synchronous) {
-      break;
-    }
-
-    entryNamesLength = entryPaths.length;
-  }
-
-  return synchronous;
-}
-
-function findInEntry(entryPath, entryPaths, callback, context) {
-  let synchronous;
-
-  const path = entryPath,
-        directory = isEntryDirectory(path);
-
-  if (directory) {
-    const directoryPath = entryPath; ///
-
-    synchronous = findInDirectory(directoryPath, (pathIgnored) => {
-      const synchronous = (pathIgnored !== null) ?
-                            findInEntries(entryPaths, callback, context) :
-                              true;
-
-      if (synchronous) {
-        callback(pathIgnored);
-      }
-    }, context);
-  } else {
-    const filePath = entryPath;  ///
-
-    synchronous = findInFile(filePath, (pathIgnored) => {
-      const synchronous = (pathIgnored !== null) ?
-                            findInEntries(entryPaths, callback, context) :
-                              true;
-      if (synchronous) {
-        callback(pathIgnored);
-      }
-    }, context);
-  }
-
-  if (synchronous) {
-    synchronous = findInEntries(entryPaths, callback, context);
-  }
-
-  return synchronous;
-}
-
-function findInFile(filePath, callback, context) {
-  let synchronous;
-
-  const filePathIgnored = synchronousIsFilePathIgnored(filePath, context);
-
-  if (filePathIgnored !== null) {
-    synchronous = true;
-
-    const { quietly } = context;
-
-    if (!quietly) {
-      let message;
-
-      const { format, ruleString } = context;
-
-      message = filePathIgnored ?
-                  `Ignore ${filePath}`:
-                    `Permit ${filePath}`;
-
-      if (format) {
-        message = filePathIgnored ?
-                    red(message) :
-                      green(message);
-      }
-
-      message = `${message} ${ruleString}`;
-
-      console.log(message);
-    }
-
-    if (!filePathIgnored) {
-      let { filesTotal } = context;
-
-      filesTotal++;
-
-      Object.assign(context, {
-        filesTotal
-      });
-
-      const { dryRun } = context;
-
-      if (!dryRun) {
-        find(filePath, context);
-      }
-    }
-  } else {
-    synchronous = false;
-
-    asynchronousIsFilePathIgnored(filePath, context, (pathIgnored) => {
-      const synchronous = (pathIgnored !== null) ?
-                            findInFile(filePath, callback, context) :
-                              true;
-
-      if (synchronous) {
-        callback(pathIgnored);
-      }
-    });
-  }
-
-  return synchronous;
-}
-
-function findInDirectory(directoryPath, callback, context) {
-  let synchronous;
-
-  const directoryPathIgnored = synchronousIsDirectoryPathIgnored(directoryPath, context);
-
-  if (directoryPathIgnored !== null) {
-    synchronous = true;
-
-    const directoryPathRootDirectoryPath = isDirectoryPathRootDirectoryPath(directoryPath, context);
-
-    if (!directoryPathRootDirectoryPath) {
-      const { quietly } = context;
-
-      if (!quietly) {
-        let message;
-
-        const { format, ruleString } = context;
-
-        message = directoryPathIgnored ?
-                   `Ignore ${directoryPath}/` :
-                     `Permit ${directoryPath}/`;
-
-        if (format) {
-          message = directoryPathIgnored ?
-                      red(message) :
-                        green(message);
-        }
-
-        message = `${message} ${ruleString}`;
-
-        console.log(message);
-      }
-    }
-
-    if (!directoryPathIgnored) {
-      let { directoriesTotal } = context;
-
-      directoriesTotal++;
-
-      Object.assign(context, {
-        directoriesTotal
-      });
-
-      const entryNames = readDirectory(directoryPath),
-            entryPaths = entryPathsFromEntryNamesAndDirectoryPath(entryNames, directoryPath);
-
-      synchronous = findInEntries(entryPaths, callback, context);
-    }
-  } else {
-    synchronous = false;
-
-    asynchronousIsDirectoryPathIgnored(directoryPath, context, (pathIgnored) => {
-      const synchronous = (pathIgnored !== null) ?
-                            findInDirectory(directoryPath, callback, context) :
-                              true;
-
-      if (synchronous) {
-        callback(pathIgnored);
-      }
-    });
-  }
-
-  return synchronous;
-}

package/bin/operation/previousRule.js

@@ -0,0 +1,39 @@
+"use strict";
+
+const { arrayUtilities } = require("necessary");
+
+const { updatePreviousRules, retrievePreviousRules } = require("../configuration");
+
+const { filter } = arrayUtilities;
+
+function previousRuleOperation(proceed, abort, context) {
+  const { dryRun } = context;
+
+  if (dryRun) {
+    proceed();
+
+    return;
+  }
+
+  const { rule } = context;
+
+  const previousRules = retrievePreviousRules();
+
+  filter(previousRules, (previousRule) => {
+    const previousRuleEqualToRule = previousRule.isEqualTo(rule);
+
+    if (!previousRuleEqualToRule) {
+      return true;
+    }
+  });
+
+  const previousRule = rule;  ///
+
+  previousRules.unshift(previousRule);
+
+  updatePreviousRules(previousRules);
+
+  proceed();
+}
+
+module.exports = previousRuleOperation;

package/bin/operation/prompt/previousRule.js

@@ -0,0 +1,52 @@
+"use strict";
+
+const { selectPreviousRule } = require("../../utilities/prompt"),
+      { retrievePreviousRules } = require("../../configuration"),
+      { NO_PREVIOUS_RULES_MESSAGE } = require("../../messages");
+
+function previousRulePromptOperation(proceed, abort, context) {
+  const { dryRun } = context;
+
+  if (dryRun) {
+    proceed();
+
+    return;
+  }
+
+  const { previous } = context;
+
+  if (!previous) {
+    proceed();
+
+    return;
+  }
+
+  const previousRules = retrievePreviousRules(),
+        previousRulesLength = previousRules.length;
+
+  if (previousRulesLength === 0) {
+    console.log(NO_PREVIOUS_RULES_MESSAGE);
+
+    abort();
+
+    return;
+  }
+
+  selectPreviousRule(previousRules, (previousRule) => {
+    if (previousRule === null) {
+      abort();
+
+      return;
+    }
+
+    const rule = previousRule;  ///
+
+    Object.assign(context, {
+      rule
+    });
+
+    proceed();
+  });
+}
+
+module.exports = previousRulePromptOperation;