fix: replace fix && add example

Author: Rabbitzzc

README.md

@@ -4,14 +4,6 @@
   <h2>tiny-replace-files</h2>
   <br>
   <blockquote>Like vscode, simple utility to quickly replace text in one or more files.</blockquote>
-  <img alt="npm" src="https://img.shields.io/npm/dw/test">
-  <img alt="Travis (.org)" src="https://img.shields.io/travis/rust-lang/rust">
-  <img alt="npm" src="https://img.shields.io/npm/v/test">
-  <img alt="GitHub contributors" src="https://img.shields.io/github/contributors/npm-template/js-npm-template">
-  <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/test">
-  <img alt="node-current" src="https://img.shields.io/node/v/test">
-  <img alt="GitHub" src="https://img.shields.io/github/license/npm-template/js-npm-template">
-  <img alt="GitHub issues" src="https://img.shields.io/github/issues-raw/npm-template/js-npm-template">
 </div>
 
 Scene: generate a templates, then replace initName to newName.
@@ -32,10 +24,10 @@ pnpm install --save tiny-replace-files
 
 ### usage
 
-**Sync**
+#### Sync
 
 ```ts
-import { replaceSync } from 'tiny-replace-files'
+import { replaceStringInFiles } from 'tiny-replace-files'
 
 const options = {
   files: 'src/targets/index.js',
@@ -44,11 +36,20 @@ const options = {
 }
 
 # await
-const result = replaceSync(options)
+const result = replaceStringInFiles(options)
 console.info(result)
+/**
+[
+  {
+    file: './ques2.md',
+    changed: true,
+    matchCounts: 1,
+    replaceCounts: 1
+  }
+]
+*/
 ```
-
-**Async**
+#### Async
 
 ```ts
 import replaceStringInFiles from 'tiny-replace-files'
@@ -71,6 +72,122 @@ replaceStringInFiles(options).then((res)=>{
 })
 ```
 
