rename package to cache-cmd

Author: dcastil

README.md

@@ -1,53 +1,53 @@
-# debounce-cmd
+# cache-cmd
 
-Debounce a command based on
+Cache a command based on
 
 -   time since last run
 -   file change
 
 ## Install
 
 ```sh
-yarn add --dev debounce-cmd
+yarn add --dev cache-cmd
 ```
 
 or
 
 ```sh
-npm install --save-dev debounce-cmd
+npm install --save-dev cache-cmd
 ```
 
 ## Usage
 
 ```sh
 # Shows help
-yarn debounce-cmd --help
+yarn cache-cmd --help
 
 # Runs command if it was not run in the last 20s
-yarn debounce-cmd "echo ran this command" --time 20s
+yarn cache-cmd "echo ran this command" --time 20s
 
 # Runs comand if yarn.lock in current directory changed since last run
-yarn debounce-cmd "yarn install" --file yarn.lock
+yarn cache-cmd "yarn install" --file yarn.lock
 
 # Additionally uses custom cache directory instead of default in node_modules
-yarn debounce-cmd "yarn install" --file yarn.lock --cache-dir .config/cache
+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 debounce-cmd "yarn install" --time 1mo --file yarn.lock --file package.json
+yarn cache-cmd "yarn install" --time 1mo --file yarn.lock --file package.json
 
 # Shows path to cache directory
-yarn debounce-cmd cache dir
+yarn cache-cmd cache dir
 
 # Clear cache
-yarn debounce-cmd cache clear
+yarn cache-cmd cache clear
 ```
 
 You can use it to execute commands conditionally in `package.json` scripts.
 
 ```json
 {
     "scripts": {
-        "dev": "debounce-cmd \"yarn\" --file yarn.lock && start-dev-server"
+        "dev": "cache-cmd \"yarn\" --file yarn.lock && start-dev-server"
     }
 }
 ```

package.json

@@ -1,8 +1,9 @@
 {
-    "name": "debounce-cmd",
+    "name": "cache-cmd",
     "version": "0.2.0",
-    "description": "Debounce a command based on various factors",
+    "description": "Cache a command based on various factors",
     "keywords": [
+        "cache",
         "debounce",
         "cli",
         "conditional",
@@ -30,7 +31,7 @@
         "url": "https://github.com/dcastil/debounce-cmd.git"
     },
     "scripts": {
-        "debounce-cmd": "node ./dist/cli.cjs",
+        "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": "git checkout main && git pull",

src/cli.ts

@@ -7,24 +7,24 @@ import { version } from '../package.json'
 
 import { clearCacheDirectory } from './cache-clear'
 import { showCacheDirectory } from './cache-dir'
-import { debounceCommand } from './run'
+import { runCommand } from './run'
 
 hardRejection()
 
-const program = sade('debounce-cmd')
+const program = sade('cache-cmd')
 
 program
     .version(version)
-    .describe('Debounce a command based on various factors')
+    .describe('Run and cache a command based on various factors')
     .option(
         '-c, --cache-dir',
-        'Cache directory to use (default: .cache/debounce-cmd in nearest node_modules)'
+        'Cache directory to use (default: .cache/cache-cmd in nearest node_modules)'
     )
 
 program
     .command(
         'run <command>',
-        'Run debounced command (if no <command> provided, this is the default)',
+        'Run cached command (if no <command> provided, this is the default)',
         { default: true }
     )
     .option('-f, --file', 'Run command only when file content changes')
@@ -62,17 +62,17 @@ program
             throw Error('Invalid --cache-on-error supplied')
         }
 
-        debounceCommand({
+        runCommand({
             relativeCacheDirectory: cacheDirectory,
             command,
-            debounceByTime: time,
-            debounceByFiles: files as string[],
+            cacheByTime: time,
+            cacheByFiles: files as string[],
             shouldCacheOnError,
         })
     })
 
 program
-    .command('cache dir', 'Show cache directory path used by debounce-cmd')
+    .command('cache dir', 'Show cache directory path used by cache-cmd')
     .action((options: Record<string, unknown>) => {
         const cacheDirectory = options['cache-dir']
 
@@ -84,7 +84,7 @@ program
     })
 
 program
-    .command('cache clear', 'Clear cache used by debounce-cmd')
+    .command('cache clear', 'Clear cache used by cache-cmd')
     .action((options: Record<string, unknown>) => {
         const cacheDirectory = options['cache-dir']
 

src/run.ts

@@ -9,29 +9,29 @@ import { getDuration } from './utils/get-duration'
 import { getFileHashes } from './utils/get-file-hashes'
 import { getFilePaths } from './utils/get-file-paths'
 
-interface DebounceCommandProps {
+interface RunCommandProps {
     relativeCacheDirectory: string | undefined
     command: string
-    debounceByTime: string | undefined
-    debounceByFiles: string[]
+    cacheByTime: string | undefined
+    cacheByFiles: string[]
     shouldCacheOnError: boolean | undefined
 }
 
-export async function debounceCommand({
+export async function runCommand({
     relativeCacheDirectory,
     command,
-    debounceByTime,
-    debounceByFiles,
+    cacheByTime: cacheByTime,
+    cacheByFiles: cacheByFiles,
     shouldCacheOnError,
-}: DebounceCommandProps) {
-    if (!debounceByTime && debounceByFiles.length === 0) {
+}: RunCommandProps) {
+    if (!cacheByTime && cacheByFiles.length === 0) {
         await execSh.promise(command)
         return
     }
 
     const cache = flatCache.load('commands-cache.json', createCache(relativeCacheDirectory))
-    const filePaths = getFilePaths(debounceByFiles)
-    const duration = debounceByTime ? getDuration(debounceByTime) : undefined
+    const filePaths = getFilePaths(cacheByFiles)
+    const duration = cacheByTime ? getDuration(cacheByTime) : undefined
 
     const cacheKey = getCacheKey({ duration, filePaths, command })
 
@@ -41,7 +41,7 @@ export async function debounceCommand({
     const currentDate = new Date()
 
     const areFileHashesEqual = isEqual((cacheData as any)?.fileHashes, fileHashes)
-    const isCurrentTimeInDebounce = (() => {
+    const isWithinCacheTime = (() => {
         if (!duration) {
             return true
         }
@@ -55,7 +55,7 @@ export async function debounceCommand({
         return isAfter(add(new Date(lastRun), duration), currentDate)
     })()
 
-    if (areFileHashesEqual && isCurrentTimeInDebounce) {
+    if (areFileHashesEqual && isWithinCacheTime) {
         return
     }