# gulp-process-only-modified-files

> [![Build Status](https://travis-ci.org/wlarch/gulp-process-if-modified.svg?branch=master)](https://travis-ci.org/wlarch/gulp-process-if-modified) ![NPM](https://img.shields.io/npm/l/gulp-process-if-modified)

Latest version **1.0.0** (published 2021-01-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-process-only-modified-files
pnpm add gulp-process-only-modified-files
yarn add gulp-process-only-modified-files
bun add gulp-process-only-modified-files
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-01-14 |
| First published | 2021-01-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Maxime HAZEBROUCQ |
| Maintainers | mhazebroucq |

## Links

- npm: https://www.npmjs.com/package/gulp-process-only-modified-files
- Repository: https://github.com/mhazebroucq/gulp-process-only-modified-files
- Homepage: https://github.com/mhazebroucq/gulp-process-only-modified-files#readme
- Issues: https://github.com/mhazebroucq/gulp-process-only-modified-files/issues
- npm.io page: https://npm.io/package/gulp-process-only-modified-files

## Recent versions

- 1.0.0 (latest) — 2021-01-14

## README

# gulp-process-only-modified-files

[![Build Status](https://travis-ci.org/wlarch/gulp-process-if-modified.svg?branch=master)](https://travis-ci.org/wlarch/gulp-process-if-modified) ![NPM](https://img.shields.io/npm/l/gulp-process-if-modified)

> This gulp plugin will passthrough only modified source files since last build.

_Inspired by [gulp-process-if-modified](https://github.com/wlarch/gulp-process-if-modified)_

## Install

```
$ npm install --save gulp-process-if-modified
```

## Usage

```js
var gulp = require('gulp');
var processIfModified = require('gulp-process-only-modified-files');
var sass = require('gulp-sass');
var rename = require("gulp-rename");

// Styles example task
gulp.task(config.path + '-styles', () =>{

    var files = [
        'public/css/styles.scss',
        'public/css/custom.scss',
        'public/css/header.scss'
        'public/css/footer.scss'
    ];

    var css_build_path = 'public/build/css/';

    return gulp.src(files)
        .pipe(processIfModified({ cacheFilename: "styles" }))
        .pipe(sass().on('error', sass.logError))
        .pipe(rename('styles.min.css'))
        .pipe(gulp.dest(css_build_path));
});
```

## API

### processIfModified({options})

#### `cacheFilename`
* `string`
* Default = `./cache/.cache-default.json`

  Cache filename for specific task. The name provided here will be prefixed with `.cache-`. Example : `special_task` as cacheFilename will create the following file in cache folder : `./cache/.cache-special_task.json`

#### `cacheLife`
* `int`
* Default = `1814400`

  Cache keys lifetime in seconds (default 3 weeks).

#### `basePath`
* `string`
* Default = `undefined`

  Allows you to set relative path that will be used for storing paths (keys) in the `cache`.

# Issues

* Be careful not to have multiple processes accessing the same cache file. In fact, it is sugested that each gulp task has it's own cache file by using the `cacheFilename` option above.

# Attribution

Code based on Alex Gorbatchev plugin [gulp-changed-in-place](https://github.com/alexgorbatchev/gulp-changed-in-place)

# License

The MIT License (MIT)

Copyright (c) 2015 Alex Gorbatchev

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

---
_Source: https://npm.io/package/gulp-process-only-modified-files · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
