cache-cmd 0.2.0-dev.4a662091d40f9510cff02e70023e5919708daa8f

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Dany Castillo
+
+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.

package/README.md

@@ -0,0 +1,57 @@
+# cache-cmd
+
+Cache a command based on
+
+-   time since last run
+-   file change
+
+## Install
+
+```sh
+yarn add --dev cache-cmd
+```
+
+or
+
+```sh
+npm install --save-dev cache-cmd
+```
+
+## Usage
+
+```sh
+# Shows help
+yarn cache-cmd --help
+
+# Runs command if it was not run in the last 20s
+yarn cache-cmd "echo ran this command" --time 20s
+
+# Runs comand if yarn.lock in current directory changed since last run
+yarn cache-cmd "yarn install" --file yarn.lock
+
+# Additionally uses custom cache directory instead of default in node_modules
+yarn cache-cmd "yarn install" --file yarn.lock --cache-dir .config/cache
+
+# Runs command if it was not run in a month or any of the files changed
+yarn cache-cmd "yarn install" --time 1mo --file yarn.lock --file package.json
+
+# Shows path to cache directory
+yarn cache-cmd cache dir
+
+# Clear cache
+yarn cache-cmd cache clear
+```
+
+You can use it to execute commands conditionally in `package.json` scripts.
+
+```json
+{
+    "scripts": {
+        "dev": "cache-cmd \"yarn\" --file yarn.lock && start-dev-server"
+    }
+}
+```
+
+## Contribute
+
+If you find a bug or something you don't like, please [submit an issue](https://github.com/dcastil/cache-cmd/issues/new) or a pull request. I'm happy about any kind of feedback!

package/dist/cli.cjs

@@ -0,0 +1,262 @@
+#!/usr/bin/env node
+'use strict';
+
+var hardRejection = require('hard-rejection');
+var sade = require('sade');
+var del = require('del');
+var path = require('path');
+var findCacheDir = require('find-cache-dir');
+var makeDir = require('make-dir');
+var dateFns = require('date-fns');
+var execSh = require('exec-sh');
+var flatCache = require('flat-cache');
+var lodash = require('lodash');
+var hasha = require('hasha');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var hardRejection__default = /*#__PURE__*/_interopDefaultLegacy(hardRejection);
+var sade__default = /*#__PURE__*/_interopDefaultLegacy(sade);
+var del__default = /*#__PURE__*/_interopDefaultLegacy(del);
+var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
+var findCacheDir__default = /*#__PURE__*/_interopDefaultLegacy(findCacheDir);
+var makeDir__default = /*#__PURE__*/_interopDefaultLegacy(makeDir);
+var execSh__default = /*#__PURE__*/_interopDefaultLegacy(execSh);
+var flatCache__default = /*#__PURE__*/_interopDefaultLegacy(flatCache);
+var hasha__default = /*#__PURE__*/_interopDefaultLegacy(hasha);
+
+var name = "cache-cmd";
+var version = "0.2.0";
+
+function getCacheDirectoryPath(relativeCacheDirectoryPath) {
+  if (relativeCacheDirectoryPath) {
+    return path__default["default"].resolve(process.cwd(), relativeCacheDirectoryPath);
+  }
+
+  const resolvedCacheDirectory = findCacheDir__default["default"]({
+    name
+  });
+
+  if (!resolvedCacheDirectory) {
+    throw Error('Could not find cache directory. Please provide a cache directory manually.');
+  }
+
+  return resolvedCacheDirectory;
+}
+function createCache(relativeCacheDirectoryPath) {
+  if (relativeCacheDirectoryPath) {
+    const absoluteCacheDirectoryPath = makeDir__default["default"].sync(relativeCacheDirectoryPath);
+    return absoluteCacheDirectoryPath;
+  }
+
+  const resolvedCachePath = findCacheDir__default["default"]({
+    name,
+    create: true
+  });
+
+  if (!resolvedCachePath) {
+    throw Error('Could not find cache directory. Please provide a cache directory manually.');
+  }
+
+  return resolvedCachePath;
+}
+
+function clearCacheDirectory(relativeCacheDirectory) {
+  const deletedPaths = del__default["default"].sync(getCacheDirectoryPath(relativeCacheDirectory));
+
+  if (deletedPaths.length === 0) {
+    console.log('No cache to clear');
+  } else if (deletedPaths.length === 1) {
+    console.log(`Deleted: ${deletedPaths[0]}`);
+  } else {
+    console.log('Deleted:\n', deletedPaths.join('\n'));
+  }
+}
+
+function showCacheDirectory(relativeCacheDirectory) {
+  console.log(getCacheDirectoryPath(relativeCacheDirectory));
+}
+
+function getCacheKey({
+  duration,
+  filePaths,
+  command
+}) {
+  return ['cwd:' + process.cwd(), 'cmd:' + command, duration && 'time:' + JSON.stringify(duration), filePaths.length !== 0 && 'files:' + filePaths.join(',')].filter(Boolean).join(' ---');
+}
+
+function getDuration(durationString) {
+  if (!/^(\d+[a-z]+)+$/gi.test(durationString)) {
+    throw Error(`Invalid duration: ${durationString}`);
+  }
+
+  const duration = {
+    years: undefined,
+    months: undefined,
+    weeks: undefined,
+    days: undefined,
+    hours: undefined,
+    minutes: undefined,
+    seconds: undefined
+  };
+  durationString.match(/\d+[a-z]+/gi).forEach(durationPart => {
+    const [, stringQuantity, unitShort] = /(\d+)([a-z]+)/gi.exec(durationPart);
+    const quantity = Number(stringQuantity);
+    const unitLong = {
+      y: 'years',
+      mo: 'months',
+      w: 'weeks',
+      d: 'days',
+      h: 'hours',
+      m: 'minutes',
+      s: 'seconds'
+    }[unitShort];
+
+    if (Number.isNaN(quantity) || !unitLong) {
+      throw Error(`Invalid duration part: ${durationPart}`);
+    }
+
+    if (duration[unitLong] !== undefined) {
+      throw Error(`Duration with unit ${unitLong} was supplied multiple times`);
+    }
+
+    duration[unitLong] = quantity;
+  });
+  return duration;
+}
+
+async function getFileHashes(filePaths) {
+  return Object.fromEntries(await Promise.all(filePaths.map(filePath => hasha__default["default"].fromFile(filePath, {
+    algorithm: 'md5'
+  }).then(hash => [filePath, hash]))));
+}
+
+function getFilePaths(relativeFilePaths) {
+  const cwd = process.cwd();
+  return relativeFilePaths.map(file => path__default["default"].resolve(cwd, file)).sort();
+}
+
+async function runCommand({
+  relativeCacheDirectory,
+  command,
+  cacheByTime: cacheByTime,
+  cacheByFiles: cacheByFiles,
+  shouldCacheOnError
+}) {
+  if (!cacheByTime && cacheByFiles.length === 0) {
+    await execSh__default["default"].promise(command);
+    return;
+  }
+
+  const cache = flatCache__default["default"].load('commands-cache.json', createCache(relativeCacheDirectory));
+  const filePaths = getFilePaths(cacheByFiles);
+  const duration = cacheByTime ? getDuration(cacheByTime) : undefined;
+  const cacheKey = getCacheKey({
+    duration,
+    filePaths,
+    command
+  });
+  const cacheData = cache.getKey(cacheKey);
+  const fileHashes = filePaths.length === 0 ? undefined : await getFileHashes(filePaths);
+  const currentDate = new Date();
+  const areFileHashesEqual = lodash.isEqual(cacheData == null ? void 0 : cacheData.fileHashes, fileHashes);
+
+  const isWithinCacheTime = (() => {
+    if (!duration) {
+      return true;
+    }
+
+    const lastRun = cacheData == null ? void 0 : cacheData.lastRun;
+
+    if (!lastRun) {
+      return false;
+    }
+
+    return dateFns.isAfter(dateFns.add(new Date(lastRun), duration), currentDate);
+  })();
+
+  if (areFileHashesEqual && isWithinCacheTime) {
+    return;
+  }
+
+  let execPromise = execSh__default["default"].promise(command);
+
+  if (shouldCacheOnError) {
+    execPromise = execPromise.catch(error => {
+      cache.setKey(cacheKey, {
+        lastRun: currentDate,
+        fileHashes
+      });
+      cache.save(true);
+      throw error;
+    });
+  }
+
+  await execPromise;
+  cache.setKey(cacheKey, {
+    lastRun: currentDate,
+    fileHashes
+  });
+  cache.save(true);
+}
+
+hardRejection__default["default"]();
+const program = sade__default["default"]('cache-cmd');
+program.version(version).describe('Run and cache a command based on various factors').option('-c, --cache-dir', 'Cache directory to use (default: .cache/cache-cmd in nearest node_modules)');
+program.command('run <command>', 'Run cached command (if no <command> provided, this is the default)', {
+  default: true
+}).option('-f, --file', 'Run command only when file content changes').option('-t, --time', 'Run command only after specified time (unit with s,m,h,d,w,mo,y)').option('--cache-on-error', 'Cache command run even when command exits with non-zero exit code').example('run "echo ran this command" --time 20s').example('run "./may-fail" --time 20s --cache-on-error').example('run "yarn install" --file yarn.lock').example('run "yarn install" --file yarn.lock --cache-dir .config/cache').example('run "yarn install" --time 1mo --file yarn.lock --file package.json').action((command, options) => {
+  const cacheDirectory = options['cache-dir'];
+  const time = options.time;
+  const file = options.file;
+  const shouldCacheOnError = options['cache-on-error'];
+  const files = file === undefined ? [] : Array.isArray(file) ? file : [file];
+
+  if (typeof command !== 'string') {
+    throw Error('Invalid <command> supplied');
+  }
+
+  if (cacheDirectory !== undefined && typeof cacheDirectory !== 'string') {
+    throw Error('Invalid --cache-dir supplied');
+  }
+
+  if (time !== undefined && typeof time !== 'string') {
+    throw Error('Invalid --time supplied');
+  }
+
+  if (files.some(file => typeof file !== 'string')) {
+    throw Error('Invalid --file supplied');
+  }
+
+  if (shouldCacheOnError !== undefined && typeof shouldCacheOnError !== 'boolean') {
+    throw Error('Invalid --cache-on-error supplied');
+  }
+
+  runCommand({
+    relativeCacheDirectory: cacheDirectory,
+    command,
+    cacheByTime: time,
+    cacheByFiles: files,
+    shouldCacheOnError
+  });
+});
+program.command('cache dir', 'Show cache directory path used by cache-cmd').action(options => {
+  const cacheDirectory = options['cache-dir'];
+
+  if (cacheDirectory !== undefined && typeof cacheDirectory !== 'string') {
+    throw Error('Invalid --cache-dir supplied');
+  }
+
+  showCacheDirectory(cacheDirectory);
+});
+program.command('cache clear', 'Clear cache used by cache-cmd').action(options => {
+  const cacheDirectory = options['cache-dir'];
+
+  if (cacheDirectory !== undefined && typeof cacheDirectory !== 'string') {
+    throw Error('Invalid --cache-dir supplied');
+  }
+
+  clearCacheDirectory(cacheDirectory);
+});
+program.parse(process.argv);
+//# sourceMappingURL=cli.cjs.map

