dejarun/README.md

A file system operation cache for Node.js, using a hash of the file or folder contents as the cache key.

# Déjà-run

Skip running expensive commands or functions when input or output files or directories, or other dependencies haven’t changed.

## CLI

```sh
npx dejarun \
  --input src \
  --output lang.json \
  -- 'formatjs extract "src/**/*.{ts,tsx,vue}" --out-file lang.json'
```

## API

```ts
import dejarun from "dejarun";

await dejarun(
  "extract-messages", // Unique name for this operation
  async () => {
    // Your expensive operation
    await extractAndWrite(["src"], {
      outFile: "lang.json",
    });
  },
  // Options
  {
    inputs: ["src"], // Files or directories
    outputs: ["lang.json"], // Files or directories
    // dependencies: [], // Other dependencies
  },
);
```

## Example output

```sh
[déjàrun] Cache hit, skip: extract-messages
```

## Options

| CLI flag                    | API Option     | Type              | Description                                                                                                                                  |
| --------------------------- | -------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `--input` _(multiple)_      | `inputs`       | `string[]`        | Input files or directories to hash                                                                                                           |
| `--output` _(multiple)_     | `outputs`      | `string[]`        | Output files or directories to hash                                                                                                          |
| `--dependency` _(multiple)_ | `dependencies` | `any[]`           | Extra data to hash (e.g. CLI args, config values)                                                                                            |
| `--clean`                   | `clean`        | `boolean`         | Force rerun even if nothing changed                                                                                                          |
| `--debug`                   | `debug`        | `boolean`         | Print internal debug info                                                                                                                    |
| `--logo`, `--no-logo`       | `logo`         | `string \| false` | Customize the logo in the logs. You may use [chalk](https://www.npmjs.com/package/chalk), e.g. `'${chalk.green("→")}'`. Set `false` to hide. |

All options are optional.