❤
npm
Sign UpSign In

gulp-substituter

0.3.0 • Public • Published

gulp-substituter Build Status

Replace matched strings in files for defined values

Install

$ npm install --save-dev gulp-substituter

Gulp Usage

gulpfile.js

var sprites = require('gulp-substituter');
 
gulp.task('replace', function() {
  return gulp.src('index.html')
    .pipe(substituter({
      title: 'website'
    }))
    .pipe(gulp.dest('dist'))
});

index.html

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title><!-- substitute:title --></title>
</head>
<body>
</body>
</html>

API

substituter(options)

Options

Object of keys that you want to replace

Predefined keys
__start

Type: String Default: <!--

Start tag for matching values

__end

Type: String Default: -->

End tag for matching values

__prefix

Type: String Default: substitute

prefix before key

Example

{
  title: 'website',
  description: 'sample website',
  analytics: 'example-123'
}

License

MIT license

Dependents (1)

Package Sidebar

Install

npm i gulp-substituter

Repository

github.com/madebysource/gulp-substituter

Homepage

github.com/madebysource/gulp-substituter

Weekly Downloads

5

Version

0.3.0

License

MIT

Last publish

Collaborators

  • jansedivy
Try on RunKit
Report malware