just-task 1.4.0 → 1.5.0

package/CHANGELOG.json

@@ -2,7 +2,52 @@
   "name": "just-task",
   "entries": [
     {
-      "date": "Fri, 02 Apr 2021 23:21:41 GMT",
+      "date": "Thu, 31 Mar 2022 17:04:25 GMT",
+      "tag": "just-task_v1.5.0",
+      "version": "1.5.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "dzearing@microsoft.com",
+            "package": "just-task",
+            "comment": "Upgrading package-deps-hash to latest major to remove transitive security vulnerability in validator package.",
+            "commit": "0c2e911432d9c09a7b3396d40c811260d84749ac"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 10 Sep 2021 23:58:46 GMT",
+      "tag": "just-task_v1.4.2",
+      "version": "1.4.2",
+      "comments": {
+        "patch": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "just-task",
+            "comment": "changes the dep from glob-parent which is old with chokidar directly",
+            "commit": "c08ccdcce333d655504263efd18f7fc5e82da534"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 15 Apr 2021 19:00:12 GMT",
+      "tag": "just-task_v1.4.1",
+      "version": "1.4.1",
+      "comments": {
+        "patch": [
+          {
+            "comment": "adding a check to make sure the tasks are registered only for task functions",
+            "author": "kchau@microsoft.com",
+            "commit": "52359d26690342474ce9e224f6bc2dfb94766089",
+            "package": "just-task"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 02 Apr 2021 23:21:50 GMT",
       "tag": "just-task_v1.4.0",
       "version": "1.4.0",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,36 @@
 # Change Log - just-task
 
-This log was last generated on Fri, 02 Apr 2021 23:21:41 GMT and should not be manually modified.
+This log was last generated on Thu, 31 Mar 2022 17:04:25 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 1.5.0
+
+Thu, 31 Mar 2022 17:04:25 GMT
+
+### Minor changes
+
+- Upgrading package-deps-hash to latest major to remove transitive security vulnerability in validator package. (dzearing@microsoft.com)
+
+## 1.4.2
+
+Fri, 10 Sep 2021 23:58:46 GMT
+
+### Patches
+
+- changes the dep from glob-parent which is old with chokidar directly (kchau@microsoft.com)
+
+## 1.4.1
+
+Thu, 15 Apr 2021 19:00:12 GMT
+
+### Patches
+
+- adding a check to make sure the tasks are registered only for task functions (kchau@microsoft.com)
+
 ## 1.4.0
 
-Fri, 02 Apr 2021 23:21:41 GMT
+Fri, 02 Apr 2021 23:21:50 GMT
 
 ### Minor changes
 

package/README.md

@@ -5,9 +5,8 @@
 
 `Just` is a library that organizes build tasks for your JS projects. It consists of
 
-- a build task build definition library
+- a build task definition library
 - sane preset build flows for node and browser projects featuring TypeScript, Webpack and jest
-- project scaffold tool that generates no-ejection needed repos that tracks template changes
 
 # Documentation
 
@@ -41,11 +40,9 @@ yarn test
 
 | Package            | Description                                                                             |
 | ------------------ | --------------------------------------------------------------------------------------- |
-| create-just        | Invoked by `npm init just`, a tool that scaffolds project repos                         |
 | just-task          | The task definition library that wraps `undertaker` and `yargs` libraries               |
 | just-scripts       | A reusable preset of frequently used tasks in node and browser projects                 |
-| just-stack-\*      | A set of templates to be used by the scaffold tool `create-just`                        |
-| just-scripts-utils | A set of utilities that are shared between `just-scripts` and `create-just`             |
+| just-scripts-utils | A set of utilities for `just-scripts`                                                   |
 | just-task-logger   | A shared pretty logger used to display timestamps along with a message                  |
 | documentation      | The Docusaurus site content and styles which generates the Github page for this library |
 

package/lib/cache.js

@@ -1,15 +1,4 @@
 "use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.saveCache = exports.isCached = exports.clearCache = exports.registerCachedTask = void 0;
 const package_deps_hash_1 = require("@rushstack/package-deps-hash");
@@ -107,11 +96,12 @@ function getLockFileHashes() {
 }
 function getHash(taskName) {
     just_task_logger_1.mark('cache:getHash');
-    const args = __rest(option_1.argv(), []);
+    const { ...args } = option_1.argv();
     const packageRootPath = getPackageRootPath();
-    const packageDeps = package_deps_hash_1.getPackageDeps(packageRootPath);
-    const lockFileHashes = getLockFileHashes();
-    packageDeps.files = Object.assign(Object.assign({}, packageDeps.files), lockFileHashes);
+    const packageDeps = {
+        ...Object.fromEntries(package_deps_hash_1.getPackageDeps(packageRootPath)),
+        ...getLockFileHashes()
+    };
     const hash = {
         args,
         taskName,

package/lib/cli.js

@@ -38,7 +38,9 @@ const configModule = config_1.readConfig();
 // Support named task function as exports of a config module
 if (configModule && typeof configModule === 'object') {
     for (const taskName of Object.keys(configModule)) {
-        task_1.task(taskName, configModule[taskName]);
+        if (typeof configModule[taskName] == 'function') {
+            task_1.task(taskName, configModule[taskName]);
+        }
     }
 }
 const command = option_1.parseCommand();

package/lib/resolve.js

@@ -1,15 +1,4 @@
 "use strict";
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveCwd = exports.resolve = exports._getResolvePaths = exports._tryResolve = exports._isFileNameLike = exports.resetResolvePaths = exports.addResolvePath = void 0;
 const resolve_1 = require("resolve");
@@ -45,9 +34,9 @@ exports._isFileNameLike = _isFileNameLike;
  */
 function _tryResolve(moduleName, options) {
     try {
-        const { cwd } = options, rest = __rest(options, ["cwd"]);
+        const { cwd, ...rest } = options;
         const nameToResolve = _isFileNameLike(moduleName) ? `./${moduleName}` : moduleName;
-        return resolve_1.sync(nameToResolve, Object.assign(Object.assign({ basedir: cwd }, rest), { preserveSymlinks: true }));
+        return resolve_1.sync(nameToResolve, { basedir: cwd, ...rest, preserveSymlinks: true });
     }
     catch (e) {
         return null;
@@ -78,7 +67,7 @@ function resolve(moduleName, cwdOrOptions) {
     const allResolvePaths = _getResolvePaths(options.cwd);
     let resolved = null;
     for (const tryPath of allResolvePaths) {
-        resolved = _tryResolve(moduleName, Object.assign(Object.assign({}, options), { cwd: tryPath }));
+        resolved = _tryResolve(moduleName, { ...options, cwd: tryPath });
         if (resolved) {
             return resolved;
         }

package/lib/watch.d.ts

@@ -1,4 +1,7 @@
-import { TaskFunction } from './interfaces';
+/// <reference types="node" />
 import type { WatchOptions, FSWatcher } from 'chokidar';
-export declare function watch(globs: string | string[], optionsOrTaskFunction?: TaskFunction | WatchOptions | undefined, taskFunction?: TaskFunction | undefined): FSWatcher;
+import type { Stats } from 'fs';
+declare type WatchListener = (path: string, stats?: Stats) => void;
+export declare function watch(globs: string | string[], optionsOrListener?: WatchListener | WatchOptions | undefined, listener?: WatchListener | undefined): FSWatcher;
+export {};
 //# sourceMappingURL=watch.d.ts.map

package/lib/watch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../src/watch.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAExD,wBAAgB,KAAK,CACnB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EACxB,qBAAqB,CAAC,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS,EAC/D,YAAY,CAAC,EAAE,YAAY,GAAG,SAAS,GACtC,SAAS,CAYX"}
+{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../src/watch.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,IAAI,CAAC;AAEhC,aAAK,aAAa,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;AAE3D,wBAAgB,KAAK,CACnB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,EACxB,iBAAiB,CAAC,EAAE,aAAa,GAAG,YAAY,GAAG,SAAS,EAC5D,QAAQ,CAAC,EAAE,aAAa,GAAG,SAAS,GACnC,SAAS,CAoBX"}

package/lib/watch.js

@@ -1,19 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.watch = void 0;
-const globWatch = require("glob-watcher");
-const wrapTask_1 = require("./wrapTask");
-function watch(globs, optionsOrTaskFunction, taskFunction) {
+function watch(globs, optionsOrListener, listener) {
+    const chokidar = require('chokidar');
     let options = {};
-    if (typeof optionsOrTaskFunction === 'function') {
-        taskFunction = optionsOrTaskFunction;
+    if (typeof optionsOrListener === 'function') {
+        listener = optionsOrListener;
         options = {};
     }
     else {
-        options = optionsOrTaskFunction;
+        options = optionsOrListener;
     }
+    options = { ...options, ignoreInitial: true };
     // Wrapping this function teaches the glob-watcher about how to deal with sync taskFunction
-    const wrappedFunction = wrapTask_1.wrapTask(taskFunction);
-    return globWatch(globs, options, wrappedFunction);
+    const innerListener = listener; // eslint-disable-line
+    const watcher = chokidar.watch(globs, options);
+    for (const evt of ['add', 'change', 'unlink']) {
+        watcher.on(evt, innerListener);
+    }
+    return watcher;
 }
 exports.watch = watch;

package/lib/wrapTask.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wrapTask.d.ts","sourceRoot":"","sources":["../src/wrapTask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAG5C,wBAAgB,QAAQ,CAAC,EAAE,EAAE,GAAG,GAAG,YAAY,CAsB9C"}
+{"version":3,"file":"wrapTask.d.ts","sourceRoot":"","sources":["../src/wrapTask.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAG5C,wBAAgB,QAAQ,CAAC,EAAE,EAAE,GAAG,GAAG,YAAY,CAwB9C"}

package/lib/wrapTask.js

@@ -20,7 +20,9 @@ function wrapTask(fn) {
             else if (results && results.then) {
                 return results;
             }
-            done();
+            if (typeof done === 'function') {
+                done();
+            }
         }
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "just-task",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Build task definition library",
   "keywords": [],
   "repository": {
@@ -20,7 +20,7 @@
     "test": "jest"
   },
   "dependencies": {
-    "@rushstack/package-deps-hash": "^2.4.109",
+    "@rushstack/package-deps-hash": "^3.2.5",
     "bach": "^1.2.0",
     "chalk": "^4.0.0",
     "fs-extra": "^8.0.0",
@@ -29,12 +29,11 @@
     "undertaker": "^1.3.0",
     "undertaker-registry": "^1.0.1",
     "yargs-parser": "^20.2.3",
-    "glob-watcher": "^5.0.5"
+    "chokidar": "^3.5.2"
   },
   "devDependencies": {
     "@types/chokidar": "^2.1.3",
     "@types/fs-extra": "^8.0.0",
-    "@types/glob-watcher": "^5.0.0",
     "@types/jest": "^26.0.20",
     "@types/mock-fs": "^4.13.0",
     "@types/node": "^10.12.18",

package/src/__tests__/watch.spec.ts

@@ -13,6 +13,7 @@ describe('watch', () => {
 
     const cleanup = () => {
       watcher.close();
+
       fs.unlinkSync(changeFile);
       fs.rmdirSync(tmpDir);
     };
@@ -27,6 +28,7 @@ describe('watch', () => {
         done(error);
       }
     };
+
     const watcher = watch([path.join(changeFile)], callback);
 
     watcher.on('ready', () => {

package/src/cache.ts

@@ -1,4 +1,4 @@
-import { getPackageDeps, IPackageDeps } from '@rushstack/package-deps-hash';
+import { getPackageDeps } from '@rushstack/package-deps-hash';
 import { argv } from './option';
 import { resolveCwd } from './resolve';
 import * as fs from 'fs-extra';
@@ -83,7 +83,7 @@ function getCachePath() {
 interface CacheHash {
   args: { [arg: string]: string };
   taskName: string;
-  hash: IPackageDeps;
+  hash: Record<string, string>;
   dependentHashTimestamps: { [pkgName: string]: number };
 }
 
@@ -127,11 +127,10 @@ function getHash(taskName: string): CacheHash | null {
 
   const packageRootPath = getPackageRootPath();
 
-  const packageDeps = getPackageDeps(packageRootPath);
-
-  const lockFileHashes = getLockFileHashes();
-
-  packageDeps.files = { ...packageDeps.files, ...lockFileHashes };
+  const packageDeps = {
+    ...Object.fromEntries(getPackageDeps(packageRootPath)),
+    ...getLockFileHashes()
+  };
 
   const hash = {
     args,

package/src/cli.ts

@@ -47,7 +47,9 @@ const configModule = readConfig();
 // Support named task function as exports of a config module
 if (configModule && typeof configModule === 'object') {
   for (const taskName of Object.keys(configModule)) {
-    task(taskName, configModule[taskName]);
+    if (typeof configModule[taskName] == 'function') {
+      task(taskName, configModule[taskName]);
+    }
   }
 }
 

package/src/watch.ts

@@ -1,22 +1,30 @@
-import * as globWatch from 'glob-watcher';
-import { wrapTask } from './wrapTask';
-import { TaskFunction } from './interfaces';
 import type { WatchOptions, FSWatcher } from 'chokidar';
+import type { Stats } from 'fs';
+
+type WatchListener = (path: string, stats?: Stats) => void;
 
 export function watch(
   globs: string | string[],
-  optionsOrTaskFunction?: TaskFunction | WatchOptions | undefined,
-  taskFunction?: TaskFunction | undefined,
+  optionsOrListener?: WatchListener | WatchOptions | undefined,
+  listener?: WatchListener | undefined,
 ): FSWatcher {
+  const chokidar = require('chokidar');
+
   let options: WatchOptions = {};
-  if (typeof optionsOrTaskFunction === 'function') {
-    taskFunction = optionsOrTaskFunction;
+  if (typeof optionsOrListener === 'function') {
+    listener = optionsOrListener;
     options = {};
   } else {
-    options = optionsOrTaskFunction as WatchOptions;
+    options = optionsOrListener as WatchOptions;
   }
 
+  options = { ...options, ignoreInitial: true };
+
   // Wrapping this function teaches the glob-watcher about how to deal with sync taskFunction
-  const wrappedFunction = wrapTask(taskFunction);
-  return globWatch(globs, options, wrappedFunction) as FSWatcher;
+  const innerListener = listener!; // eslint-disable-line
+  const watcher = chokidar.watch(globs, options) as FSWatcher;
+  for (const evt of ['add', 'change', 'unlink']) {
+    watcher.on(evt, innerListener);
+  }
+  return watcher;
 }

package/src/wrapTask.ts

@@ -20,7 +20,9 @@ export function wrapTask(fn: any): TaskFunction {
         return results;
       }
 
-      done();
+      if (typeof done === 'function') {
+        done();
+      }
     }
   };
 }