Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olehdutchenko/gulp-watch-and-touch
tiny module for touching files
https://github.com/olehdutchenko/gulp-watch-and-touch
dependent-file gulp gulp-plugin gulp-touch gulp-watch mtime observer touch watch
Last synced: about 1 month ago
JSON representation
tiny module for touching files
- Host: GitHub
- URL: https://github.com/olehdutchenko/gulp-watch-and-touch
- Owner: OlehDutchenko
- License: mit
- Created: 2017-04-22T13:46:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-10T22:17:28.000Z (about 6 years ago)
- Last Synced: 2024-10-14T00:49:48.778Z (3 months ago)
- Topics: dependent-file, gulp, gulp-plugin, gulp-touch, gulp-watch, mtime, observer, touch, watch
- Language: JavaScript
- Homepage:
- Size: 54.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-RU.md
- Changelog: CHANGELOG-RU.md
- Contributing: CONTRIBUTING-RU.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT-RU.md
Awesome Lists containing this project
README
# gulp-watch-and-touch
-blue.svg)
[](https://travis-ci.org/dutchenkoOleg/gulp-watch-and-touch)
[](https://www.versioneye.com/user/projects/592a776360820000641045ad?child=summary)
:us: [English](./README.md)
|
:ru: Русский язык
> _Следите за зависимыми файлами,_
> _если они меняются - "скажите" об этом файлу, который включает их, или любому другому, который вам нужен._
[](https://github.com/JedWatson/happiness)
## Когда этот плагин использовать?
___Плагин не предназначен для использования в "пайпах" gulp потока___
_Если ваши плагины могут дать обратные вызовы после их работы,_
_с информацией о включенных файлах или если Вы знаете, как это сделать самостоятельно - это для Вас_
## Для чего этот плагин?
Предположим, что у Вас есть что-то вроде этой файловой структуры в Вашем проекте
``` shell
├─┬ project-sources/
│ ├─┬ sources-1/
│ │ ├─┬ group-of-files--1a/
│ │ │ ├── included-in-main.file
│ │ │ ├── included-in-main-and-addon.file
│ │ │ ├── included-in-some-other-main.file # similar cases can also be)))
│ │ │ ├── included-in-addon.file
│ │ │ └── not-included-anywhere.file
│ │ │
│ │ ├── group-of-files--1b/
│ │ ├── group-of-files--1c/
│ │ │
│ │ ├── main.file
│ │ └── addon.file
│ │
│ ├─┬ sources-2/
│ │ ├── group-of-files--2a/
│ │ ├── group-of-files--2b/
│ │ ├── group-of-files--2c/
│ │ ├── some-other-main.file
│ │ └── some-other-addon-or-theme-or-anything-else.file
│ │
│ ├─┬ sources-3/
│ │ └── trigger-my-compilation-when-it-need-from-other-task.file
```
У Вас есть 5 файлов, которые должны быть трансформированы / скомпилированы и повторно собраны, когда это ДЕЙСТВИТЕЛЬНО нужно в процессе инкрементальных сборок. И если Вы меняете файлы, которые затрагивают только один или два из них, нет необходимости воссоздавать все остальные. Но как это сделать?
Конечно, Вы можете создавать 5 или более задач с разными исходными параметрами и для каждого помещать отдельного наблюдателя (`gulp.watch()` или какой нибудь плагин для этого), но этот подход не очень удобен в случае изменения зависимостей, отключения или включения импортов и т.д. Вы должны, каждый раз, вручную переписывать свои задачи или их часть.
Еще один вариант - поставить `watch` на все файлы которые у Вас есть, чтобы не переписывать что-либо, но это в корне убивает нашу цель, которая заключается в оптимизации и ускорении процесса работы, только с теми файлами которые действительно нужны в данный момент.
_Наше предложение. Посмотрите на всю ситуацию под другим углом.
Если что-то происходит с подключенными файлами - они должны сообщать об этом файлам, в которых они используются!_
__Пример__
```js
import gulp from 'gulp';
// function wrapper
import watchAndTouch from 'gulp-watch-and-touch';
/**
* give your gulp to it
* and get function with its closure
* @const {Function}
* @param {string} uniqueKey
* @param {string|Array} touchSrc
* @param {string|Array} watchingSrc
* @return {boolean}
*/
const wnt1 = watchAndTouch(gulp);
/**
* give your gulp to it
* and get function with its closure
* @const {Function}
* @param {string} uniqueKey
* @param {string|Array} touchSrc
* @param {string|Array} watchingSrc
* @return {boolean}
*/
const wnt2 = watchAndTouch(gulp);
// plugin which can give your
// callback with information
// about the included files there
import renderPlugin from 'some-gulp-plugin';
export function renderTask1 () {
return gulp.src('sources-1/*.file') // yes that's all source you need ))
.pipe(renderPlugin({
option1: 'value1',
option2: 'value2',
afterRenderCallback: function(file, result, stats) {
let includedSources = stats.includedFiles;
let pathToCurrentFile = file.path;
let uniqFileKey = pathToCurrentFile.replace(/\\|\/|\.|\s|/g, '_');
let isChanged = wnt1(uniqFileKey, pathToCurrentFile, includedSources);
if (isChanged) { // an example
console.log( `${ file.relative } change dependencies:\n${ includedSources.join('\n') }` );
}
}
}))
}
// or
// ==============
const analyseFn = () => {
// some actions that you know how to write
// for analyse your files for getting information
// about the included files there
// on done call
wnt2(uniqueKey, touchSrc, watchingSrc);
};
```
## Как это работает?
Посмотрите [исходный код](https://github.com/dutchenkoOleg/gulp-watch-and-touch/blob/master/index.js) - это действительно крошечный скрипт )).
_Кроме того, он кэширует результаты для каждого файла._
## Предупреждение
Плагин использует es6 синктаксис
- ECMAScript 2015 (ES6) and beyond - https://nodejs.org/en/docs/es6/
- Node.js ES2015 Support - http://node.green/
## Установка
```shell
npm install --save gulp-auto-watch
# or using yarn cli
yarn add gulp-auto-watch
```
## To Do
- Написать больше тестов
- Написать больше примеров "_живого кода_"
---
## Информация о проекте
* [История изменений](./CHANGELOG-RU.md)
* [Руководство по содействию проекту](./CONTRIBUTING-RU.md)
* [Кодекс поведения](./CODE_OF_CONDUCT-RU.md)
* [Лицензия MIT](./LICENSE)