package/dist/cli.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.cjs","sources":["../src/utils/get-cache-dir.ts","../src/cache-clear.ts","../src/cache-dir.ts","../src/utils/get-cache-key.ts","../src/utils/get-duration.ts","../src/utils/get-file-hashes.ts","../src/utils/get-file-paths.ts","../src/run.ts","../src/cli.ts"],"sourcesContent":["import path from 'path'\n\nimport findCacheDir from 'find-cache-dir'\nimport makeDir from 'make-dir'\n\nimport { name } from '../../package.json'\n\nexport function getCacheDirectoryPath(relativeCacheDirectoryPath: string | undefined) {\n    if (relativeCacheDirectoryPath) {\n        return path.resolve(process.cwd(), relativeCacheDirectoryPath)\n    }\n\n    const resolvedCacheDirectory = findCacheDir({ name })\n\n    if (!resolvedCacheDirectory) {\n        throw Error('Could not find cache directory. Please provide a cache directory manually.')\n    }\n\n    return resolvedCacheDirectory\n}\n\nexport function createCache(relativeCacheDirectoryPath: string | undefined) {\n    if (relativeCacheDirectoryPath) {\n        const absoluteCacheDirectoryPath = makeDir.sync(relativeCacheDirectoryPath)\n\n        return absoluteCacheDirectoryPath\n    }\n\n    const resolvedCachePath = findCacheDir({ name, create: true })\n\n    if (!resolvedCachePath) {\n        throw Error('Could not find cache directory. Please provide a cache directory manually.')\n    }\n\n    return resolvedCachePath\n}\n","import del from 'del'\n\nimport { getCacheDirectoryPath } from './utils/get-cache-dir'\n\nexport function clearCacheDirectory(relativeCacheDirectory: string | undefined) {\n    const deletedPaths = del.sync(getCacheDirectoryPath(relativeCacheDirectory))\n\n    if (deletedPaths.length === 0) {\n        console.log('No cache to clear')\n    } else if (deletedPaths.length === 1) {\n        console.log(`Deleted: ${deletedPaths[0]}`)\n    } else {\n        console.log('Deleted:\\n', deletedPaths.join('\\n'))\n    }\n}\n","import { getCacheDirectoryPath } from './utils/get-cache-dir'\n\nexport function showCacheDirectory(relativeCacheDirectory: string | undefined) {\n    console.log(getCacheDirectoryPath(relativeCacheDirectory))\n}\n","interface GetCacheKeyProps {\n    duration: Duration | undefined\n    filePaths: string[]\n    command: string\n}\n\ninterface Duration {\n    years: number | undefined\n    months: number | undefined\n    weeks: number | undefined\n    days: number | undefined\n    hours: number | undefined\n    minutes: number | undefined\n    seconds: number | undefined\n}\n\nexport function getCacheKey({ duration, filePaths, command }: GetCacheKeyProps) {\n    return [\n        'cwd:' + process.cwd(),\n        'cmd:' + command,\n        duration && 'time:' + JSON.stringify(duration),\n        filePaths.length !== 0 && 'files:' + filePaths.join(','),\n    ]\n        .filter(Boolean)\n        .join(' ---')\n}\n","export function getDuration(durationString: string) {\n    if (!/^(\\d+[a-z]+)+$/gi.test(durationString)) {\n        throw Error(`Invalid duration: ${durationString}`)\n    }\n\n    const duration = {\n        years: undefined as undefined | number,\n        months: undefined as undefined | number,\n        weeks: undefined as undefined | number,\n        days: undefined as undefined | number,\n        hours: undefined as undefined | number,\n        minutes: undefined as undefined | number,\n        seconds: undefined as undefined | number,\n    }\n\n    durationString.match(/\\d+[a-z]+/gi)!.forEach((durationPart) => {\n        const [, stringQuantity, unitShort] = /(\\d+)([a-z]+)/gi.exec(durationPart)!\n        const quantity = Number(stringQuantity)\n\n        const unitLong = (\n            {\n                y: 'years',\n                mo: 'months',\n                w: 'weeks',\n                d: 'days',\n                h: 'hours',\n                m: 'minutes',\n                s: 'seconds',\n            } as const\n        )[unitShort!]\n\n        if (Number.isNaN(quantity) || !unitLong) {\n            throw Error(`Invalid duration part: ${durationPart}`)\n        }\n\n        if (duration[unitLong] !== undefined) {\n            throw Error(`Duration with unit ${unitLong} was supplied multiple times`)\n        }\n\n        duration[unitLong] = quantity\n    })\n\n    return duration\n}\n","import hasha from 'hasha'\n\nexport async function getFileHashes(filePaths: string[]) {\n    return Object.fromEntries(\n        await Promise.all(\n            filePaths.map((filePath) =>\n                hasha\n                    .fromFile(filePath, { algorithm: 'md5' })\n                    .then((hash) => [filePath, hash] as const)\n            )\n        )\n    )\n}\n","import path from 'path'\n\nexport function getFilePaths(relativeFilePaths: string[]) {\n    const cwd = process.cwd()\n\n    return relativeFilePaths.map((file) => path.resolve(cwd, file)).sort()\n}\n","import { add, isAfter } from 'date-fns'\nimport execSh from 'exec-sh'\nimport flatCache from 'flat-cache'\nimport { isEqual } from 'lodash'\n\nimport { createCache } from './utils/get-cache-dir'\nimport { getCacheKey } from './utils/get-cache-key'\nimport { getDuration } from './utils/get-duration'\nimport { getFileHashes } from './utils/get-file-hashes'\nimport { getFilePaths } from './utils/get-file-paths'\n\ninterface RunCommandProps {\n    relativeCacheDirectory: string | undefined\n    command: string\n    cacheByTime: string | undefined\n    cacheByFiles: string[]\n    shouldCacheOnError: boolean | undefined\n}\n\nexport async function runCommand({\n    relativeCacheDirectory,\n    command,\n    cacheByTime: cacheByTime,\n    cacheByFiles: cacheByFiles,\n    shouldCacheOnError,\n}: RunCommandProps) {\n    if (!cacheByTime && cacheByFiles.length === 0) {\n        await execSh.promise(command)\n        return\n    }\n\n    const cache = flatCache.load('commands-cache.json', createCache(relativeCacheDirectory))\n    const filePaths = getFilePaths(cacheByFiles)\n    const duration = cacheByTime ? getDuration(cacheByTime) : undefined\n\n    const cacheKey = getCacheKey({ duration, filePaths, command })\n\n    const cacheData: unknown = cache.getKey(cacheKey)\n\n    const fileHashes = filePaths.length === 0 ? undefined : await getFileHashes(filePaths)\n    const currentDate = new Date()\n\n    const areFileHashesEqual = isEqual((cacheData as any)?.fileHashes, fileHashes)\n    const isWithinCacheTime = (() => {\n        if (!duration) {\n            return true\n        }\n\n        const lastRun = (cacheData as any)?.lastRun\n\n        if (!lastRun) {\n            return false\n        }\n\n        return isAfter(add(new Date(lastRun), duration), currentDate)\n    })()\n\n    if (areFileHashesEqual && isWithinCacheTime) {\n        return\n    }\n\n    let execPromise = execSh.promise(command)\n\n    if (shouldCacheOnError) {\n        execPromise = execPromise.catch((error: unknown) => {\n            cache.setKey(cacheKey, {\n                lastRun: currentDate,\n                fileHashes,\n            })\n            cache.save(true)\n\n            throw error\n        })\n    }\n\n    await execPromise\n\n    cache.setKey(cacheKey, {\n        lastRun: currentDate,\n        fileHashes,\n    })\n    cache.save(true)\n}\n","#!/usr/bin/env node\n\nimport hardRejection from 'hard-rejection'\nimport sade from 'sade'\n\nimport { version } from '../package.json'\n\nimport { clearCacheDirectory } from './cache-clear'\nimport { showCacheDirectory } from './cache-dir'\nimport { runCommand } from './run'\n\nhardRejection()\n\nconst program = sade('cache-cmd')\n\nprogram\n    .version(version)\n    .describe('Run and cache a command based on various factors')\n    .option(\n        '-c, --cache-dir',\n        'Cache directory to use (default: .cache/cache-cmd in nearest node_modules)'\n    )\n\nprogram\n    .command(\n        'run <command>',\n        'Run cached command (if no <command> provided, this is the default)',\n        { default: true }\n    )\n    .option('-f, --file', 'Run command only when file content changes')\n    .option('-t, --time', 'Run command only after specified time (unit with s,m,h,d,w,mo,y)')\n    .option('--cache-on-error', 'Cache command run even when command exits with non-zero exit code')\n    .example('run \"echo ran this command\" --time 20s')\n    .example('run \"./may-fail\" --time 20s --cache-on-error')\n    .example('run \"yarn install\" --file yarn.lock')\n    .example('run \"yarn install\" --file yarn.lock --cache-dir .config/cache')\n    .example('run \"yarn install\" --time 1mo --file yarn.lock --file package.json')\n    .action((command: unknown, options: Record<string, unknown>) => {\n        const cacheDirectory = options['cache-dir']\n        const time = options.time\n        const file = options.file\n        const shouldCacheOnError = options['cache-on-error']\n        const files: unknown[] = file === undefined ? [] : Array.isArray(file) ? file : [file]\n\n        if (typeof command !== 'string') {\n            throw Error('Invalid <command> supplied')\n        }\n\n        if (cacheDirectory !== undefined && typeof cacheDirectory !== 'string') {\n            throw Error('Invalid --cache-dir supplied')\n        }\n\n        if (time !== undefined && typeof time !== 'string') {\n            throw Error('Invalid --time supplied')\n        }\n\n        if (files.some((file) => typeof file !== 'string')) {\n            throw Error('Invalid --file supplied')\n        }\n\n        if (shouldCacheOnError !== undefined && typeof shouldCacheOnError !== 'boolean') {\n            throw Error('Invalid --cache-on-error supplied')\n        }\n\n        runCommand({\n            relativeCacheDirectory: cacheDirectory,\n            command,\n            cacheByTime: time,\n            cacheByFiles: files as string[],\n            shouldCacheOnError,\n        })\n    })\n\nprogram\n    .command('cache dir', 'Show cache directory path used by cache-cmd')\n    .action((options: Record<string, unknown>) => {\n        const cacheDirectory = options['cache-dir']\n\n        if (cacheDirectory !== undefined && typeof cacheDirectory !== 'string') {\n            throw Error('Invalid --cache-dir supplied')\n        }\n\n        showCacheDirectory(cacheDirectory)\n    })\n\nprogram\n    .command('cache clear', 'Clear cache used by cache-cmd')\n    .action((options: Record<string, unknown>) => {\n        const cacheDirectory = options['cache-dir']\n\n        if (cacheDirectory !== undefined && typeof cacheDirectory !== 'string') {\n            throw Error('Invalid --cache-dir supplied')\n        }\n\n        clearCacheDirectory(cacheDirectory)\n    })\n\nprogram.parse(process.argv)\n"],"names":["getCacheDirectoryPath","relativeCacheDirectoryPath","path","resolve","process","cwd","resolvedCacheDirectory","findCacheDir","name","Error","createCache","absoluteCacheDirectoryPath","makeDir","sync","resolvedCachePath","create","clearCacheDirectory","relativeCacheDirectory","deletedPaths","del","length","console","log","join","showCacheDirectory","getCacheKey","duration","filePaths","command","JSON","stringify","filter","Boolean","getDuration","durationString","test","years","undefined","months","weeks","days","hours","minutes","seconds","match","forEach","durationPart","stringQuantity","unitShort","exec","quantity","Number","unitLong","y","mo","w","d","h","m","s","isNaN","getFileHashes","Object","fromEntries","Promise","all","map","filePath","hasha","fromFile","algorithm","then","hash","getFilePaths","relativeFilePaths","file","sort","runCommand","cacheByTime","cacheByFiles","shouldCacheOnError","execSh","promise","cache","flatCache","load","cacheKey","cacheData","getKey","fileHashes","currentDate","Date","areFileHashesEqual","isEqual","isWithinCacheTime","lastRun","isAfter","add","execPromise","catch","error","setKey","save","hardRejection","program","sade","version","describe","option","default","example","action","options","cacheDirectory","time","files","Array","isArray","some","parse","argv"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;SAOgBA,sBAAsBC;AAClC,MAAIA,0BAAJ,EAAgC;AAC5B,WAAOC,wBAAI,CAACC,OAAL,CAAaC,OAAO,CAACC,GAAR,EAAb,EAA4BJ,0BAA5B,CAAP;AACH;;AAED,QAAMK,sBAAsB,GAAGC,gCAAY,CAAC;AAAEC,IAAAA;AAAF,GAAD,CAA3C;;AAEA,MAAI,CAACF,sBAAL,EAA6B;AACzB,UAAMG,KAAK,CAAC,4EAAD,CAAX;AACH;;AAED,SAAOH,sBAAP;AACH;SAEeI,YAAYT;AACxB,MAAIA,0BAAJ,EAAgC;AAC5B,UAAMU,0BAA0B,GAAGC,2BAAO,CAACC,IAAR,CAAaZ,0BAAb,CAAnC;AAEA,WAAOU,0BAAP;AACH;;AAED,QAAMG,iBAAiB,GAAGP,gCAAY,CAAC;AAAEC,IAAAA,IAAF;AAAQO,IAAAA,MAAM,EAAE;AAAhB,GAAD,CAAtC;;AAEA,MAAI,CAACD,iBAAL,EAAwB;AACpB,UAAML,KAAK,CAAC,4EAAD,CAAX;AACH;;AAED,SAAOK,iBAAP;AACH;;SC/BeE,oBAAoBC;AAChC,QAAMC,YAAY,GAAGC,uBAAG,CAACN,IAAJ,CAASb,qBAAqB,CAACiB,sBAAD,CAA9B,CAArB;;AAEA,MAAIC,YAAY,CAACE,MAAb,KAAwB,CAA5B,EAA+B;AAC3BC,IAAAA,OAAO,CAACC,GAAR,CAAY,mBAAZ;AACH,GAFD,MAEO,IAAIJ,YAAY,CAACE,MAAb,KAAwB,CAA5B,EAA+B;AAClCC,IAAAA,OAAO,CAACC,GAAR,aAAwBJ,YAAY,CAAC,CAAD,GAApC;AACH,GAFM,MAEA;AACHG,IAAAA,OAAO,CAACC,GAAR,CAAY,YAAZ,EAA0BJ,YAAY,CAACK,IAAb,CAAkB,IAAlB,CAA1B;AACH;AACJ;;SCZeC,mBAAmBP;AAC/BI,EAAAA,OAAO,CAACC,GAAR,CAAYtB,qBAAqB,CAACiB,sBAAD,CAAjC;AACH;;SCYeQ,YAAY;AAAEC,EAAAA,QAAF;AAAYC,EAAAA,SAAZ;AAAuBC,EAAAA;AAAvB;AACxB,SAAO,CACH,SAASxB,OAAO,CAACC,GAAR,EADN,EAEH,SAASuB,OAFN,EAGHF,QAAQ,IAAI,UAAUG,IAAI,CAACC,SAAL,CAAeJ,QAAf,CAHnB,EAIHC,SAAS,CAACP,MAAV,KAAqB,CAArB,IAA0B,WAAWO,SAAS,CAACJ,IAAV,CAAe,GAAf,CAJlC,EAMFQ,MANE,CAMKC,OANL,EAOFT,IAPE,CAOG,MAPH,CAAP;AAQH;;SCzBeU,YAAYC;AACxB,MAAI,CAAC,mBAAmBC,IAAnB,CAAwBD,cAAxB,CAAL,EAA8C;AAC1C,UAAMzB,KAAK,sBAAsByB,gBAAtB,CAAX;AACH;;AAED,QAAMR,QAAQ,GAAG;AACbU,IAAAA,KAAK,EAAEC,SADM;AAEbC,IAAAA,MAAM,EAAED,SAFK;AAGbE,IAAAA,KAAK,EAAEF,SAHM;AAIbG,IAAAA,IAAI,EAAEH,SAJO;AAKbI,IAAAA,KAAK,EAAEJ,SALM;AAMbK,IAAAA,OAAO,EAAEL,SANI;AAObM,IAAAA,OAAO,EAAEN;AAPI,GAAjB;AAUAH,EAAAA,cAAc,CAACU,KAAf,CAAqB,aAArB,EAAqCC,OAArC,CAA8CC,YAAD;AACzC,UAAM,GAAGC,cAAH,EAAmBC,SAAnB,IAAgC,kBAAkBC,IAAlB,CAAuBH,YAAvB,CAAtC;AACA,UAAMI,QAAQ,GAAGC,MAAM,CAACJ,cAAD,CAAvB;AAEA,UAAMK,QAAQ,GACV;AACIC,MAAAA,CAAC,EAAE,OADP;AAEIC,MAAAA,EAAE,EAAE,QAFR;AAGIC,MAAAA,CAAC,EAAE,OAHP;AAIIC,MAAAA,CAAC,EAAE,MAJP;AAKIC,MAAAA,CAAC,EAAE,OALP;AAMIC,MAAAA,CAAC,EAAE,SANP;AAOIC,MAAAA,CAAC,EAAE;AAPP,MASFX,SATE,CADJ;;AAYA,QAAIG,MAAM,CAACS,KAAP,CAAaV,QAAb,KAA0B,CAACE,QAA/B,EAAyC;AACrC,YAAM3C,KAAK,2BAA2BqC,cAA3B,CAAX;AACH;;AAED,QAAIpB,QAAQ,CAAC0B,QAAD,CAAR,KAAuBf,SAA3B,EAAsC;AAClC,YAAM5B,KAAK,uBAAuB2C,sCAAvB,CAAX;AACH;;AAED1B,IAAAA,QAAQ,CAAC0B,QAAD,CAAR,GAAqBF,QAArB;AACH,GAzBD;AA2BA,SAAOxB,QAAP;AACH;;ACzCM,eAAemC,aAAf,CAA6BlC,SAA7B;AACH,SAAOmC,MAAM,CAACC,WAAP,CACH,MAAMC,OAAO,CAACC,GAAR,CACFtC,SAAS,CAACuC,GAAV,CAAeC,QAAD,IACVC,yBAAK,CACAC,QADL,CACcF,QADd,EACwB;AAAEG,IAAAA,SAAS,EAAE;AAAb,GADxB,EAEKC,IAFL,CAEWC,IAAD,IAAU,CAACL,QAAD,EAAWK,IAAX,CAFpB,CADJ,CADE,CADH,CAAP;AASH;;SCVeC,aAAaC;AACzB,QAAMrE,GAAG,GAAGD,OAAO,CAACC,GAAR,EAAZ;AAEA,SAAOqE,iBAAiB,CAACR,GAAlB,CAAuBS,IAAD,IAAUzE,wBAAI,CAACC,OAAL,CAAaE,GAAb,EAAkBsE,IAAlB,CAAhC,EAAyDC,IAAzD,EAAP;AACH;;ACaM,eAAeC,UAAf,CAA0B;AAC7B5D,EAAAA,sBAD6B;AAE7BW,EAAAA,OAF6B;AAG7BkD,EAAAA,WAAW,EAAEA,WAHgB;AAI7BC,EAAAA,YAAY,EAAEA,YAJe;AAK7BC,EAAAA;AAL6B,CAA1B;AAOH,MAAI,CAACF,WAAD,IAAgBC,YAAY,CAAC3D,MAAb,KAAwB,CAA5C,EAA+C;AAC3C,UAAM6D,0BAAM,CAACC,OAAP,CAAetD,OAAf,CAAN;AACA;AACH;;AAED,QAAMuD,KAAK,GAAGC,6BAAS,CAACC,IAAV,CAAe,qBAAf,EAAsC3E,WAAW,CAACO,sBAAD,CAAjD,CAAd;AACA,QAAMU,SAAS,GAAG8C,YAAY,CAACM,YAAD,CAA9B;AACA,QAAMrD,QAAQ,GAAGoD,WAAW,GAAG7C,WAAW,CAAC6C,WAAD,CAAd,GAA8BzC,SAA1D;AAEA,QAAMiD,QAAQ,GAAG7D,WAAW,CAAC;AAAEC,IAAAA,QAAF;AAAYC,IAAAA,SAAZ;AAAuBC,IAAAA;AAAvB,GAAD,CAA5B;AAEA,QAAM2D,SAAS,GAAYJ,KAAK,CAACK,MAAN,CAAaF,QAAb,CAA3B;AAEA,QAAMG,UAAU,GAAG9D,SAAS,CAACP,MAAV,KAAqB,CAArB,GAAyBiB,SAAzB,GAAqC,MAAMwB,aAAa,CAAClC,SAAD,CAA3E;AACA,QAAM+D,WAAW,GAAG,IAAIC,IAAJ,EAApB;AAEA,QAAMC,kBAAkB,GAAGC,cAAO,CAAEN,SAAF,oBAAEA,SAAiB,CAAEE,UAArB,EAAiCA,UAAjC,CAAlC;;AACA,QAAMK,iBAAiB,GAAG,CAAC;AACvB,QAAI,CAACpE,QAAL,EAAe;AACX,aAAO,IAAP;AACH;;AAED,UAAMqE,OAAO,GAAIR,SAAJ,oBAAIA,SAAiB,CAAEQ,OAApC;;AAEA,QAAI,CAACA,OAAL,EAAc;AACV,aAAO,KAAP;AACH;;AAED,WAAOC,eAAO,CAACC,WAAG,CAAC,IAAIN,IAAJ,CAASI,OAAT,CAAD,EAAoBrE,QAApB,CAAJ,EAAmCgE,WAAnC,CAAd;AACH,GAZyB,GAA1B;;AAcA,MAAIE,kBAAkB,IAAIE,iBAA1B,EAA6C;AACzC;AACH;;AAED,MAAII,WAAW,GAAGjB,0BAAM,CAACC,OAAP,CAAetD,OAAf,CAAlB;;AAEA,MAAIoD,kBAAJ,EAAwB;AACpBkB,IAAAA,WAAW,GAAGA,WAAW,CAACC,KAAZ,CAAmBC,KAAD;AAC5BjB,MAAAA,KAAK,CAACkB,MAAN,CAAaf,QAAb,EAAuB;AACnBS,QAAAA,OAAO,EAAEL,WADU;AAEnBD,QAAAA;AAFmB,OAAvB;AAIAN,MAAAA,KAAK,CAACmB,IAAN,CAAW,IAAX;AAEA,YAAMF,KAAN;AACH,KARa,CAAd;AASH;;AAED,QAAMF,WAAN;AAEAf,EAAAA,KAAK,CAACkB,MAAN,CAAaf,QAAb,EAAuB;AACnBS,IAAAA,OAAO,EAAEL,WADU;AAEnBD,IAAAA;AAFmB,GAAvB;AAIAN,EAAAA,KAAK,CAACmB,IAAN,CAAW,IAAX;AACH;;ACvEDC,iCAAa;AAEb,MAAMC,OAAO,GAAGC,wBAAI,CAAC,WAAD,CAApB;AAEAD,OAAO,CACFE,OADL,CACaA,OADb,EAEKC,QAFL,CAEc,kDAFd,EAGKC,MAHL,CAIQ,iBAJR,EAKQ,4EALR;AAQAJ,OAAO,CACF5E,OADL,CAEQ,eAFR,EAGQ,oEAHR,EAIQ;AAAEiF,EAAAA,OAAO,EAAE;AAAX,CAJR,EAMKD,MANL,CAMY,YANZ,EAM0B,4CAN1B,EAOKA,MAPL,CAOY,YAPZ,EAO0B,kEAP1B,EAQKA,MARL,CAQY,kBARZ,EAQgC,mEARhC,EASKE,OATL,CASa,wCATb,EAUKA,OAVL,CAUa,8CAVb,EAWKA,OAXL,CAWa,qCAXb,EAYKA,OAZL,CAYa,+DAZb,EAaKA,OAbL,CAaa,oEAbb,EAcKC,MAdL,CAcY,CAACnF,OAAD,EAAmBoF,OAAnB;AACJ,QAAMC,cAAc,GAAGD,OAAO,CAAC,WAAD,CAA9B;AACA,QAAME,IAAI,GAAGF,OAAO,CAACE,IAArB;AACA,QAAMvC,IAAI,GAAGqC,OAAO,CAACrC,IAArB;AACA,QAAMK,kBAAkB,GAAGgC,OAAO,CAAC,gBAAD,CAAlC;AACA,QAAMG,KAAK,GAAcxC,IAAI,KAAKtC,SAAT,GAAqB,EAArB,GAA0B+E,KAAK,CAACC,OAAN,CAAc1C,IAAd,IAAsBA,IAAtB,GAA6B,CAACA,IAAD,CAAhF;;AAEA,MAAI,OAAO/C,OAAP,KAAmB,QAAvB,EAAiC;AAC7B,UAAMnB,KAAK,CAAC,4BAAD,CAAX;AACH;;AAED,MAAIwG,cAAc,KAAK5E,SAAnB,IAAgC,OAAO4E,cAAP,KAA0B,QAA9D,EAAwE;AACpE,UAAMxG,KAAK,CAAC,8BAAD,CAAX;AACH;;AAED,MAAIyG,IAAI,KAAK7E,SAAT,IAAsB,OAAO6E,IAAP,KAAgB,QAA1C,EAAoD;AAChD,UAAMzG,KAAK,CAAC,yBAAD,CAAX;AACH;;AAED,MAAI0G,KAAK,CAACG,IAAN,CAAY3C,IAAD,IAAU,OAAOA,IAAP,KAAgB,QAArC,CAAJ,EAAoD;AAChD,UAAMlE,KAAK,CAAC,yBAAD,CAAX;AACH;;AAED,MAAIuE,kBAAkB,KAAK3C,SAAvB,IAAoC,OAAO2C,kBAAP,KAA8B,SAAtE,EAAiF;AAC7E,UAAMvE,KAAK,CAAC,mCAAD,CAAX;AACH;;AAEDoE,EAAAA,UAAU,CAAC;AACP5D,IAAAA,sBAAsB,EAAEgG,cADjB;AAEPrF,IAAAA,OAFO;AAGPkD,IAAAA,WAAW,EAAEoC,IAHN;AAIPnC,IAAAA,YAAY,EAAEoC,KAJP;AAKPnC,IAAAA;AALO,GAAD,CAAV;AAOH,CAhDL;AAkDAwB,OAAO,CACF5E,OADL,CACa,WADb,EAC0B,6CAD1B,EAEKmF,MAFL,CAEaC,OAAD;AACJ,QAAMC,cAAc,GAAGD,OAAO,CAAC,WAAD,CAA9B;;AAEA,MAAIC,cAAc,KAAK5E,SAAnB,IAAgC,OAAO4E,cAAP,KAA0B,QAA9D,EAAwE;AACpE,UAAMxG,KAAK,CAAC,8BAAD,CAAX;AACH;;AAEDe,EAAAA,kBAAkB,CAACyF,cAAD,CAAlB;AACH,CAVL;AAYAT,OAAO,CACF5E,OADL,CACa,aADb,EAC4B,+BAD5B,EAEKmF,MAFL,CAEaC,OAAD;AACJ,QAAMC,cAAc,GAAGD,OAAO,CAAC,WAAD,CAA9B;;AAEA,MAAIC,cAAc,KAAK5E,SAAnB,IAAgC,OAAO4E,cAAP,KAA0B,QAA9D,EAAwE;AACpE,UAAMxG,KAAK,CAAC,8BAAD,CAAX;AACH;;AAEDO,EAAAA,mBAAmB,CAACiG,cAAD,CAAnB;AACH,CAVL;AAYAT,OAAO,CAACe,KAAR,CAAcnH,OAAO,CAACoH,IAAtB;;"}