+### Advanced usage
+
+#### Replace a single file or glob
+
+```ts
+const options = {
+  files: 'file',
+};
+```
+
+#### Replace multiple files or globs
+
+```ts
+const options = {
+  files: [
+    'file1',
+    'file2',
+    'file3',
+  ],
+};
+
+const options = {
+  files: [
+    'file1',
+    'file2/**',
+  ]
+};
+```
+
+#### Replace by regex
+
+```ts
+const options = {
+  from: /foo/g,
+  to: 'bar',
+};
+```
+
+#### `from` callback
+
+```ts
+const options = {
+  files: 'file',
+  from: (file) => new RegExp(file, 'g'),
+  to: 'bar',
+};
+```
+
+#### `to` callback
+
+```ts
+const options = {
+    files: './ques2.md',
+    from: 'quest 2',
+    to: (match: string) => match.toUpperCase(),
+    countMatches: true
+}
+```
+
+#### Ignore file(s) or glob
+
+```ts
+const options = {
+  ignore: './ignored/file',
+};
+
+const options = {
+  ignore: [
+    'path/**',
+    'path2/index.html',
+  ],
+};
+```
+
+#### Disable globs
+
+```ts
+const options = {
+  disableGlobs: true,
+};
+```
+
+#### `glob` configuration
+
+API passed to the [fast-glob](https://github.com/mrmlnc/fast-glob#api):
+
+```ts
+const options = {
+  glob: {
+    //Glob settings here
+    dot: true, //E.g. to include file names starting with a dot
+  },
+};
+```
+
+#### Character encoding
+
+Use a different character encoding for reading/writing files. Defaults to utf-8.
+
+```ts
+const options = {
+  encoding: 'utf8',
+};
+```
+
+#### `freeze` Run
+
+freeze mode will do not replace & change, just run the process.
+
+```ts
+const options = {
+  freeze: true,
+};
+```
+
+
 ## ⚙️ Changelog
 
 See [CHANGELOG](./CHANGELOG.md).
@@ -84,6 +201,7 @@ See [CHANGELOG](./CHANGELOG.md).
 - [x] init lib
 - [x] 完成 replaceStringInFiles 函数开发
 - [x] 完成同步函数开发
-- [ ] 完成测试
+- [x] 完成测试
 - [ ] 生命周期？？
+- [ ] cli???
 

example/files/index.ts

@@ -0,0 +1,19 @@
+import { replaceStringInFiles, replaceStringInFilesSync } from '../../dist/index'
+
+
+const options = {
+    files: [
+        './one.md',
+        './two.md',
+        './three.md',
+    ],
+    from: 'Quest 2',
+    to: (match) => match.toLowerCase(),
+    countMatches: true
+}
+
+replaceStringInFiles(options).then(res => {
+    console.log(res)
+}).catch(error => {
+    console.info(error)
+})

example/files/one.md

@@ -0,0 +1 @@
+quest-2 is non-stop fun. The biggest titles and multi-player games—we have them. New ways to workout, socialize or lose track of time—we have those too. And our library keeps growing every day. Discover what’s possible on quest 2.

example/files/three.md

@@ -0,0 +1 @@
+From multiplayer games to unique social experiences to joining up with friends at a live show or instructor-led workout, opportunities to meet and connect with others in VR are virtually everywhere you look.

example/files/two.md

@@ -0,0 +1 @@
+Think quest-2 is just for gaming? You’d be mistaken. quest 2 makes it possible to sit front row at a live concert, burn calories atop a glacier, hang out with friends all over the world, work, watch a movie and yes, even play a game.

example/singe-file/index.ts

@@ -0,0 +1,19 @@
+import { replaceStringInFiles, replaceStringInFilesSync } from '../../dist/index'
+
+
+const options = {
+    files: './ques2.md',
+    from: 'quest 2',
+    to: (match: string) => match.toUpperCase(),
+    countMatches: true
+}
+
+// replaceStringInFiles(options).then(res => {
+//     console.log(res)
+// }).catch(error => {
+//     console.info(error)
+// })
+
+
+const result = replaceStringInFilesSync(options)
+console.log(result)

example/singe-file/ques2.md

@@ -0,0 +1,10 @@
+QUEST 2 is non-stop fun. The biggest titles and multi-player games—we have them. New ways to workout, socialize or lose track of time—we have those too. And our library keeps growing every day. Discover what’s possible on QUEST 2.
+
+
+Think QUEST 2 is just for gaming? You’d be mistaken. QUEST 2 makes it possible to sit front row at a live concert, burn calories atop a glacier, hang out with friends all over the world, work, watch a movie and yes, even play a game.
+
+
+From multiplayer games to unique social experiences to joining up with friends at a live show or instructor-led workout, opportunities to meet and connect with others in VR are virtually everywhere you look.
+
+
+No wires means you're not stuck playing QUEST 2 at home. You’re free to take all the games, workouts, shows, experiences and more on the road with you. Which means you can go anywhere with it, and do anything in it.

package.json

@@ -11,6 +11,7 @@
     "scripts": {
         "build-fast": "tsup src/index.ts --format cjs,esm --minify",
         "build": "yarn build-fast --dts",
+        "watch": "tsup src/index.ts --watch",
         "test": "uvu -r sucrase/register --ignore fixture",
         "prepublishOnly": "yarn build-fast",
         "prettier": "prettier  --write src/*",

src/index.ts

@@ -18,12 +18,11 @@ export const replaceStringInFiles = (options: OPTIONS_TYPES) => {
         console.warn('running in freeze mode, no change...')
     }
 
-    return getPathsAsync(files, options).then((paths) =>
-        Promise.all(paths.map(file => replaceFileAsync(file, options)))
-    )
+    return getPathsAsync(files, options).then((paths) => {
+        return Promise.all(paths.map(file => replaceFileAsync(file, options)))
+    })
 }
 
-
 /**
  * Sync replaceStringInFiles
  */
@@ -40,3 +39,5 @@ export const replaceStringInFilesSync = (options: OPTIONS_TYPES) => {
     if (!Array.isArray(paths)) return replaceFileSync(paths, options)
     return paths.map((path) => replaceFileSync(path, options))
 }
+
+export default replaceStringInFiles

src/utils/index.ts

@@ -86,7 +86,7 @@ export const globFilesSync = (patterns: Strings, ignore: string[], cfg) => {
 /**
  * replace main
  */
-export const replaceFactory = (contents, from, to, file, count: boolean) => {
+export const replaceFactory = (contents: string, from, to, file, count: boolean) => {
     const result: {
         file: any;
         matchCounts?: number;
@@ -100,6 +100,8 @@ export const replaceFactory = (contents, from, to, file, count: boolean) => {
 
     let item = from
     if (typeof from === 'function') item = from(file)
+    if (typeof item === 'string') item = new RegExp(item, 'g')
+
 
     if (count) {
         const matches = contents.match(item);
@@ -157,4 +159,6 @@ export const replaceFileSync = (file: string, options: OPTIONS_TYPES) => {
     if (!result.changed || freeze) return result
 
     fs.writeFileSync(file, newContents, encoding)
+
+    return result
 }