{"id":17256152,"url":"https://github.com/jalal246/replace-in","last_synced_at":"2025-08-29T06:28:02.461Z","repository":{"id":38013625,"uuid":"98192895","full_name":"jalal246/replace-in","owner":"jalal246","description":"Replace text in a given file.","archived":false,"fork":false,"pushed_at":"2022-08-28T13:57:43.000Z","size":128,"stargazers_count":9,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-15T04:20:43.641Z","etag":null,"topics":["async","callback","chunks","editor","file","fmod","fs","modifier","node-js","nodejs","promise","regex","replace-in-files","search","search-in-file","stream","stream-data","text-processing"],"latest_commit_sha":null,"homepage":"https://jalal246.github.io/replace-in/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jalal246.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-24T13:19:36.000Z","updated_at":"2023-07-28T10:35:10.000Z","dependencies_parsed_at":"2022-08-31T22:50:22.827Z","dependency_job_id":null,"html_url":"https://github.com/jalal246/replace-in","commit_stats":null,"previous_names":["jimmy02020/replace-in"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/jalal246/replace-in","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jalal246%2Freplace-in","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jalal246%2Freplace-in/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jalal246%2Freplace-in/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jalal246%2Freplace-in/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jalal246","download_url":"https://codeload.github.com/jalal246/replace-in/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jalal246%2Freplace-in/sbom","scorecard":{"id":113698,"data":{"date":"2025-08-11","repo":{"name":"github.com/jalal246/replace-in","commit":"135da6da72210e9389dbdf7811dddbf5d5139356"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":0,"reason":"Found 0/3 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"18 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-15T20:18:36.324Z","repository_id":38013625,"created_at":"2025-08-15T20:18:36.324Z","updated_at":"2025-08-15T20:18:36.324Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272641725,"owners_count":24968806,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-29T02:00:10.610Z","response_time":87,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["async","callback","chunks","editor","file","fmod","fs","modifier","node-js","nodejs","promise","regex","replace-in-files","search","search-in-file","stream","stream-data","text-processing"],"created_at":"2024-10-15T07:13:44.977Z","updated_at":"2025-08-29T06:28:02.441Z","avatar_url":"https://github.com/jalal246.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# replace-in\n\n\u003e Replace text in a given file.\n\n```sh\nnpm install replace-in\n```\n\n## How it works?\n\nIt creates a read stream to read from the target file in chunks. Replace each\nrequest and write the results using write stream. A final report will be\nreturned when the replacement is done.\n\n## API\n\n### replace(options)\n\n`options` object contains:\n\n- `path: string` file path\n- `request: array` array of objects. Each object must have two properties:\n  - `regex` for RegExp/String to be matched.\n  - `replace` string replacement.\n- `encoding:? string` read stream encoding (default: `utf8`)\n\nThe results is promise contains `report: array` An array of objects. Each element contains three keys:\n\n- `isChanged: Boolean` search result.\n- `regex: string` regex sent in the request.\n- `replace: string` replacement sent in the request.\n\n### Example\n\n```js\nconst replace = require(\"replace-in\");\n\n// let's create some phrases to replace it in our file.\nconst phrase1 = {\n  // regex\n  regex: /old/gi,\n  // replace\n  replace: \"new\",\n};\n\n// and we have to replace more.\nconst phrase1 = {\n  // regex\n  regex: \"second\",\n  // replace\n  replace: \"third\",\n};\n\nconst report = await replace({\n  path: \"/path1/path2/fileName\",\n  request: [phrase1, phrase1],\n});\n\n// \u003e report\n// [\n//   {\n//     isChanged: true,\n//     regex: /old/gi,\n//     replace: \"new\",\n//   },\n//   {\n//     isChanged: false, // not found so it wasn't changed\n//     regex: \"second\",\n//     replace: \"third\",\n//   },\n// ];\n```\n\nOr you can check specific phrase result:\n\n```js\nconst report = await replace({\n  path: \"/path1/path2/fileName\",\n  request: [phrase1, phrase1],\n});\n\nif (report[2].isChanged) {\n  console.log(\"phrase1 was found and changed\");\n} else {\n  console.log(\"phrase1 was not found in the file!\");\n}\n```\n\n## Tests\n\n```sh\ntest\n```\n\n### Related projects\n\n- [find-in](https://github.com/jalal246/packageSorter) - A tool, written in JS\n  for Searching Text in Files.\n- [textics](https://github.com/jalal246/textics-stream) \u0026\n  [textics-stream](https://github.com/jalal246/textics) - counts lines, words, chars and spaces for a given string.\n\n- [packageSorter](https://github.com/jalal246/packageSorter) - Sorting packages\n  for monorepos production.\n\n- [move-position](https://github.com/jalal246/move-position) - Moves element in\n  given array form index-A to index-B.\n\n## License\n\nThis project is licensed under the [MIT License](https://github.com/jalal246/replace-in/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjalal246%2Freplace-in","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjalal246%2Freplace-in","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjalal246%2Freplace-in/lists"}