package/package.json

@@ -0,0 +1,61 @@
+{
+    "name": "cache-cmd",
+    "version": "0.2.0-dev.4a662091d40f9510cff02e70023e5919708daa8f",
+    "description": "Cache a command based on various factors",
+    "keywords": [
+        "cache",
+        "debounce",
+        "cli",
+        "conditional",
+        "run",
+        "cmd",
+        "command",
+        "time",
+        "hash"
+    ],
+    "homepage": "https://github.com/dcastil/cache-cmd",
+    "bugs": {
+        "url": "https://github.com/dcastil/cache-cmd/issues"
+    },
+    "license": "MIT",
+    "author": "Dany Castillo",
+    "files": [
+        "dist",
+        "src"
+    ],
+    "bin": "dist/cli.cjs",
+    "type": "module",
+    "source": "src/cli.ts",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/dcastil/cache-cmd.git"
+    },
+    "scripts": {
+        "cache-cmd": "node ./dist/cli.cjs",
+        "build": "rm -rf dist/* && microbundle --strict --target node --output dist/cli.ts --format cjs --generateTypes false",
+        "type-check": "tsc --build",
+        "preversion": "if [ -n \"$DANYS_MACHINE\" ]; then git checkout main && git pull; fi",
+        "postversion": "if [ -n \"$DANYS_MACHINE\" ]; then git push --follow-tags && open https://github.com/dcastil/cache-cmd/releases; fi"
+    },
+    "dependencies": {
+        "date-fns": "^2.25.0",
+        "del": "^6.0.0",
+        "exec-sh": "^0.4.0",
+        "find-cache-dir": "^3.3.2",
+        "flat-cache": "^3.0.4",
+        "hard-rejection": "^2.1.0",
+        "hasha": "^5.2.2",
+        "lodash": "^4.17.21",
+        "make-dir": "^3.1.0",
+        "sade": "^1.7.4"
+    },
+    "devDependencies": {
+        "@types/find-cache-dir": "^3.2.1",
+        "@types/flat-cache": "^2.0.0",
+        "@types/lodash": "^4.14.175",
+        "@types/sade": "^1.7.3",
+        "microbundle": "^0.14.1",
+        "prettier": "^2.4.1",
+        "typescript": "^4.4.4"
+    }
+}

