jonschlinkert / gulp-conflicts

Detects when a file to be written is different than an existing file and, if necessary, prompts the user for action.

gulp-conflicts

Detects when a (new) vinyl file is different than an existing file on the file system, and either prompts the user for action, skips the file, or calls a function on the file to determine the action to take.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save gulp-conflicts

Usage

Pass the same destination value (string or function) to the conflicts() plugin that you pass to gulp.dest(). This is necessary so the plugin can check for existing files that may conflict with (proposed) files before they are written.

const conflicts = require('gulp-conflicts');
const gulp = require('gulp');

gulp.task('default', () => {
  let dest = file => path.join(file.base, 'foo');

  return gulp.src('*.js')
    .pipe(conflicts(dest))
    .pipe(gulp.dest(dest));
});

File detection

1. The existing file's contents is compared with file.contents on the vinyl file
2. If the contents of both are identical, no action is taken, the file is skipped
3. If the contents differ, the user is prompted for action
4. If no conflicting file exists, the vinyl file is written to the file system

Params

• dest {String}: The same desination directory passed to app.dest()
• returns {String}

Example

app.src('foo/*.js')
  .pipe(conflicts('foo'))
  .pipe(app.dest('foo'));

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Author

Jon Schlinkert

• GitHub Profile
• Twitter Profile
• LinkedIn Profile

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.8.0, on November 22, 2018.