feat: add parse options func

Author: Rabbitzzc

src/index.ts

@@ -1,6 +1,6 @@
 import { OPTIONS_TYPES } from './utils/constance'
-import { parseOptions, getPathsAsync, getPathsSync, replaceFactory } from './utils/index'
-import * as fs from 'fs';
+import { parseOptions, getPathsAsync, getPathsSync, replaceFileAsync, replaceFileSync } from './utils/index'
+
 /**
  * Async main
  */
@@ -40,41 +40,3 @@ export const replaceStringInFilesSync = (options: OPTIONS_TYPES) => {
     if (!Array.isArray(paths)) return replaceFileSync(paths, options)
     return paths.map((path) => replaceFileSync(path, options))
 }
-
-/**
- * async replace string in single file
- */
-const replaceFileAsync = (file: string, options: OPTIONS_TYPES) => {
-    const { from, to, encoding, freeze, countMatches } = options
-
-    return new Promise((resolve, reject) => {
-        fs.readFile(file, { encoding }, (error, contents) => {
-            if (error) return reject(error)
-
-            // replace action
-            const { result, newContents } = replaceFactory(contents, from, to, file, countMatches)
-
-            if (!result.changed || freeze) return resolve(result)
-
-            // write action
-            fs.writeFile(file, newContents, encoding, error => {
-                if (error) return reject(error)
-                resolve(result)
-            })
-        })
-    })
-}
-
-/**
- * sync replace string in single file
- */
-const replaceFileSync = (file: string, options: OPTIONS_TYPES) => {
-    const { from, to, encoding, freeze, countMatches } = options
-    const contents = fs.readFileSync(file, encoding);
-
-    const { result, newContents } = replaceFactory(contents, from, to, file, countMatches)
-
-    if (!result.changed || freeze) return result
-
-    fs.writeFileSync(file, newContents, encoding)
-}

src/utils/constance.ts

@@ -1,13 +1,21 @@
 export type Strings = string | string[]
 
+export type From = string | RegExp | FromCallback
+
+export type To = string | ToCallback
+
+export type FromCallback = (file: string) => string | RegExp | string[]
+
+export type ToCallback = (match: string, file: string) => string | string[]
+
 export interface OPTIONS_TYPES {
-    files: Strings;
-    from: string | RegExp;
-    to: string;
-    freeze?: boolean;
-    ignore?: string[];
-    disableGlobs?: boolean;
-    glob?: object;
-    encoding?: BufferEncoding;
-    countMatches?: boolean;
+    files: Strings
+    from: From
+    to: To
+    freeze?: boolean
+    ignore?: string[]
+    disableGlobs?: boolean
+    glob?: object // fast-glob config info
+    encoding?: BufferEncoding
+    countMatches?: boolean
 }

src/utils/index.ts

@@ -1,12 +1,40 @@
 import { OPTIONS_TYPES, Strings } from './constance'
 import * as fg from 'fast-glob';
+import * as fs from 'fs';
+
 
 /**
  * init parse options
  */
-export const parseOptions = (options: OPTIONS_TYPES) => {
+export const parseOptions = (options: OPTIONS_TYPES): OPTIONS_TYPES => {
+    const defaults = {
+        ignore: [],
+        encoding: 'utf-8',
+        disableGlobs: false,
+        countMatches: false,
+        freeze: false,
+        glob: {},
+    };
+    if (typeof options !== 'object' || options === null) {
+        throw new Error('options type error');
+    }
+
+    options.glob = options.glob ?? {};
+
+    const { files, from, to, ignore, encoding } = options;
+    if (typeof files === 'undefined') throw new Error('files type error')
+
+    if (typeof from === 'undefined') throw new Error('from type error')
+
+    if (typeof to === 'undefined') throw new Error('to type error')
+
+    if (!Array.isArray(files)) options.files = [files]
+
+    if (!Array.isArray(ignore)) options.ignore = ignore ? [] : [ignore]
+
     if (!options.encoding) options.encoding = 'utf-8'
-    return options
+
+    return Object.assign({}, defaults, options);
 }
 
 
@@ -90,3 +118,42 @@ export const replaceFactory = (contents, from, to, file, count: boolean) => {
         newContents
     }
 }
+
+
+/**
+ * async replace string in single file
+ */
+export const replaceFileAsync = (file: string, options: OPTIONS_TYPES) => {
+    const { from, to, encoding, freeze, countMatches } = options
+
+    return new Promise((resolve, reject) => {
+        fs.readFile(file, { encoding }, (error, contents) => {
+            if (error) return reject(error)
+
+            // replace action
+            const { result, newContents } = replaceFactory(contents, from, to, file, countMatches)
+
+            if (!result.changed || freeze) return resolve(result)
+
+            // write action
+            fs.writeFile(file, newContents, encoding, error => {
+                if (error) return reject(error)
+                resolve(result)
+            })
+        })
+    })
+}
+
+/**
+ * sync replace string in single file
+ */
+export const replaceFileSync = (file: string, options: OPTIONS_TYPES) => {
+    const { from, to, encoding, freeze, countMatches } = options
+    const contents = fs.readFileSync(file, encoding);
+
+    const { result, newContents } = replaceFactory(contents, from, to, file, countMatches)
+
+    if (!result.changed || freeze) return result
+
+    fs.writeFileSync(file, newContents, encoding)
+}