refactor: renames match to find

Author: mateja176

README.md

@@ -1,6 +1,6 @@
 # Rename
 
-🖉 Script for recursively renaming files and folders 
+🖉 Script for recursively renaming files and folders
 
 ## Usage
 
@@ -13,26 +13,27 @@
 ### Rename all '.js' files to '.ts' files in the current directory
 
 ```sh
-rename --match '(.+).js' --replace '$1.ts'
+rename --find '(.+).js' --replace '$1.ts'
 ```
 
 ### Rename all '.js' files to '.ts' files recursively, starting with the current directory
 
 ```sh
-rename --match '(.+).js' --replace '$1.ts' --recursive
+rename --find '(.+).js' --replace '$1.ts' --recursive
 ```
 
-*Be careful when using this command however it can easily be undone by it's inverse*
+_Be careful when using this command however it can easily be undone by it's inverse_
 
 ```sh
-rename --match '(.+).ts' --replace '$1.js' --recursive
+rename --find '(.+).ts' --replace '$1.js' --recursive
 ```
+
 ## Transformers
 
 ### Available transformers
 
 ```ts
-"toUpperCase" | "toLowerCase" | "trim" | "trimLeft" | "trimRight"
+'toUpperCase' | 'toLowerCase' | 'trim' | 'trimLeft' | 'trimRight';
 ```
 
 ### Examples
@@ -44,7 +45,7 @@ rename --transformations trim
 ```
 
 ```sh
-rename --match '(.+)(\.ts)' --replace '$1$2' --transformations trim,slice
+rename --find '(.+)(\.ts)' --replace '$1$2' --transformations trim,slice
 ```
 
 #### Lower casing file names

package.json

@@ -8,7 +8,7 @@
     "test:watch": "jest --watch",
     "build": "tsc",
     "lint": "tslint",
-    "rename": "cd playground && ../src/rename -m '(.+).js' -r '$1.ts' && cd .."
+    "rename": "cd playground && ../src/rename -f '(.+).js' -r '$1.ts' && cd .."
   },
   "bin": {
     "rename": "./dist/rename.js"

src/rename.test.ts

@@ -4,8 +4,8 @@ import * as fs from 'fs-extra';
 import { transform } from './utils';
 
 commander
-  .option('-m, --match <pattern>', 'Pattern to match against', '.+')
-  .option('-f, --flags <flags>', 'Pattern to match against', '')
+  .option('-f, --find <pattern>', 'Pattern to find against', '.+')
+  .option('-f, --flags <flags>', 'Pattern to find against', '')
   .option('-r, --replace <pattern>', 'Replacement pattern', '$&')
   .option(
     '-t, --transformations <array>',
@@ -15,7 +15,7 @@ commander
   .option('-R, --recursive', 'Perform recursive rename')
   .parse(process.argv);
 
-const { match, flags, replace, transformations, recursive } = commander;
+const { find, flags, replace, transformations, recursive } = commander;
 
 const transformationsArray = JSON.parse(transformations);
 
@@ -25,7 +25,7 @@ const rename = (currentDirectory: string) => (node: string) =>
   fs.rename(
     `${currentDirectory}/${node}`,
     `${currentDirectory}/${node.replace(
-      new RegExp(match, flags),
+      new RegExp(find, flags),
       transform(replace)(transformationsArray),
     )}`,
   );

src/rename.ts

@@ -2,12 +2,11 @@
 
 import * as commander from 'commander';
 import * as fs from 'fs-extra'; // fs throws when node types are unavailable in the current directory
-import { parseTransformations } from './utils';
-import { transform } from './utils';
+import { parseTransformations, transform } from './utils';
 
 commander
-  .option('-m, --match <pattern>', 'Pattern to match against', '.+')
-  .option('-f, --flags <flags>', 'Pattern to match against', '')
+  .option('-f, --find <pattern>', 'Pattern to find against', '.+')
+  .option('--flags <flags>', 'Pattern to find against', '')
   .option('-r, --replace <pattern>', 'Replacement pattern', '$&')
   .option(
     '-t, --transformations <array>',
@@ -17,15 +16,15 @@ commander
   .option('-R, --recursive', 'Perform recursive rename')
   .parse(process.argv);
 
-const { match, flags, replace, transformations, recursive } = commander;
+const { find, flags, replace, transformations, recursive } = commander;
 
 const currentDirectory = process.cwd();
 
 const rename = (currentDirectory: string) => (node: string) =>
   fs.rename(
     `${currentDirectory}/${node}`,
     `${currentDirectory}/${node.replace(
-      new RegExp(match, flags),
+      new RegExp(find, flags),
       transform(replace)(transformations),
     )}`,
   );

src/utils/transform.ts

@@ -3,23 +3,23 @@ import { Transformations } from '../models';
 
 const transform = (replacement: string) => (
   transformations: Transformations,
-) => (match: string, ...config: string[]) => {
+) => (find: string, ...config: string[]) => {
   const [wholeString] = config.slice(-1);
 
   const matches = config.slice(0, -2);
 
   const transformedMatches = zip(matches, transformations).map(
-    ([match, transformation]) => match[transformation](),
+    ([find, transformation]) => find[transformation](),
   );
 
   const replacementResult = replacement
     .replace(/\$0/g, wholeString)
-    .replace(/\$&/g, match)
+    .replace(/\$&/g, find)
     .replace(/\$(\d)/g, (_, groupNumber) => {
-      const match = transformedMatches[groupNumber - 1];
+      const find = transformedMatches[groupNumber - 1];
 
-      if (match) {
-        return match;
+      if (find) {
+        return find;
       } else {
         throw new Error(`'${groupNumber}' does not represent a captured group number from 1 to '${
           matches.length