package/src/cache-clear.ts

@@ -0,0 +1,15 @@
+import del from 'del'
+
+import { getCacheDirectoryPath } from './utils/get-cache-dir'
+
+export function clearCacheDirectory(relativeCacheDirectory: string | undefined) {
+    const deletedPaths = del.sync(getCacheDirectoryPath(relativeCacheDirectory))
+
+    if (deletedPaths.length === 0) {
+        console.log('No cache to clear')
+    } else if (deletedPaths.length === 1) {
+        console.log(`Deleted: ${deletedPaths[0]}`)
+    } else {
+        console.log('Deleted:\n', deletedPaths.join('\n'))
+    }
+}

package/src/cache-dir.ts

@@ -0,0 +1,5 @@
+import { getCacheDirectoryPath } from './utils/get-cache-dir'
+
+export function showCacheDirectory(relativeCacheDirectory: string | undefined) {
+    console.log(getCacheDirectoryPath(relativeCacheDirectory))
+}

package/src/cli.ts

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+
+import hardRejection from 'hard-rejection'
+import sade from 'sade'
+
+import { version } from '../package.json'
+
+import { clearCacheDirectory } from './cache-clear'
+import { showCacheDirectory } from './cache-dir'
+import { runCommand } from './run'
+
+hardRejection()
+
+const program = sade('cache-cmd')
+
+program
+    .version(version)
+    .describe('Run and cache a command based on various factors')
+    .option(
+        '-c, --cache-dir',
+        'Cache directory to use (default: .cache/cache-cmd in nearest node_modules)'
+    )
+
+program
+    .command(
+        'run <command>',
+        'Run cached command (if no <command> provided, this is the default)',
+        { default: true }
+    )
+    .option('-f, --file', 'Run command only when file content changes')
+    .option('-t, --time', 'Run command only after specified time (unit with s,m,h,d,w,mo,y)')
+    .option('--cache-on-error', 'Cache command run even when command exits with non-zero exit code')
+    .example('run "echo ran this command" --time 20s')
+    .example('run "./may-fail" --time 20s --cache-on-error')
+    .example('run "yarn install" --file yarn.lock')
+    .example('run "yarn install" --file yarn.lock --cache-dir .config/cache')
+    .example('run "yarn install" --time 1mo --file yarn.lock --file package.json')
+    .action((command: unknown, options: Record<string, unknown>) => {
+        const cacheDirectory = options['cache-dir']
+        const time = options.time
+        const file = options.file
+        const shouldCacheOnError = options['cache-on-error']
+        const files: unknown[] = file === undefined ? [] : Array.isArray(file) ? file : [file]
+
+        if (typeof command !== 'string') {
+            throw Error('Invalid <command> supplied')
+        }
+
+        if (cacheDirectory !== undefined && typeof cacheDirectory !== 'string') {
+            throw Error('Invalid --cache-dir supplied')
+        }
+
+        if (time !== undefined && typeof time !== 'string') {
+            throw Error('Invalid --time supplied')
+        }
+
+        if (files.some((file) => typeof file !== 'string')) {
+            throw Error('Invalid --file supplied')
+        }
+
+        if (shouldCacheOnError !== undefined && typeof shouldCacheOnError !== 'boolean') {
+            throw Error('Invalid --cache-on-error supplied')
+        }
+
+        runCommand({
+            relativeCacheDirectory: cacheDirectory,
+            command,
+            cacheByTime: time,
+            cacheByFiles: files as string[],
+            shouldCacheOnError,
+        })
+    })
+
+program
+    .command('cache dir', 'Show cache directory path used by cache-cmd')
+    .action((options: Record<string, unknown>) => {
+        const cacheDirectory = options['cache-dir']
+
+        if (cacheDirectory !== undefined && typeof cacheDirectory !== 'string') {
+            throw Error('Invalid --cache-dir supplied')
+        }
+
+        showCacheDirectory(cacheDirectory)
+    })
+
+program
+    .command('cache clear', 'Clear cache used by cache-cmd')
+    .action((options: Record<string, unknown>) => {
+        const cacheDirectory = options['cache-dir']
+
+        if (cacheDirectory !== undefined && typeof cacheDirectory !== 'string') {
+            throw Error('Invalid --cache-dir supplied')
+        }
+
+        clearCacheDirectory(cacheDirectory)
+    })
+
+program.parse(process.argv)

