{"id":20458350,"url":"https://github.com/outatime/gulp-replace-task","last_synced_at":"2025-07-28T02:05:37.173Z","repository":{"id":15202254,"uuid":"17930533","full_name":"outaTiME/gulp-replace-task","owner":"outaTiME","description":"Replace text patterns with applause.","archived":false,"fork":false,"pushed_at":"2021-05-04T00:17:02.000Z","size":32,"stargazers_count":59,"open_issues_count":0,"forks_count":8,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-17T12:10:43.798Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/outaTiME.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":"2014-03-20T04:19:18.000Z","updated_at":"2023-02-23T10:59:56.000Z","dependencies_parsed_at":"2022-08-25T11:00:48.690Z","dependency_job_id":null,"html_url":"https://github.com/outaTiME/gulp-replace-task","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/outaTiME/gulp-replace-task","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outaTiME%2Fgulp-replace-task","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outaTiME%2Fgulp-replace-task/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outaTiME%2Fgulp-replace-task/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outaTiME%2Fgulp-replace-task/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outaTiME","download_url":"https://codeload.github.com/outaTiME/gulp-replace-task/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outaTiME%2Fgulp-replace-task/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267451489,"owners_count":24089312,"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-07-28T02:00:09.689Z","response_time":68,"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":[],"created_at":"2024-11-15T12:12:06.174Z","updated_at":"2025-07-28T02:05:36.954Z","avatar_url":"https://github.com/outaTiME.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gulp-replace-task\n\n[![Build Status](https://img.shields.io/github/workflow/status/outaTiME/gulp-replace-task/CI)](https://github.com/outaTiME/gulp-replace-task/actions/workflows/main.yml)\n[![Version](https://img.shields.io/npm/v/gulp-replace-task.svg)](https://www.npmjs.com/package/gulp-replace-task)\n![Prerequisite](https://img.shields.io/badge/node-%3E%3D10-blue.svg)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n[![Twitter: outa7iME](https://img.shields.io/twitter/follow/outa7iME.svg?style=social)](https://twitter.com/outa7iME)\n\n\u003e Replace text patterns with [applause](https://github.com/outaTiME/applause).\n\n## Install\n\nFrom NPM:\n\n```shell\nnpm install gulp-replace-task --save-dev\n```\n\n## Usage\n\nAssuming installation via NPM, you can use `gulp-replace-task` in your gulpfile like this:\n\n```javascript\nvar gulp = require('gulp');\nvar replace = require('gulp-replace-task');\n\ngulp.task('default', function () {\n  gulp\n    .src('src/index.html')\n    .pipe(\n      replace({\n        patterns: [\n          {\n            match: 'foo',\n            replacement: 'bar'\n          }\n        ]\n      })\n    )\n    .pipe(gulp.dest('build'));\n});\n```\n\n## Options\n\nSupports all the applause [options](https://github.com/outaTiME/applause#options).\n\n## Examples\n\n### Basic\n\nFile `src/manifest.appcache`:\n\n```\nCACHE MANIFEST\n# @@timestamp\n\nCACHE:\n\nfavicon.ico\nindex.html\n\nNETWORK:\n*\n```\n\nGulpfile:\n\n```javascript\nvar gulp = require('gulp');\nvar replace = require('gulp-replace-task');\n\ngulp.task('default', function () {\n  gulp\n    .src('src/manifest.appcache')\n    .pipe(\n      replace({\n        patterns: [\n          {\n            match: 'timestamp',\n            replacement: Date.now()\n          }\n        ]\n      })\n    )\n    .pipe(gulp.dest('build'));\n});\n```\n\n### Multiple matching\n\nFile `src/manifest.appcache`:\n\n```\nCACHE MANIFEST\n# @@timestamp\n\nCACHE:\n\nfavicon.ico\nindex.html\n\nNETWORK:\n*\n```\n\nFile `src/humans.txt`:\n\n```\n              __     _\n   _    _/__  /./|,//_`\n  /_//_// /_|///  //_, outaTiME v.@@version\n\n/* TEAM */\n  Web Developer / Graphic Designer: Ariel Oscar Falduto\n  Site: https://www.outa.im\n  Twitter: @outa7iME\n  Contact: afalduto at gmail dot com\n  From: Buenos Aires, Argentina\n\n/* SITE */\n  Last update: @@timestamp\n  Standards: HTML5, CSS3, robotstxt.org, humanstxt.org\n  Components: H5BP, Modernizr, jQuery, Bootstrap, LESS, Jade, Grunt\n  Software: Sublime Text, Photoshop, LiveReload\n```\n\nGulpfile:\n\n```javascript\nvar gulp = require('gulp');\nvar replace = require('gulp-replace-task');\nvar pkg = require('./package.json');\n\ngulp.task('default', function () {\n  gulp\n    .src(['src/manifest.appcache', 'src/humans.txt'])\n    .pipe(\n      replace({\n        patterns: [\n          {\n            match: 'version',\n            replacement: pkg.version\n          },\n          {\n            match: 'timestamp',\n            replacement: Date.now()\n          }\n        ]\n      })\n    )\n    .pipe(gulp.dest('build'));\n});\n```\n\n### Cache busting\n\nFile `src/index.html`:\n\n```html\n\u003chead\u003e\n  \u003clink rel=\"stylesheet\" href=\"/css/style.css?rel=@@timestamp\"\u003e\n  \u003cscript src=\"/js/app.js?rel=@@timestamp\"\u003e\u003c/script\u003e\n\u003c/head\u003e\n```\n\nGulpfile:\n\n```javascript\nvar gulp = require('gulp');\nvar replace = require('gulp-replace-task');\n\ngulp.task('default', function () {\n  gulp\n    .src('src/index.html')\n    .pipe(\n      replace({\n        patterns: [\n          {\n            match: 'timestamp',\n            replacement: Date.now()\n          }\n        ]\n      })\n    )\n    .pipe(gulp.dest('build'));\n});\n```\n\n### Include file\n\nFile `src/index.html`:\n\n```html\n\u003cbody\u003e\n  @@include\n\u003c/body\u003e\n```\n\nGulpfile:\n\n```javascript\nvar gulp = require('gulp');\nvar replace = require('gulp-replace-task');\nvar fs = require('fs');\n\ngulp.task('default', function () {\n  gulp\n    .src('src/index.html')\n    .pipe(\n      replace({\n        patterns: [\n          {\n            match: 'include',\n            replacement: fs.readFileSync('./includes/content.html', 'utf8')\n          }\n        ]\n      })\n    )\n    .pipe(gulp.dest('build'));\n});\n```\n\n### Regular expression\n\nFile `src/username.txt`:\n\n```\nJohn Smith\n```\n\nGulpfile:\n\n```javascript\nvar gulp = require('gulp');\nvar replace = require('gulp-replace-task');\n\ngulp.task('default', function () {\n  gulp\n    .src('src/username.txt')\n    .pipe(\n      replace({\n        patterns: [\n          {\n            match: /(\\w+)\\s(\\w+)/,\n            replacement: '$2, $1' // Replaces \"John Smith\" with \"Smith, John\"\n          }\n        ]\n      })\n    )\n    .pipe(gulp.dest('build'));\n});\n```\n\n### Lookup for `foo` instead of `@@foo`\n\nGulpfile:\n\n```javascript\nvar gulp = require('gulp');\nvar replace = require('gulp-replace-task');\n\ngulp.task('default', function () {\n  gulp\n    .src('src/foo.txt')\n    .pipe(\n      replace({\n        patterns: [\n          {\n            match: /foo/g, // Explicitly using a regexp\n            replacement: 'bar'\n          }\n        ]\n      })\n    )\n    .pipe(\n      replace({\n        patterns: [\n          {\n            match: 'foo',\n            replacement: 'bar'\n          }\n        ],\n        usePrefix: false // Using the option provided\n      })\n    )\n    .pipe(\n      replace({\n        patterns: [\n          {\n            match: 'foo',\n            replacement: 'bar'\n          }\n        ],\n        prefix: '' // Removing the prefix manually\n      })\n    )\n    .pipe(gulp.dest('build'));\n});\n```\n\n## Related\n\n- [applause](https://github.com/outaTiME/applause) - Human-friendly replacements\n\n## License\n\nMIT © [outaTiME](https://outa.im)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutatime%2Fgulp-replace-task","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutatime%2Fgulp-replace-task","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutatime%2Fgulp-replace-task/lists"}