npm - @frsource/frs-replace - Versions diffs - 4.0.0 → 4.1.1 - Mend

@frsource/frs-replace 4.0.0 → 4.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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)')
@@ -120,7 +128,7 @@ require('get-stdin')().then((stdin) => {
       inputReadOptions: argv['i-read-opts'],
       inputGlobOptions: argv['i-glob-opts'],
       content: argv.c,
-      strategy: argv.strategy,
+      strategy: argv.s,
       output: argv.o,
       outputWriteOptions: argv['o-write-opts'],
       outputJoinString: argv['o-join-str'],
@@ -133,7 +141,7 @@ require('get-stdin')().then((stdin) => {
     }
     return process.exit()
-  } catch (e) /* istanbul ignore next */ {
+  } catch (e) /* c8 ignore next */ {
     process.stderr.write(e.toString())
     return process.exit(1)
   }

package/package.json CHANGED Viewed

@@ -1,18 +1,19 @@
 {
   "name": "@frsource/frs-replace",
-  "version": "4.0.0",
+  "version": "4.1.1",
   "description": "Simple wrapper around javascript replace with CLI usage support!",
   "bin": {
     "frs-replace": "./bin/cli.js"
   },
   "main": "index.js",
-  "repository": "https://github.com/FRSource/frs-replace.git",
+  "repository": "https://github.com/FRSOURCE/frs-replace.git",
   "author": "Jakub Freisler <FRSgit@users.noreply.github.com>",
   "license": "Apache-2.0",
+  "packageManager": "pnpm@8.5.1",
   "bugs": {
-    "url": "https://github.com/FRSource/frs-replace/issues"
+    "url": "https://github.com/FRSOURCE/frs-replace/issues"
   },
-  "homepage": "https://github.com/FRSource/frs-replace#readme",
+  "homepage": "https://github.com/FRSOURCE/frs-replace#readme",
   "files": [
     "bin/cli.js",
     "src/sync.js",
@@ -22,8 +23,7 @@
     "async.js",
     "index.js",
     "LICENSE",
-    "package.json",
-    "yarn.lock"
+    "package.json"
   ],
   "keywords": [
     "replace",
@@ -40,35 +40,31 @@
     "regular-expression",
     "javascript"
   ],
-  "scripts": {
-    "prerelease": "yarn standard:fix && yarn test",
-    "release": "standard-version",
-    "postrelease": "git push --follow-tags origin master && yarn publish",
-    "pretest": "standard",
-    "test": "yarn test:unit --100",
-    "posttest": "tap --coverage-report=html",
-    "pretest:unit": "yarn standard:fix",
-    "test:unit": "tap ./src/*.test.js ./bin/*.test.js -J",
-    "test:unit:debug": "tap ./bin/cli.spec.test.js -J -R spec",
-    "test:benchmark": "tap ./benchmark/*.benchmark.test.js --no-timeout --no-coverage",
-    "test:benchmark:glob": "yarn test:benchmark --grep=\"/input as glob pattern/\"",
-    "test:benchmark:string": "yarn test:benchmark --grep=\"/input & replacement as strings/\"",
-    "standard:fix": "standard --fix"
-  },
   "devDependencies": {
-    "perfy": "1.1.5",
-    "replace": "1.2.1",
+    "@vitest/coverage-c8": "^0.31.1",
+    "@vitest/ui": "^0.31.1",
+    "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.0",
-    "tmp-promise": "3.0.3"
+    "tmp-promise": "3.0.3",
+    "vitest": "^0.31.1"
   },
   "dependencies": {
     "fast-glob": "^3.1.0",
     "get-stdin": "^8.0.0",
     "write": "^2.0.0",
     "yargs": "^17.0.0"
+  },
+  "scripts": {
+    "release": "pnpm lint:fix && pnpm coverage:ci && standard-version && git push --follow-tags origin main && pnpm publish",
+    "test:ci": "vitest run",
+    "coverage:ci": "vitest run --coverage",
+    "test": "vitest",
+    "coverage": "vitest --coverage",
+    "lint:fix": "pnpm standard --fix",
+    "lint:ci": "pnpm standard",
+    "test:benchmark": "vitest bench"
   }
-}
+}

package/src/async.js CHANGED Viewed

@@ -73,7 +73,7 @@ module.exports = async ({
     fileStream.on('error', writeError)
     fileStream.on('data', path => replacePromises.push(new Promise((resolve, reject) =>
       fs.readFile(path, inputReadOptions, (error, data) => {
-        /* istanbul ignore next */
+        /* c8 ignore next */
         if (error) return reject(error)
         resolve([path, replaceFn(data)])

package/CHANGELOG.md DELETED Viewed

@@ -1,179 +0,0 @@
-# Changelog
-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.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)
-### Bug Fixes
-* cli release ([#122](https://github.com/FRSource/frs-replace/issues/122)) ([f813be4](https://github.com/FRSource/frs-replace/commit/f813be403baf49a0c8e8a878e8e4687a73a39832))
-### [3.0.1](https://github.com/FRSource/frs-replace/compare/v3.0.0...v3.0.1) (2021-01-02)
-### Bug Fixes
-* security update: ini ([#110](https://github.com/FRSource/frs-replace/pull/110))
-* updates: standard ([#107](https://github.com/FRSource/frs-replace/pull/107)), tap ([#106](https://github.com/FRSource/frs-replace/pull/106)), yargs ([#108](https://github.com/FRSource/frs-replace/pull/108)), standard-version ([#111](https://github.com/FRSource/frs-replace/pull/111))
-## [3.0.0](https://github.com/FRSource/frs-replace/compare/v2.1.2...v3.0.0) (2020-10-27)
-### ⚠ BREAKING CHANGES
-* from this version on Node.js api ALWAYS returns an array of replace result array, where replace result array follows the pattern: `[<replaced/new file path>, <replaced content>]`
-* renamed `regex` option to `needle`
-* renamed `inputJoinString` option to `outputJoinString`
-### Features
-* different output strategies support ([#100](https://github.com/FRSource/frs-replace/issues/100)) ([d9cabac](https://github.com/FRSource/frs-replace/commit/d9cabac7d220a770637f5ef455e2770b1e28cdd4))
-### [2.1.2](https://github.com/FRSource/frs-replace/compare/v2.1.1...v2.1.2) (2020-10-14)
-### Bug Fixes
-* migration to yargs v16 ([yargs changelog](https://github.com/yargs/yargs/blob/master/CHANGELOG.md#1600-2020-09-09))
-### [2.1.1](https://github.com/FRSource/frs-replace/compare/v2.1.0...v2.1.1) (2020-05-16)
-### Bug Fixes
-* cli path for binary command ([2546905](https://github.com/FRSource/frs-replace/commit/254690572e86d31c60aaac5b234fbb6b5d11eabf))
-## [2.1.0](https://github.com/FRSource/frs-replace/compare/v2.0.1...v2.1.0) (2020-05-15)
-### Features
-* change npm package name - add it [@frsource](https://github.com/frsource) scope ([0208a90](https://github.com/FRSource/frs-replace/commit/0208a900c88f29ac167e06524ba583ea62eeb457))
-* rename FRS-replace to frs-replace ([#73](https://github.com/FRSource/frs-replace/issues/73)) ([8547685](https://github.com/FRSource/frs-replace/commit/8547685e09e133265ba493b8e5349adf8298b463))
-### [2.0.1](https://github.com/FRSource/frs-replace/compare/v2.0.0...v2.0.1) (2019-11-01)
-## [2.0.0](https://github.com/FRSource/frs-replace/compare/v1.0.1...v2.0.0) (2019-10-21)
-### ⚠ BREAKING CHANGES
-* **package:** fast-glob does not support backslashes in glob patterns anymore, always use forward-slashes
-### Features
-* better parallelization ([4d90537](https://github.com/FRSource/frs-replace/commit/4d905375f0550a097d9464b742d13515e1314c94)), closes [#17](https://github.com/FRSource/frs-replace/issues/17) [#10](https://github.com/FRSource/frs-replace/issues/10) [#19](https://github.com/FRSource/frs-replace/issues/19)
-### Bug Fixes
-* **package:** update fast-glob to version 3.1.0 ([#44](https://github.com/FRSource/frs-replace/issues/44)) ([735785d](https://github.com/FRSource/frs-replace/commit/735785dfdc99869096cd4c6a3be60fb8f796d54b))
-* **package:** update write to version 2.0.0 ([#36](https://github.com/FRSource/frs-replace/issues/36)) ([d0b7ffd](https://github.com/FRSource/frs-replace/commit/d0b7ffdbbd668262860e130551e64b54840ac782))
-* **package:** update yargs to version 14.2.0 ([#45](https://github.com/FRSource/frs-replace/issues/45)) ([6df29e4](https://github.com/FRSource/frs-replace/commit/6df29e4e9bda262f9467d85349cd1c61d260c328)), closes [#35](https://github.com/FRSource/frs-replace/issues/35)
-## [1.0.1](https://github.com/FRSource/frs-replace/compare/v1.0.0...v1.0.1) (2019-10-18)
-### Bug Fixes
-* **package:** update yargs to version 13.2.2 ([749b721](https://github.com/FRSource/frs-replace/commit/749b72144049d9c900b04dd2b14473938af963d7)), closes [#20](https://github.com/FRSource/frs-replace/issues/20)
-<a name="1.0.0"></a>
-# [1.0.0](https://github.com/FRSource/frs-replace/compare/v0.1.2...v1.0.0) (2018-11-14)
-### Features
-* **input:** add support for globbing matching ([#14](https://github.com/FRSource/frs-replace/issues/14)) ([b289ffe](https://github.com/FRSource/frs-replace/commit/b289ffe)), closes [#3](https://github.com/FRSource/frs-replace/issues/3)
-* **sync:** Sync speed improvements ([#18](https://github.com/FRSource/frs-replace/issues/18)) ([4ff2a1e](https://github.com/FRSource/frs-replace/commit/4ff2a1e)), closes [#17](https://github.com/FRSource/frs-replace/issues/17)
-### BREAKING CHANGES
-* **input:** api options rename: 'inputOptions' to 'inputReadOptions', 'outputOptions' to 'outputWriteOptions'
-* **input:** cli options rename: 'in-opts' to 'i-read-opts', 'out-opts' to 'o-write-opts'
-Add possibility to set input or output options through cli
-Docs - fixes & new example
-Turn off camel-case-expansion to speed up yargs a bit
-<a name="0.1.2"></a>
-## [0.1.2](https://github.com/FRSource/frs-replace/compare/v0.1.1...v0.1.2) (2018-10-19)
-<a name="0.1.1"></a>
-## [0.1.1](https://github.com/FRSource/frs-replace/compare/v0.1.0...v0.1.1) (2018-10-17)
-<a name="0.1.0"></a>
-# [0.1.0](https://github.com/FRSource/frs-replace/compare/v0.0.6...v0.1.0) (2018-10-17)
-### Features
-* **cli:** Input & output options ([06e8363](https://github.com/FRSource/frs-replace/commit/06e8363)), closes [#7](https://github.com/FRSource/frs-replace/issues/7)
-<a name="0.0.6"></a>
-## [0.0.6](https://github.com/FRSource/frs-replace/compare/v0.0.5...v0.0.6) (2018-10-15)
-### Bug Fixes
-* **docs:** positionals table ([7168474](https://github.com/FRSource/frs-replace/commit/7168474)), closes [#6](https://github.com/FRSource/frs-replace/issues/6)
-<a name="0.0.5"></a>
-## [0.0.5](https://github.com/FRSource/frs-replace/compare/v0.0.4...v0.0.5) (2018-10-15)
-### Bug Fixes
-* **docs:** styling & API usage/examples ([cba85dc](https://github.com/FRSource/frs-replace/commit/cba85dc)), closes [#1](https://github.com/FRSource/frs-replace/issues/1)
-* **node:** expose public node API ([c727dff](https://github.com/FRSource/frs-replace/commit/c727dff)), closes [#5](https://github.com/FRSource/frs-replace/issues/5)
-<a name="0.0.4"></a>
-## [0.0.4](https://github.com/FRSource/frs-replace/compare/v0.0.3...v0.0.4) (2018-10-15)
-<a name="0.0.3"></a>
-## [0.0.3](https://github.com/FRSource/frs-replace/compare/v0.0.2...v0.0.3) (2018-10-15)
-<a name="0.0.2"></a>
-## [0.0.2](https://github.com/FRSource/frs-replace/compare/v0.0.1...v0.0.2) (2018-10-15)
-### Bug Fixes
-* **npm:** lowercase package name to meet npm requirements ([06daa6a](https://github.com/FRSource/frs-replace/commit/06daa6a))
-<a name="0.0.1"></a>
-## 0.0.1 (2018-10-15)