package/src/run.ts

@@ -0,0 +1,83 @@
+import { add, isAfter } from 'date-fns'
+import execSh from 'exec-sh'
+import flatCache from 'flat-cache'
+import { isEqual } from 'lodash'
+
+import { createCache } from './utils/get-cache-dir'
+import { getCacheKey } from './utils/get-cache-key'
+import { getDuration } from './utils/get-duration'
+import { getFileHashes } from './utils/get-file-hashes'
+import { getFilePaths } from './utils/get-file-paths'
+
+interface RunCommandProps {
+    relativeCacheDirectory: string | undefined
+    command: string
+    cacheByTime: string | undefined
+    cacheByFiles: string[]
+    shouldCacheOnError: boolean | undefined
+}
+
+export async function runCommand({
+    relativeCacheDirectory,
+    command,
+    cacheByTime: cacheByTime,
+    cacheByFiles: cacheByFiles,
+    shouldCacheOnError,
+}: RunCommandProps) {
+    if (!cacheByTime && cacheByFiles.length === 0) {
+        await execSh.promise(command)
+        return
+    }
+
+    const cache = flatCache.load('commands-cache.json', createCache(relativeCacheDirectory))
+    const filePaths = getFilePaths(cacheByFiles)
+    const duration = cacheByTime ? getDuration(cacheByTime) : undefined
+
+    const cacheKey = getCacheKey({ duration, filePaths, command })
+
+    const cacheData: unknown = cache.getKey(cacheKey)
+
+    const fileHashes = filePaths.length === 0 ? undefined : await getFileHashes(filePaths)
+    const currentDate = new Date()
+
+    const areFileHashesEqual = isEqual((cacheData as any)?.fileHashes, fileHashes)
+    const isWithinCacheTime = (() => {
+        if (!duration) {
+            return true
+        }
+
+        const lastRun = (cacheData as any)?.lastRun
+
+        if (!lastRun) {
+            return false
+        }
+
+        return isAfter(add(new Date(lastRun), duration), currentDate)
+    })()
+
+    if (areFileHashesEqual && isWithinCacheTime) {
+        return
+    }
+
+    let execPromise = execSh.promise(command)
+
+    if (shouldCacheOnError) {
+        execPromise = execPromise.catch((error: unknown) => {
+            cache.setKey(cacheKey, {
+                lastRun: currentDate,
+                fileHashes,
+            })
+            cache.save(true)
+
+            throw error
+        })
+    }
+
+    await execPromise
+
+    cache.setKey(cacheKey, {
+        lastRun: currentDate,
+        fileHashes,
+    })
+    cache.save(true)
+}

