just-task 1.13.0 → 1.14.1

package/lib/cache.d.ts

@@ -1,5 +1,6 @@
-export declare function registerCachedTask(taskName: string): void;
+/**
+ * Clears the task cache.
+ * @deprecated Task caching has been removed. This function is a no-op.
+ */
 export declare function clearCache(): void;
-export declare function isCached(taskName: string): boolean;
-export declare function saveCache(taskName: string): void;
 //# sourceMappingURL=cache.d.ts.map

package/lib/cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAaA,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAEzD;AAED,wBAAgB,UAAU,IAAI,IAAI,CAOjC;AAED,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAyBlD;AAED,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAgBhD"}
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,UAAU,IAAI,IAAI,CAEjC"}

package/lib/cache.js

@@ -1,133 +1,11 @@
 "use strict";
 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");
-const option_1 = require("./option");
-const resolve_1 = require("./resolve");
-const fs = require("fs-extra");
-const path = require("path");
-const logger_1 = require("./logger");
-const findDependents_1 = require("./package/findDependents");
-const findGitRoot_1 = require("./package/findGitRoot");
-const child_process_1 = require("child_process");
-const cachedTask = [];
-const CacheFileName = 'package-deps.json';
-function registerCachedTask(taskName) {
-    cachedTask.push(taskName);
-}
-exports.registerCachedTask = registerCachedTask;
+exports.clearCache = void 0;
+/**
+ * Clears the task cache.
+ * @deprecated Task caching has been removed. This function is a no-op.
+ */
 function clearCache() {
-    const cachePath = getCachePath();
-    const cacheFile = path.join(cachePath, CacheFileName);
-    if (fs.existsSync(cacheFile)) {
-        fs.removeSync(cacheFile);
-    }
+    // no-op
 }
 exports.clearCache = clearCache;
-function isCached(taskName) {
-    if (cachedTask.indexOf(taskName) < 0) {
-        return false;
-    }
-    const currentHash = getHash(taskName);
-    const cachePath = getCachePath();
-    const cacheFile = path.join(cachePath, CacheFileName);
-    if (!fs.existsSync(cacheFile)) {
-        return false;
-    }
-    let shouldCache = false;
-    try {
-        const cachedHash = JSON.parse(fs.readFileSync(path.join(cachePath, CacheFileName)).toString());
-        // TODO: make a more robust comparison
-        shouldCache = JSON.stringify(currentHash) === JSON.stringify(cachedHash);
-    }
-    catch (e) {
-        logger_1.logger.warn('Invalid package-deps.json detected');
-    }
-    return shouldCache;
-}
-exports.isCached = isCached;
-function saveCache(taskName) {
-    if (cachedTask.indexOf(taskName) < 0) {
-        return;
-    }
-    const cachePath = getCachePath();
-    if (!fs.pathExistsSync(cachePath)) {
-        fs.mkdirpSync(cachePath);
-    }
-    const cacheHash = getHash(taskName);
-    if (cacheHash) {
-        fs.writeFileSync(path.join(cachePath, 'package-deps.json'), JSON.stringify(cacheHash, null, 2));
-    }
-}
-exports.saveCache = saveCache;
-function getPackageRootPath() {
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const packageJsonFilePath = (0, resolve_1.resolveCwd)('package.json');
-    return path.dirname(packageJsonFilePath);
-}
-function getCachePath() {
-    const rootPath = getPackageRootPath();
-    return path.join(rootPath, 'node_modules/.just');
-}
-function getLockFileHashes() {
-    const results = {};
-    const lockFiles = ['shrinkwrap.yml', 'package-lock.json', 'yarn.lock', 'pnpmfile.js'];
-    const gitRoot = (0, findGitRoot_1.findGitRoot)();
-    const lsFileResults = (0, child_process_1.spawnSync)('git', ['ls-files', ...lockFiles], { cwd: gitRoot });
-    if (lsFileResults.status !== 0) {
-        return {};
-    }
-    const foundLockFiles = lsFileResults.stdout
-        .toString()
-        .split(/\n/)
-        .map(l => l.trim());
-    const hashResults = (0, child_process_1.spawnSync)('git', ['hash-object', ...foundLockFiles], { cwd: gitRoot });
-    if (hashResults.status !== 0) {
-        return {};
-    }
-    const hashes = hashResults.stdout
-        .toString()
-        .split(/\n/)
-        .map(l => l.trim());
-    foundLockFiles.forEach((foundLockFile, index) => {
-        results[foundLockFile] = hashes[index];
-    });
-    return results;
-}
-function getHash(taskName) {
-    (0, logger_1.mark)('cache:getHash');
-    const { ...args } = (0, option_1.argv)();
-    const packageRootPath = getPackageRootPath();
-    const packageDeps = {
-        ...Object.fromEntries((0, package_deps_hash_1.getPackageDeps)(packageRootPath)),
-        ...getLockFileHashes(),
-    };
-    const hash = {
-        args,
-        taskName,
-        hash: packageDeps,
-        dependentHashTimestamps: getDependentHashTimestamps(),
-    };
-    logger_1.logger.perf('cache:getHash');
-    return hash;
-}
-function getDependentHashTimestamps() {
-    (0, logger_1.mark)('cache:getDependentHashTimestamps');
-    const dependentPkgPaths = (0, findDependents_1.findDependents)();
-    const timestampsByPackage = {};
-    for (const pkgDepInfo of dependentPkgPaths) {
-        const pkgPath = pkgDepInfo.path;
-        const depHashFile = path.join(pkgPath, 'node_modules/.just', CacheFileName);
-        const depPackageJson = JSON.parse(fs.readFileSync(path.join(pkgPath, 'package.json'), 'utf-8'));
-        if (fs.existsSync(depHashFile)) {
-            const stat = fs.statSync(depHashFile);
-            timestampsByPackage[pkgDepInfo.name] = stat.mtimeMs;
-        }
-        else if (depPackageJson.scripts) {
-            // always updated if no hash file is found for dependants
-            timestampsByPackage[pkgDepInfo.name] = new Date().getTime();
-        }
-    }
-    logger_1.logger.perf('cache:getDependentHashTimestamps');
-    return timestampsByPackage;
-}

