{"id":20458349,"url":"https://github.com/outatime/broccoli-replace","last_synced_at":"2025-04-13T05:45:10.682Z","repository":{"id":14367729,"uuid":"17077624","full_name":"outaTiME/broccoli-replace","owner":"outaTiME","description":"Replace text patterns with applause.","archived":false,"fork":false,"pushed_at":"2021-05-03T23:57:50.000Z","size":77,"stargazers_count":17,"open_issues_count":3,"forks_count":8,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-13T05:45:06.870Z","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-02-22T03:55:45.000Z","updated_at":"2025-02-20T23:15:39.000Z","dependencies_parsed_at":"2022-07-15T15:30:53.291Z","dependency_job_id":null,"html_url":"https://github.com/outaTiME/broccoli-replace","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outaTiME%2Fbroccoli-replace","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outaTiME%2Fbroccoli-replace/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outaTiME%2Fbroccoli-replace/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/outaTiME%2Fbroccoli-replace/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/outaTiME","download_url":"https://codeload.github.com/outaTiME/broccoli-replace/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248670520,"owners_count":21142901,"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","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:05.640Z","updated_at":"2025-04-13T05:45:10.656Z","avatar_url":"https://github.com/outaTiME.png","language":"JavaScript","readme":"# broccoli-replace\n\n[![Build Status](https://img.shields.io/github/workflow/status/outaTiME/broccoli-replace/CI)](https://github.com/outaTiME/broccoli-replace/actions/workflows/main.yml)\n[![Version](https://img.shields.io/npm/v/broccoli-replace.svg)](https://www.npmjs.com/package/broccoli-replace)\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 broccoli-replace --save-dev\n```\n\n## Usage\n\nAssuming installation via NPM, you can use `broccoli-replace` in your Brocfile.js like this:\n\n```javascript\nvar BroccoliReplace = require('broccoli-replace');\n\nmodule.exports = new BroccoliReplace('src', {\n  files: [\n    '**/*.html'\n  ],\n  patterns: [\n    {\n      match: 'foo',\n      replacement: 'bar'\n    }\n  ]\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\nBrocfile.js:\n\n```javascript\nvar BroccoliReplace = require('broccoli-replace');\n\nmodule.exports = new BroccoliReplace('src', {\n  files: [\n    'manifest.appcache'\n  ],\n  patterns: [\n    {\n      match: 'timestamp',\n      replacement: Date.now()\n    }\n  ]\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\nBrocfile.js:\n\n```javascript\nvar BroccoliReplace = require('broccoli-replace');\nvar pkg = require('./package.json');\n\nmodule.exports = new BroccoliReplace('src', {\n  files: [\n    'manifest.appcache',\n    'humans.txt'\n  ],\n  patterns: [\n    {\n      match: 'version',\n      replacement: pkg.version\n    },\n    {\n      match: 'timestamp',\n      replacement: Date.now()\n    }\n  ]\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\nBrocfile.js:\n\n```javascript\nvar BroccoliReplace = require('broccoli-replace');\n\nmodule.exports = new BroccoliReplace('src', {\n  files: [\n    'index.html'\n  ],\n  patterns: [\n    {\n      match: 'timestamp',\n      replacement: Date.now()\n    }\n  ]\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\nBrocfile.js:\n\n```javascript\nvar BroccoliReplace = require('broccoli-replace');\nvar fs = require('fs');\n\nmodule.exports = new BroccoliReplace('src', {\n  files: [\n    'index.html'\n  ],\n  patterns: [\n    {\n      match: 'include',\n      replacement: fs.readFileSync('./includes/content.html', 'utf8')\n    }\n  ]\n});\n```\n\n### Regular expression\n\nFile `src/username.txt`:\n\n```\nJohn Smith\n```\n\nBrocfile.js:\n\n```javascript\nvar BroccoliReplace = require('broccoli-replace');\n\nmodule.exports = new BroccoliReplace('src', {\n  files: [\n    'username.txt'\n  ],\n  patterns: [\n    {\n      match: /(\\w+)\\s(\\w+)/,\n      replacement: '$2, $1' // Replaces \"John Smith\" with \"Smith, John\"\n    }\n  ]\n});\n```\n\n### Lookup for `foo` instead of `@@foo`\n\nBrocfile.js:\n\n```javascript\nvar BroccoliMergeTrees = require('broccoli-merge-trees');\nvar BroccoliReplace = require('broccoli-replace');\n\nvar inputNodes = [\n  new BroccoliReplace('src', {\n    files: [\n      'foo.txt'\n    ],\n    patterns: [\n      {\n        match: /foo/g, // Explicitly using a regexp\n        replacement: 'bar'\n      }\n    ]\n  }),\n  new BroccoliReplace('src', {\n    files: [\n      'foo.txt'\n    ],\n    patterns: [\n      {\n        match: 'foo',\n        replacement: 'bar'\n      }\n    ],\n    usePrefix: false // Using the option provided\n  }),\n  new BroccoliReplace('src', {\n    files: [\n      'foo.txt'\n    ],\n    patterns: [\n      {\n        match: 'foo',\n        replacement: 'bar'\n      }\n    ],\n    prefix: '' // Removing the prefix manually\n  })\n];\n\nmodule.exports = new BroccoliMergeTrees(nodes);\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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutatime%2Fbroccoli-replace","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foutatime%2Fbroccoli-replace","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foutatime%2Fbroccoli-replace/lists"}