@frsource/frs-replace 3.0.3 → 4.1.0

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [4.1.0](https://github.com/FRSource/frs-replace/compare/v4.0.0...v4.1.0) (2023-02-05)
+
+
+### Features
+
+* add stdin flag ([7574b49](https://github.com/FRSource/frs-replace/commit/7574b49274a525432f0353b0ce24c54e1514e580))
+
+## [4.0.0](https://github.com/FRSource/frs-replace/compare/v3.0.3...v4.0.0) (2022-12-07)
+
+
+### ⚠ BREAKING CHANGES
+
+* from now on replatement file path should be relative to projects' root
+
+Signed-off-by: Jakub Freisler <jakub@frsource.org>
+
+### Features
+
+* require replacement method in scope of projects' root ([69fc050](https://github.com/FRSource/frs-replace/commit/69fc05009bf11230fbab73d649b4ce636ebbc8e2))
+
 ### [3.0.3](https://github.com/FRSource/frs-replace/compare/v3.0.2...v3.0.3) (2021-04-18)
 
 ### [3.0.2](https://github.com/FRSource/frs-replace/compare/v3.0.1...v3.0.2) (2021-04-18)

package/README.md

@@ -100,6 +100,7 @@ frs-replace <regex> <replacement> [options]
   |&#8209;i, &#8209;&#8209;input       | string or string[] | *-* | Path to files or [fast-glob](https://github.com/mrmlnc/fast-glob) pattern pointing to files to be read & replaced from. If multiple files specified results will be joined using `outputJoinString` option's value) |
   | &#8209;&#8209;i-read-opts | string or object | utf8 | Options which are passed directly to the [readFileSync method](https://nodejs.org/api/fs.html#fs_fs_readfilesync_path_options) when reading input file |
   | &#8209;&#8209;i-glob-opts | object | *undefined* | Options which are passed directly to the [fast-glob package](https://github.com/mrmlnc/fast-glob#options-1) when resolving glob patterns |
+  | &#8209;&#8209;stdin | boolean | *true* | Wait for stdin input (should be set to *false* when used in non-interactive terminals) |
   | &#8209;o, &#8209;&#8209;output     | string | *-* | Output file name/path (replaces the file if it already exists and creates any intermediate directories if they don't already exist) |
   | &#8209;&#8209;o-write-opts | string or object | utf8 | Passed as options argument of [write's .sync](https://www.npmjs.com/package/write#sync) |
   | &#8209;&#8209;o-join-str | string | \n | Used when joining multiple files, passed directly to [javascript join](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join#Syntax) |

package/bin/cli.js

@@ -1,7 +1,11 @@
 #!/usr/bin/env node
-const replaceSync = require('../sync')
+const replaceSync = require('../sync');
 
-require('get-stdin')().then((stdin) => {
+(
+  ~process.argv.indexOf('--no-stdin')
+    ? Promise.resolve()
+    : require('get-stdin')()
+).then((stdin) => {
   const isPiped = !!stdin
 
   if (isPiped) {
@@ -48,7 +52,6 @@ require('get-stdin')().then((stdin) => {
     .choices('f', ['', 'g', 'm', 'i', 'gm', 'gi', 'mi', 'mg', 'ig', 'im', 'gmi', 'gim', 'mig', 'mgi', 'igm', 'img'])
     .default('f', 'g')
     .coerce('f', arg => arg.trim())
-
     .option('i', { demandOption: !isContentPresent && !isHelpPresent })
     .alias('i', 'input')
     .describe('i', 'Path to files or fast-glob pattern pointing to files to read & replace from')
@@ -63,6 +66,11 @@ require('get-stdin')().then((stdin) => {
     .describe('i-glob-opts', 'Passed to fast-glob.sync when resolving glob patterns')
     .implies('i-glob-opts', 'i')
 
+    .option('stdin')
+    .describe('stdin', 'Wait for stdin input (should be set to false when used in non-interactive terminals)')
+    .boolean('stdin')
+    .default('stdin', true)
+
     .option('c', { demandOption: isContentPresent })
     .alias('c', 'content')
     .describe('c', 'Content to be replaced (takes precedence over stream & file input)')
@@ -125,7 +133,7 @@ require('get-stdin')().then((stdin) => {
       outputWriteOptions: argv['o-write-opts'],
       outputJoinString: argv['o-join-str'],
       needle: new RegExp(argv.needle, argv.f),
-      replacement: argv.r ? require(argv.replacement) : argv.replacement
+      replacement: argv.r ? require(require('path').resolve(argv.replacement)) : argv.replacement
     })
 
     if (argv.stdout) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frsource/frs-replace",
-  "version": "3.0.3",
+  "version": "4.1.0",
   "description": "Simple wrapper around javascript replace with CLI usage support!",
   "bin": {
     "frs-replace": "./bin/cli.js"
@@ -41,7 +41,7 @@
     "javascript"
   ],
   "scripts": {
-    "prerelease": "yarn standard:fix && yarn test && yarn test:benchmark",
+    "prerelease": "yarn standard:fix && yarn test",
     "release": "standard-version",
     "postrelease": "git push --follow-tags origin master && yarn publish",
     "pretest": "standard",
@@ -56,19 +56,19 @@
     "standard:fix": "standard --fix"
   },
   "devDependencies": {
-    "perfy": "^1.1.5",
-    "replace": "^1.2.0",
-    "replace-in-file": "^6.0.0",
-    "replace-string": "^3.1.0",
-    "standard": "^16.0.0",
-    "standard-version": "^9.0.0",
-    "tap": "^14.10.7",
-    "tmp-promise": "^3.0.2"
+    "perfy": "1.1.5",
+    "replace": "1.2.2",
+    "replace-in-file": "6.3.5",
+    "replace-string": "3.1.0",
+    "standard": "17.0.0",
+    "standard-version": "9.5.0",
+    "tap": "16.3.4",
+    "tmp-promise": "3.0.3"
   },
   "dependencies": {
     "fast-glob": "^3.1.0",
     "get-stdin": "^8.0.0",
     "write": "^2.0.0",
-    "yargs": "^16.0.3"
+    "yargs": "^17.0.0"
   }
 }

package/src/utils.js

@@ -3,20 +3,20 @@ const writeError = msg => { throw new Error(`@frsource/frs-replace :: ${msg}`) }
 const getReplaceFn = (needle, replacement) =>
   typeof needle === 'string'
     ? content => {
-        const needleLen = needle.length
-        let result = ''
-        let i
-        let endIndex = 0
+      const needleLen = needle.length
+      let result = ''
+      let i
+      let endIndex = 0
 
-        while ((i = content.indexOf(needle, endIndex)) !== -1) {
-          result += content.slice(endIndex, i) + replacement
-          endIndex = i + needleLen
-        }
+      while ((i = content.indexOf(needle, endIndex)) !== -1) {
+        result += content.slice(endIndex, i) + replacement
+        endIndex = i + needleLen
+      }
 
-        result += content.slice(endIndex, content.length)
+      result += content.slice(endIndex, content.length)
 
-        return result
-      }
+      return result
+    }
     : content => content.replace(needle, replacement)
 
 module.exports = { writeError, getReplaceFn }