package/src/utils/get-cache-dir.ts

@@ -0,0 +1,36 @@
+import path from 'path'
+
+import findCacheDir from 'find-cache-dir'
+import makeDir from 'make-dir'
+
+import { name } from '../../package.json'
+
+export function getCacheDirectoryPath(relativeCacheDirectoryPath: string | undefined) {
+    if (relativeCacheDirectoryPath) {
+        return path.resolve(process.cwd(), relativeCacheDirectoryPath)
+    }
+
+    const resolvedCacheDirectory = findCacheDir({ name })
+
+    if (!resolvedCacheDirectory) {
+        throw Error('Could not find cache directory. Please provide a cache directory manually.')
+    }
+
+    return resolvedCacheDirectory
+}
+
+export function createCache(relativeCacheDirectoryPath: string | undefined) {
+    if (relativeCacheDirectoryPath) {
+        const absoluteCacheDirectoryPath = makeDir.sync(relativeCacheDirectoryPath)
+
+        return absoluteCacheDirectoryPath
+    }
+
+    const resolvedCachePath = findCacheDir({ name, create: true })
+
+    if (!resolvedCachePath) {
+        throw Error('Could not find cache directory. Please provide a cache directory manually.')
+    }
+
+    return resolvedCachePath
+}

package/src/utils/get-cache-key.ts