package/lib/interfaces.d.ts

@@ -10,6 +10,7 @@ export interface TaskContext {
 }
 export interface TaskFunction extends TaskFunctionParams {
     (this: TaskContext, done: (error?: any) => void): void | Duplex | NodeJS.Process | Promise<never> | any;
+    /** @deprecated Task caching has been removed. This property is a no-op. */
     cached?: () => void;
     description?: string;
 }

package/lib/interfaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,oBAAY,IAAI,GAAG,MAAM,GAAG,YAAY,CAAC;AAEzC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACtD,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;IACxG,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,oBAAY,IAAI,GAAG,MAAM,GAAG,YAAY,CAAC;AAEzC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAa,SAAQ,kBAAkB;IACtD,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,IAAI,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;IACxG,2EAA2E;IAC3E,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/lib/task.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"task.d.ts","sourceRoot":"","sources":["../src/task.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAG5C,wBAAgB,IAAI,CAClB,UAAU,EAAE,MAAM,GAAG,YAAY,EACjC,WAAW,CAAC,EAAE,MAAM,GAAG,YAAY,EACnC,UAAU,CAAC,EAAE,YAAY,GACxB,YAAY,CA0Cd"}
+{"version":3,"file":"task.d.ts","sourceRoot":"","sources":["../src/task.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAE5C,wBAAgB,IAAI,CAClB,UAAU,EAAE,MAAM,GAAG,YAAY,EACjC,WAAW,CAAC,EAAE,MAAM,GAAG,YAAY,EACnC,UAAU,CAAC,EAAE,YAAY,GACxB,YAAY,CAiCd"}

package/lib/task.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.task = void 0;
 const undertaker_1 = require("./undertaker");
 const wrapTask_1 = require("./wrapTask");
-const cache_1 = require("./cache");
 function task(firstParam, secondParam, thirdParam) {
     const argCount = arguments.length;
     if (argCount === 1 && typeof firstParam === 'string') {
@@ -12,9 +11,6 @@ function task(firstParam, secondParam, thirdParam) {
     else if (argCount === 2 && isString(firstParam) && isString(secondParam)) {
         // task('default', 'build');
         const wrapped = (0, wrapTask_1.wrapTask)(undertaker_1.undertaker.series(secondParam));
-        wrapped.cached = () => {
-            (0, cache_1.registerCachedTask)(firstParam);
-        };
         undertaker_1.undertaker.task(firstParam, wrapped);
         return wrapped;
     }
@@ -22,18 +18,12 @@ function task(firstParam, secondParam, thirdParam) {
         // task('pretter', prettierTask());
         // task('custom', () => { ... });
         const wrapped = (0, wrapTask_1.wrapTask)(secondParam);
-        wrapped.cached = () => {
-            (0, cache_1.registerCachedTask)(firstParam);
-        };
         undertaker_1.undertaker.task(firstParam, wrapped);
         return wrapped;
     }
     else if (argCount === 3 && isString(firstParam) && isString(secondParam) && isTaskFunction(thirdParam)) {
         // task('custom', 'describes this thing', () => { ... })
         const wrapped = (0, wrapTask_1.wrapTask)(thirdParam);
-        wrapped.cached = () => {
-            (0, cache_1.registerCachedTask)(firstParam);
-        };
         wrapped.description = secondParam;
         undertaker_1.undertaker.task(firstParam, wrapped);
         return wrapped;

package/lib/undertaker.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"undertaker.d.ts","sourceRoot":"","sources":["../src/undertaker.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC,OAAO,UAAU,GAAG,QAAQ,YAAY,CAAC,CAAC;AAE1C,QAAA,MAAM,UAAU,YAAmB,CAAC;AAgHpC,wBAAgB,QAAQ,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,YAAY,CAUlE;AAED,wBAAgB,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,YAAY,CAUhE;AAID,OAAO,EAAE,UAAU,EAAE,CAAC"}
+{"version":3,"file":"undertaker.d.ts","sourceRoot":"","sources":["../src/undertaker.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACpC,OAAO,UAAU,GAAG,QAAQ,YAAY,CAAC,CAAC;AAE1C,QAAA,MAAM,UAAU,YAAmB,CAAC;AA8GpC,wBAAgB,QAAQ,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,YAAY,CAUlE;AAED,wBAAgB,MAAM,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC,YAAY,CAUhE;AAID,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/lib/undertaker.js

@@ -4,7 +4,6 @@ exports.undertaker = exports.series = exports.parallel = void 0;
 const logger_1 = require("./logger");
 const chalk = require("chalk");
 const wrapTask_1 = require("./wrapTask");
-const cache_1 = require("./cache");
 const Undertaker = require("undertaker");
 const undertaker = new Undertaker();
 exports.undertaker = undertaker;
@@ -65,7 +64,6 @@ undertaker.on('error', function (args) {
             logger_1.logger.error(args.error.stderr);
         }
         logger_1.logger.error(chalk.yellow('------------------------------------'));
-        (0, cache_1.clearCache)();
         process.exitCode = 1;
     }
     else if (shouldLog(args)) {

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "just-task",
-  "version": "1.13.0",
+  "version": "1.14.1",
   "description": "Build task definition library",
-  "keywords": [],
   "repository": {
     "type": "git",
     "url": "https://github.com/microsoft/just"
@@ -11,6 +10,7 @@
   "license": "MIT",
   "author": "Ken Chau <kchau@microsoft.com>",
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "bin": {
     "just": "bin/just.js"
   },
@@ -26,7 +26,6 @@
     "node": ">=14"
   },
   "dependencies": {
-    "@rushstack/package-deps-hash": "^4.0.0",
     "@types/chokidar": "^2.1.3",
     "@types/undertaker": "^1.2.8",
     "@types/yargs-parser": "^20.2.2",
@@ -42,6 +41,5 @@
   "devDependencies": {
     "@types/resolve": "^1.20.2",
     "@types/undertaker-registry": "^1.0.1"
-  },
-  "typing": "lib/index.d.ts"
+  }
 }

package/src/cache.ts

@@ -1,170 +1,7 @@
-import { getPackageDeps } from '@rushstack/package-deps-hash';
-import { argv } from './option';
-import { resolveCwd } from './resolve';
-import * as fs from 'fs-extra';
-import * as path from 'path';
-import { logger, mark } from './logger';
-import { findDependents } from './package/findDependents';
-import { findGitRoot } from './package/findGitRoot';
-import { spawnSync } from 'child_process';
-
-const cachedTask: string[] = [];
-const CacheFileName = 'package-deps.json';
-
-export function registerCachedTask(taskName: string): void {
-  cachedTask.push(taskName);
-}
-
+/**
+ * Clears the task cache.
+ * @deprecated Task caching has been removed. This function is a no-op.
+ */
 export function clearCache(): void {
-  const cachePath = getCachePath();
-  const cacheFile = path.join(cachePath, CacheFileName);
-
-  if (fs.existsSync(cacheFile)) {
-    fs.removeSync(cacheFile);
-  }
-}
-
-export function isCached(taskName: string): boolean {
-  if (cachedTask.indexOf(taskName) < 0) {
-    return false;
-  }
-
-  const currentHash = getHash(taskName);
-  const cachePath = getCachePath();
-  const cacheFile = path.join(cachePath, CacheFileName);
-
-  if (!fs.existsSync(cacheFile)) {
-    return false;
-  }
-
-  let shouldCache = false;
-
-  try {
-    const cachedHash = JSON.parse(fs.readFileSync(path.join(cachePath, CacheFileName)).toString());
-
-    // TODO: make a more robust comparison
-    shouldCache = JSON.stringify(currentHash) === JSON.stringify(cachedHash);
-  } catch (e) {
-    logger.warn('Invalid package-deps.json detected');
-  }
-
-  return shouldCache;
-}
-
-export function saveCache(taskName: string): void {
-  if (cachedTask.indexOf(taskName) < 0) {
-    return;
-  }
-
-  const cachePath = getCachePath();
-
-  if (!fs.pathExistsSync(cachePath)) {
-    fs.mkdirpSync(cachePath);
-  }
-
-  const cacheHash = getHash(taskName);
-
-  if (cacheHash) {
-    fs.writeFileSync(path.join(cachePath, 'package-deps.json'), JSON.stringify(cacheHash, null, 2));
-  }
-}
-
-function getPackageRootPath() {
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  const packageJsonFilePath = resolveCwd('package.json')!;
-  return path.dirname(packageJsonFilePath);
-}
-
-function getCachePath() {
-  const rootPath = getPackageRootPath();
-  return path.join(rootPath, 'node_modules/.just');
-}
-
-interface CacheHash {
-  args: { [arg: string]: string };
-  taskName: string;
-  hash: Record<string, string>;
-  dependentHashTimestamps: { [pkgName: string]: number };
-}
-
-function getLockFileHashes(): { [file: string]: string } {
-  const results: { [file: string]: string } = {};
-
-  const lockFiles = ['shrinkwrap.yml', 'package-lock.json', 'yarn.lock', 'pnpmfile.js'];
-  const gitRoot = findGitRoot();
-  const lsFileResults = spawnSync('git', ['ls-files', ...lockFiles], { cwd: gitRoot });
-  if (lsFileResults.status !== 0) {
-    return {};
-  }
-
-  const foundLockFiles = lsFileResults.stdout
-    .toString()
-    .split(/\n/)
-    .map(l => l.trim());
-
-  const hashResults = spawnSync('git', ['hash-object', ...foundLockFiles], { cwd: gitRoot });
-
-  if (hashResults.status !== 0) {
-    return {};
-  }
-
-  const hashes = hashResults.stdout
-    .toString()
-    .split(/\n/)
-    .map(l => l.trim());
-
-  foundLockFiles.forEach((foundLockFile, index) => {
-    results[foundLockFile] = hashes[index];
-  });
-
-  return results;
-}
-
-function getHash(taskName: string): CacheHash | null {
-  mark('cache:getHash');
-
-  const { ...args } = argv();
-
-  const packageRootPath = getPackageRootPath();
-
-  const packageDeps = {
-    ...Object.fromEntries(getPackageDeps(packageRootPath)),
-    ...getLockFileHashes(),
-  };
-
-  const hash = {
-    args,
-    taskName,
-    hash: packageDeps,
-    dependentHashTimestamps: getDependentHashTimestamps(),
-  };
-
-  logger.perf('cache:getHash');
-
-  return hash;
-}
-
-function getDependentHashTimestamps() {
-  mark('cache:getDependentHashTimestamps');
-  const dependentPkgPaths = findDependents();
-
-  const timestampsByPackage: { [pkgName: string]: number } = {};
-
-  for (const pkgDepInfo of dependentPkgPaths) {
-    const pkgPath = pkgDepInfo.path;
-    const depHashFile = path.join(pkgPath, 'node_modules/.just', CacheFileName);
-    const depPackageJson = JSON.parse(fs.readFileSync(path.join(pkgPath, 'package.json'), 'utf-8'));
-
-    if (fs.existsSync(depHashFile)) {
-      const stat = fs.statSync(depHashFile);
-      timestampsByPackage[pkgDepInfo.name] = stat.mtimeMs;
-    } else if (depPackageJson.scripts) {
-      // always updated if no hash file is found for dependants
-      timestampsByPackage[pkgDepInfo.name] = new Date().getTime();
-    }
-  }
-
-  logger.perf('cache:getDependentHashTimestamps');
-
-  return timestampsByPackage;
+  // no-op
 }

package/src/interfaces.ts

@@ -12,6 +12,7 @@ export interface TaskContext {
 
 export interface TaskFunction extends TaskFunctionParams {
   (this: TaskContext, done: (error?: any) => void): void | Duplex | NodeJS.Process | Promise<never> | any;
+  /** @deprecated Task caching has been removed. This property is a no-op. */
   cached?: () => void;
   description?: string;
 }

package/src/task.ts

@@ -1,7 +1,6 @@
 import { undertaker } from './undertaker';
 import { wrapTask } from './wrapTask';
 import { TaskFunction } from './interfaces';
-import { registerCachedTask } from './cache';
 
 export function task(
   firstParam: string | TaskFunction,
@@ -16,9 +15,6 @@ export function task(
     // task('default', 'build');
 
     const wrapped = wrapTask(undertaker.series(secondParam));
-    wrapped.cached = () => {
-      registerCachedTask(firstParam);
-    };
 
     undertaker.task(firstParam, wrapped);
 
@@ -27,9 +23,6 @@ export function task(
     // task('pretter', prettierTask());
     // task('custom', () => { ... });
     const wrapped = wrapTask(secondParam as TaskFunction) as TaskFunction;
-    wrapped.cached = () => {
-      registerCachedTask(firstParam);
-    };
 
     undertaker.task(firstParam, wrapped);
 
@@ -37,9 +30,6 @@ export function task(
   } else if (argCount === 3 && isString(firstParam) && isString(secondParam) && isTaskFunction(thirdParam)) {
     // task('custom', 'describes this thing', () => { ... })
     const wrapped = wrapTask(thirdParam);
-    wrapped.cached = () => {
-      registerCachedTask(firstParam);
-    };
 
     wrapped.description = secondParam;
 

package/src/undertaker.ts

@@ -2,7 +2,6 @@ import { logger } from './logger';
 import chalk = require('chalk');
 import { wrapTask } from './wrapTask';
 import { Task } from './interfaces';
-import { clearCache } from './cache';
 import Undertaker = require('undertaker');
 
 const undertaker = new Undertaker();
@@ -84,8 +83,6 @@ undertaker.on('error', function (args: any) {
 
     logger.error(chalk.yellow('------------------------------------'));
 
-    clearCache();
-
     process.exitCode = 1;
   } else if (shouldLog(args)) {
     const duration = args.duration;