chore!: Normalize repository, dropping node <10.13 support (#76)

feat: Drop just-debounce from dependencies
chore: Move args processing to separate file

Author: sttk

.editorconfig

@@ -1,4 +1,4 @@
-# http://editorconfig.org
+# https://editorconfig.org
 root = true
 
 [*]

.eslintignore

@@ -0,0 +1 @@
+coverage/

.eslintrc

@@ -1,3 +1,6 @@
 {
-  "extends": "gulp"
+  "extends": "gulp",
+  "rules": {
+    "max-statements": 0
+  }
 }

.github/support.yml

@@ -0,0 +1,75 @@
+name: dev
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+      - main
+env:
+  CI: true
+
+jobs:
+  prettier:
+    name: Format code
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'push' }}
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Prettier
+        uses: gulpjs/prettier_action@v3.0
+        with:
+          commit_message: 'chore: Run prettier'
+          prettier_options: '--write .'
+
+  test:
+    name: Tests for Node ${{ matrix.node }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [10, 12, 14, 16]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v2
+
+      - name: Set Node.js version
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - run: node --version
+      - run: npm --version
+
+      - name: Install npm dependencies
+        run: npm install
+
+      - name: Run lint
+        run: npm run lint
+
+      - name: Run tests
+        run: npm test
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@v1.1.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          flag-name: ${{matrix.os}}-node-${{ matrix.node }}
+          parallel: true
+
+  coveralls:
+    needs: test
+    name: Finish up
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Coveralls Finished
+        uses: coverallsapp/github-action@v1.1.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          parallel-finished: true

.github/workflows/dev.yml

@@ -0,0 +1,16 @@
+name: release
+on:
+  push:
+    branches:
+      - master
+      - main
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GoogleCloudPlatform/release-please-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          release-type: node
+          package-name: release-please-action

.github/workflows/release.yml

@@ -1,35 +1,67 @@
 # Logs
 logs
 *.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
 
 # Runtime data
 pids
 *.pid
 *.seed
+*.pid.lock
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
 
 # Coverage directory used by tools like istanbul
 coverage
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
-# Compiled binary addons (http://nodejs.org/api/addons.html)
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
 build/Release
 
-# Dependency directory
-# Commenting this out is preferred by some people, see
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
-node_modules
+# Dependency directories
+node_modules/
+jspm_packages/
 
-# Users Environment Variables
-.lock-wscript
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
 
 # Garbage files
 .DS_Store
 
-# Generated by integration tests
-test/fixtures/tmp
-test/fixtures/out
+# Test results
+test.xunit

.gitignore

@@ -0,0 +1 @@
+package-lock=false

.jscsrc

@@ -0,0 +1,3 @@
+coverage/
+.nyc_output/
+CHANGELOG.md

.npmrc

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 Blaine Bublitz <blaine.bublitz@gmail.com>, Eric Schoffstall <yo@contra.io> and other contributors
+Copyright (c) 2017-2018, 2020, 2022-2023 Blaine Bublitz <blaine.bublitz@gmail.com> and Eric Schoffstall <yo@contra.io>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

.prettierignore

@@ -1,12 +1,12 @@
 <p align="center">
-  <a href="http://gulpjs.com">
+  <a href="https://gulpjs.com">
     <img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
   </a>
 </p>
 
 # glob-watcher
 
-[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
+[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][ci-image]][ci-url] [![Coveralls Status][coveralls-image]][coveralls-url]
 
 Watch globs and execute a function upon change, with intelligent defaults for debouncing and queueing.
 
@@ -114,24 +114,22 @@ Options are passed directly to [chokidar][chokidar].
 
 MIT
 
-[micromatch]: https://github.com/micromatch/micromatch
-[normalize-path]: https://www.npmjs.com/package/normalize-path
-[micromatch-backslashes]: https://github.com/micromatch/micromatch#backslashes
-[async-completion]: https://github.com/gulpjs/async-done#completion-and-error-resolution
-[chokidar]: https://github.com/paulmillr/chokidar
-
-[downloads-image]: http://img.shields.io/npm/dm/glob-watcher.svg
+<!-- prettier-ignore-start -->
+[downloads-image]: https://img.shields.io/npm/dm/glob-watcher.svg?style=flat-square
 [npm-url]: https://npmjs.com/package/glob-watcher
-[npm-image]: http://img.shields.io/npm/v/glob-watcher.svg
+[npm-image]: https://img.shields.io/npm/v/glob-watcher.svg?style=flat-square
 
-[travis-url]: https://travis-ci.org/gulpjs/glob-watcher
-[travis-image]: http://img.shields.io/travis/gulpjs/glob-watcher.svg?label=travis-ci
-
-[appveyor-url]: https://ci.appveyor.com/project/gulpjs/glob-watcher
-[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/glob-watcher.svg?label=appveyor
+[ci-url]: https://github.com/gulpjs/glob-watcher/actions?query=workflow:dev
+[ci-image]: https://img.shields.io/github/workflow/status/gulpjs/glob-watcher/dev?style=flat-square
 
 [coveralls-url]: https://coveralls.io/r/gulpjs/glob-watcher
-[coveralls-image]: http://img.shields.io/coveralls/gulpjs/glob-watcher/master.svg
+[coveralls-image]: https://img.shields.io/coveralls/gulpjs/glob-watcher/master.svg?style=flat-square
+<!-- prettier-ignore-end -->
 
-[gitter-url]: https://gitter.im/gulpjs/gulp
-[gitter-image]: https://badges.gitter.im/gulpjs/gulp.png
+<!-- prettier-ignore-start -->
+[micromatch]: https://github.com/micromatch/micromatch
+[normalize-path]: https://www.npmjs.com/package/normalize-path
+[micromatch-backslashes]: https://github.com/micromatch/micromatch#backslashes
+[async-completion]: https://github.com/gulpjs/async-done#completion-and-error-resolution
+[chokidar]: https://github.com/paulmillr/chokidar
+<!-- prettier-ignore-end -->

.travis.yml

@@ -1,113 +1,32 @@
 'use strict';
 
 var chokidar = require('chokidar');
-var debounce = require('just-debounce');
 var asyncDone = require('async-done');
-var defaults = require('object.defaults/immutable');
-var isNegatedGlob = require('is-negated-glob');
-var anymatch = require('anymatch');
-var normalize = require('normalize-path');
+var normalizeArgs = require('./lib/normalize-args');
+var debounce = require('./lib/debounce');
 
-var defaultOpts = {
-  delay: 200,
-  events: ['add', 'change', 'unlink'],
-  ignored: [],
-  ignoreInitial: true,
-  queue: true,
-};
-
-function listenerCount(ee, evtName) {
-  if (typeof ee.listenerCount === 'function') {
-    return ee.listenerCount(evtName);
-  }
-
-  return ee.listeners(evtName).length;
-}
-
-function hasErrorListener(ee) {
-  return listenerCount(ee, 'error') !== 0;
+function watch(glob, options, cb) {
+  return normalizeArgs(glob, options, cb, watchProc);
 }
 
-function exists(val) {
-  return val != null;
+function watchProc(globs, options, cb) {
+  var watcher = chokidar.watch(globs, options);
+  registerWatchEvent(watcher, options, cb);
+  return watcher;
 }
 
-function watch(glob, options, cb) {
-  if (typeof options === 'function') {
-    cb = options;
-    options = {};
-  }
-
-  var opt = defaults(options, defaultOpts);
-
-  if (!Array.isArray(opt.events)) {
-    opt.events = [opt.events];
-  }
-
-  if (Array.isArray(glob)) {
-    // We slice so we don't mutate the passed globs array
-    glob = glob.slice();
-  } else {
-    glob = [glob];
+function registerWatchEvent(watcher, opts, cb) {
+  if (typeof cb !== 'function') {
+    return;
   }
 
   var queued = false;
   var running = false;
 
-  // These use sparse arrays to keep track of the index in the
-  // original globs array
-  var positives = new Array(glob.length);
-  var negatives = new Array(glob.length);
-
-  // Reverse the glob here so we don't end up with a positive
-  // and negative glob in position 0 after a reverse
-  glob.reverse().forEach(sortGlobs);
-
-  function sortGlobs(globString, index) {
-    var result = isNegatedGlob(globString);
-    if (result.negated) {
-      negatives[index] = result.pattern;
-    } else {
-      positives[index] = result.pattern;
-    }
-  }
-
-  var toWatch = positives.filter(exists);
-
-  function joinCwd(glob) {
-    if (glob && opt.cwd) {
-      return normalize(opt.cwd + '/' + glob);
-    }
-
-    return glob;
-  }
-
-  // We only do add our custom `ignored` if there are some negative globs
-  // TODO: I'm not sure how to test this
-  if (negatives.some(exists)) {
-    var normalizedPositives = positives.map(joinCwd);
-    var normalizedNegatives = negatives.map(joinCwd);
-    var shouldBeIgnored = function(path) {
-      var positiveMatch = anymatch(normalizedPositives, path, true);
-      var negativeMatch = anymatch(normalizedNegatives, path, true);
-      // If negativeMatch is -1, that means it was never negated
-      if (negativeMatch === -1) {
-        return false;
-      }
-
-      // If the negative is "less than" the positive, that means
-      // it came later in the glob array before we reversed them
-      return negativeMatch < positiveMatch;
-    };
-
-    opt.ignored = [].concat(opt.ignored, shouldBeIgnored);
-  }
-  var watcher = chokidar.watch(toWatch, opt);
-
   function runComplete(err) {
     running = false;
 
-    if (err && hasErrorListener(watcher)) {
+    if (err && watcher.listenerCount('error') > 0) {
       watcher.emit('error', err);
     }
 
@@ -120,7 +39,7 @@ function watch(glob, options, cb) {
 
   function onChange() {
     if (running) {
-      if (opt.queue) {
+      if (opts.queue) {
         queued = true;
       }
       return;
@@ -130,20 +49,12 @@ function watch(glob, options, cb) {
     asyncDone(cb, runComplete);
   }
 
-  var fn;
-  if (typeof cb === 'function') {
-    fn = debounce(onChange, opt.delay);
-  }
+  var debounced = debounce(onChange, opts.delay);
+  opts.events.forEach(watchEvent);
 
   function watchEvent(eventName) {
-    watcher.on(eventName, fn);
+    watcher.on(eventName, debounced);
   }
-
-  if (fn) {
-    opt.events.forEach(watchEvent);
-  }
-
-  return watcher;
 }
 
 module.exports = watch;

LICENSE

@@ -0,0 +1,26 @@
+'use strict';
+
+function debounce(fn, delay) {
+  var timeout;
+  var args;
+  var self;
+
+  return function() {
+    self = this;
+    args = arguments;
+    clear();
+    timeout = setTimeout(run, delay);
+  };
+
+  function run() {
+    clear();
+    fn.apply(self, args);
+  }
+
+  function clear() {
+    clearTimeout(timeout);
+    timeout = null;
+  }
+}
+
+module.exports = debounce;

README.md

@@ -0,0 +1,33 @@
+'use strict';
+
+var defaultOpts = {
+  delay: 200,
+  events: ['add', 'change', 'unlink'],
+  ignored: [],
+  ignoreInitial: true,
+  queue: true,
+};
+
+function normalizeArgs(glob, options, cb, next) {
+  if (typeof options === 'function') {
+    cb = options;
+    options = {};
+  }
+
+  var opts = Object.assign({}, defaultOpts, options);
+
+  if (!Array.isArray(opts.events)) {
+    opts.events = [opts.events];
+  }
+
+  if (Array.isArray(glob)) {
+    // We slice so we don't mutate the passed globs array
+    glob = glob.slice();
+  } else {
+    glob = [glob];
+  }
+
+  return next(glob, opts, cb);
+}
+
+module.exports = normalizeArgs;

appveyor.yml

@@ -2,44 +2,46 @@
   "name": "glob-watcher",
   "version": "5.0.5",
   "description": "Watch globs and execute a function upon change, with intelligent defaults for debouncing and queueing.",
-  "author": "Gulp Team <team@gulpjs.com> (http://gulpjs.com/)",
+  "author": "Gulp Team <team@gulpjs.com> (https://gulpjs.com/)",
   "contributors": [],
   "repository": "gulpjs/glob-watcher",
   "license": "MIT",
   "engines": {
-    "node": ">= 0.10"
+    "node": ">= 10.13.0"
   },
   "main": "index.js",
   "files": [
-    "index.js"
+    "index.js",
+    "lib/"
   ],
   "scripts": {
     "lint": "eslint .",
     "pretest": "npm run lint",
-    "test": "mocha --async-only",
-    "cover": "istanbul cover _mocha --report lcovonly",
-    "coveralls": "npm run cover && istanbul-coveralls"
+    "test": "nyc mocha test test/lib --async-only"
   },
   "dependencies": {
-    "anymatch": "^2.0.0",
-    "async-done": "^1.2.0",
-    "chokidar": "^2.0.0",
-    "is-negated-glob": "^1.0.0",
-    "just-debounce": "^1.0.0",
-    "normalize-path": "^3.0.0",
-    "object.defaults": "^1.1.0"
+    "async-done": "^2.0.0",
+    "chokidar": "^3.5.3"
   },
   "devDependencies": {
-    "coveralls": "^2.11.2",
-    "eslint": "^2.13.1",
-    "eslint-config-gulp": "^3.0.1",
-    "expect": "^1.16.0",
-    "istanbul": "^0.4.0",
-    "istanbul-coveralls": "^1.0.1",
-    "mocha": "^2.0.0",
-    "mocha-lcov-reporter": "^1.2.0",
-    "rimraf": "^2.6.1",
-    "through2": "^2.0.1"
+    "eslint": "^7.32.0",
+    "eslint-config-gulp": "^5.0.1",
+    "expect": "^27.5.1",
+    "mocha": "^8.4.0",
+    "normalize-path": "^3.0.0",
+    "nyc": "^15.1.0",
+    "rimraf": "^3.0.2",
+    "sinon": "^14.0.0",
+    "through2": "^4.0.2"
+  },
+  "nyc": {
+    "reporter": [
+      "lcov",
+      "text-summary"
+    ]
+  },
+  "prettier": {
+    "singleQuote": true
   },
   "keywords": [
     "watch",

index.js

@@ -4,6 +4,7 @@ var fs = require('fs');
 var path = require('path');
 
 var expect = require('expect');
+var sinon = require('sinon');
 var rimraf = require('rimraf');
 var through = require('through2');
 var normalizePath = require('normalize-path');
@@ -21,8 +22,8 @@ describe('glob-watcher', function() {
   var outFile1 = path.join(outDir, 'changed.js');
   var outFile2 = path.join(outDir, 'added.js');
   var globPattern = '**/*.js';
-  var outGlob = normalizePath(path.join(outDir, globPattern));
-  var singleAdd = normalizePath(path.join(outDir, 'changed.js'));
+  var outGlob = path.join(outDir, globPattern);
+  var singleAdd = path.join(outDir, 'changed.js');
   var ignoreGlob = '!' + singleAdd;
 
   function changeFile() {
@@ -257,10 +258,9 @@ describe('glob-watcher', function() {
   });
 
   it('watches exactly the given event', function(done) {
-    var spy = expect.createSpy()
-    .andCall(function(cb) {
+    var spy = sinon.spy(function(cb) {
       cb();
-      spy.andThrow(new Error('`Add` handler called for `change` event'));
+      expect(spy.callCount).toEqual(1);
       setTimeout(done, 500);
       changeFile();
     });
@@ -271,14 +271,18 @@ describe('glob-watcher', function() {
   });
 
   it('accepts multiple events to watch', function(done) {
-    var spy = expect.createSpy()
-    .andThrow(new Error('`Add`/`Unlink` handler called for `change` event'));
+    var spy = sinon.spy(function(cb) {
+      cb();
+      if (spy.callCount === 2) {
+        done();
+      }
+    });
 
-    watcher = watch(outGlob, { events: ['add', 'unlink'] }, spy);
+    watcher = watch(outGlob, { events: ['add', 'change'] }, spy);
 
-    watcher.on('ready', function() {
-      changeFile();
-      setTimeout(done, 500);
+    watcher.on('ready', addFile);
+    watcher.on('add', function() {
+      setTimeout(changeFile, 500);
     });
   });
 
@@ -309,6 +313,23 @@ describe('glob-watcher', function() {
     watcher.on('ready', changeFile);
   });
 
+  it('can re-add a glob after it has been negated (unix style path)', function(done) {
+    watcher = watch([
+      normalizePath(outGlob),
+      normalizePath(ignoreGlob),
+      normalizePath(singleAdd),
+    ]);
+
+    watcher.once('change', function(filepath) {
+      // chokidar pass windows style path on windows.
+      expect(filepath).toEqual(singleAdd);
+      done();
+    });
+
+    // We default `ignoreInitial` to true, so always wait for `on('ready')`
+    watcher.on('ready', changeFile);
+  });
+
   it('does not mutate the globs array', function(done) {
     var globs = [outGlob, ignoreGlob, singleAdd];
     watcher = watch(globs);

lib/debounce.js

@@ -0,0 +1,90 @@
+'use strict';
+
+var expect = require('expect');
+var sinon = require('sinon');
+var debounce = require('../../lib/debounce');
+
+describe('lib/debounce', function() {
+
+  it('should call an original function with specified delay', function(done) {
+    expect.assertions(1);
+
+    var executed = false;
+    var fn = debounce(function() {
+      executed = true;
+    }, 10);
+
+    fn();
+
+    expect(executed).toBeFalsy();
+
+    setTimeout(function() {
+      expect(executed).toBeTruthy();
+      done();
+    }, 11);
+  });
+
+  it('should extend delay against multiple calls', function(done) {
+    expect.assertions(1);
+
+    var fn = debounce(function(a) {
+      expect(a).toBe(3);
+      done();
+    }, 50);
+
+    fn(1);
+    fn(2);
+
+    setTimeout(function() {
+      fn(3);
+    }, 3);
+  });
+
+  it('should extends delay if a preceding call doesn\'t run yet', function(done) {
+    expect.assertions(1);
+
+    var fn = debounce(function(a) {
+      expect(a).toBe(3);
+      done();
+    }, 10);
+
+    fn(1);
+
+    setTimeout(function() {
+      fn(2);
+
+      setTimeout(function() {
+        fn(3);
+      }, 5);
+    }, 5);
+  });
+
+  it('should run if a preceding call already run', function(done) {
+    expect.assertions(2);
+
+    var spy = sinon.spy(function(a) {
+      switch (spy.callCount) {
+        case 1:
+          expect(a).toBe(2);
+          break;
+        case 2:
+          expect(a).toBe(3);
+          done();
+          break;
+        default:
+          throw new Error();
+      }
+    });
+    var fn = debounce(spy, 6);
+
+    fn(1);
+
+    setTimeout(function() {
+      fn(2);
+
+      setTimeout(function() {
+        fn(3);
+      }, 10);
+    }, 3);
+  });
+});

lib/normalize-args.js

@@ -0,0 +1,87 @@
+'use strict';
+
+var expect = require('expect');
+var normalizeArgs = require('../../lib/normalize-args');
+
+describe('lib/normalize-args', function() {
+
+  it('should normalize glob to an array', function(done) {
+    var opts0 = {
+      delay: 500,
+      events: ['all'],
+      ignored: ['.*.txt'],
+      ignoreInitial: false,
+      queue: false,
+      persistent: true,
+    };
+    var cb0 = function() {};
+
+    normalizeArgs('*.txt', opts0, cb0, function(glob, opts, cb) {
+      expect(Array.isArray(glob)).toBeTruthy();
+      expect(opts).not.toBe(opts0);
+      expect(opts).toEqual(opts0);
+      expect(cb).toBe(cb0);
+      done();
+    });
+  });
+
+  it('should complement options with default options', function(done) {
+    var glob0 = ['*.txt'];
+    var cb0 = function() {};
+
+    normalizeArgs(glob0, {}, cb0, function(glob, opts, cb) {
+      expect(glob).not.toBe(glob0);
+      expect(glob).toEqual(glob0);
+      expect(opts).toEqual({
+        delay: 200,
+        events: ['add', 'change', 'unlink'],
+        ignored: [],
+        ignoreInitial: true,
+        queue: true,
+      });
+      expect(cb).toBe(cb0);
+      done();
+    });
+  });
+
+  it('should normalize options.events to an array', function(done) {
+    var glob0 = ['*.txt'];
+    var opts0 = {
+      events: 'all',
+    };
+    var cb0 = function() {};
+
+    normalizeArgs(glob0, opts0, cb0, function(glob, opts, cb) {
+      expect(glob).not.toBe(glob0);
+      expect(glob).toEqual(glob0);
+      expect(opts).toEqual({
+        delay: 200,
+        events: ['all'],
+        ignored: [],
+        ignoreInitial: true,
+        queue: true,
+      });
+      expect(cb).toBe(cb0);
+      done();
+    });
+  });
+
+  it('should change 2nd arg to cb if 2nd arg is a function', function(done) {
+    var glob0 = ['*.txt'];
+    var cb0 = function() {};
+    normalizeArgs(glob0, cb0, undefined, function(glob, opts, cb) {
+      expect(glob).not.toBe(glob0);
+      expect(glob).toEqual(glob0);
+      expect(opts).toEqual({
+        delay: 200,
+        events: ['add', 'change', 'unlink'],
+        ignored: [],
+        ignoreInitial: true,
+        queue: true,
+      });
+      expect(cb).toBe(cb0);
+      done();
+    });
+  });
+
+});