@@ -0,0 +1,26 @@
+interface GetCacheKeyProps {
+    duration: Duration | undefined
+    filePaths: string[]
+    command: string
+}
+
+interface Duration {
+    years: number | undefined
+    months: number | undefined
+    weeks: number | undefined
+    days: number | undefined
+    hours: number | undefined
+    minutes: number | undefined
+    seconds: number | undefined
+}
+
+export function getCacheKey({ duration, filePaths, command }: GetCacheKeyProps) {
+    return [
+        'cwd:' + process.cwd(),
+        'cmd:' + command,
+        duration && 'time:' + JSON.stringify(duration),
+        filePaths.length !== 0 && 'files:' + filePaths.join(','),
+    ]
+        .filter(Boolean)
+        .join(' ---')
+}

package/src/utils/get-duration.ts

@@ -0,0 +1,44 @@
+export function getDuration(durationString: string) {
+    if (!/^(\d+[a-z]+)+$/gi.test(durationString)) {
+        throw Error(`Invalid duration: ${durationString}`)
+    }
+
+    const duration = {
+        years: undefined as undefined | number,
+        months: undefined as undefined | number,
+        weeks: undefined as undefined | number,
+        days: undefined as undefined | number,
+        hours: undefined as undefined | number,
+        minutes: undefined as undefined | number,
+        seconds: undefined as undefined | number,
+    }
+
+    durationString.match(/\d+[a-z]+/gi)!.forEach((durationPart) => {
+        const [, stringQuantity, unitShort] = /(\d+)([a-z]+)/gi.exec(durationPart)!
+        const quantity = Number(stringQuantity)
+
+        const unitLong = (
+            {
+                y: 'years',
+                mo: 'months',
+                w: 'weeks',
+                d: 'days',
+                h: 'hours',
+                m: 'minutes',
+                s: 'seconds',
+            } as const
+        )[unitShort!]
+
+        if (Number.isNaN(quantity) || !unitLong) {
+            throw Error(`Invalid duration part: ${durationPart}`)
+        }
+
+        if (duration[unitLong] !== undefined) {
+            throw Error(`Duration with unit ${unitLong} was supplied multiple times`)
+        }
+
+        duration[unitLong] = quantity
+    })
+
+    return duration
+}

package/src/utils/get-file-hashes.ts

@@ -0,0 +1,13 @@
+import hasha from 'hasha'
+
+export async function getFileHashes(filePaths: string[]) {
+    return Object.fromEntries(
+        await Promise.all(
+            filePaths.map((filePath) =>
+                hasha
+                    .fromFile(filePath, { algorithm: 'md5' })
+                    .then((hash) => [filePath, hash] as const)
+            )
+        )
+    )
+}

package/src/utils/get-file-paths.ts

@@ -0,0 +1,7 @@
+import path from 'path'
+
+export function getFilePaths(relativeFilePaths: string[]) {
+    const cwd = process.cwd()
+
+    return relativeFilePaths.map((file) => path.resolve(cwd, file)).sort()
+}