rush-audit-cache-plugin is a diagnostic utility designed to provide deep insights into the behavior of the Rush.js build cache. It helps monorepo maintainers understand why cache hits or misses occur, identifying potential misconfigurations or inefficiencies. As of its current stable version, 0.3.2, it is a pre-1.0 release, indicating ongoing development, though it's actively maintained within the TikTok rush-plugins monorepo. The plugin differentiates itself by leveraging low-level system calls (via `strace` on Linux) to precisely track file system interactions during builds, offering a granular view beyond what typical cache logs provide. Its release cadence is not public, likely tied to its maintainers' internal development needs.
npm install rush-audit-cache-pluginVerified import paths — ran on the pinned version, not inferred.
Shows how to enable the plugin in Rush configuration and run the audit-cache command for a specific project.
Ensure you are running the `rush audit-cache` command on a Linux operating system with `strace` installed and accessible in the system PATH. Windows and macOS are not supported.
Upgrade your Rush.js installation to version 5.57.0 or newer by updating the `rushVersion` in your `rush.json` file and running `rush update`.
Refer to the Rush.js official documentation on 'Using Rush plugins' and ensure the plugin is correctly listed in `rush-plugins.json`.
Verify that `rush-audit-cache-plugin` is listed in your `common/config/rush/rush-plugins.json` file and that `rushVersion` in `rush.json` meets the minimum requirement (>= 5.57.0). Run `rush update` to ensure plugin installation.
Install `strace` on your Linux system. For Debian/Ubuntu-based systems, use `sudo apt-get install strace`. For other distributions, consult their package manager documentation. Ensure it's in your system's PATH.
Double-check the spelling of the project name. Use `rush projects` to list all available projects in your monorepo and ensure you are providing a valid project `--project <project-folder-name>`.