The Tool Cache Manifesto

The Tool Cache Manifesto outlines essential principles for creating effective tool caches based on the author's extensive experience with various caching systems. The primary focus is on correctness, emphasizing that a tool cache should operate seamlessly, making the tool faster without the user noticing its presence. Key characteristics of a good cache include the ability to recover from interruptions, handle cache deletions, and function correctly with updates and concurrent executions. The manifesto warns against poor cache practices, such as requiring users to delete cache files for troubleshooting. It advocates for disabling caches when they are not functioning correctly, prioritizing reliability over speed. Additionally, it stresses the importance of proper cache location, adhering to system conventions, and allowing user overrides. The manifesto also highlights the responsibility of tool developers to manage dependencies that may introduce caching issues. Ultimately, it suggests that the best cache may be no cache at all, as modern hardware can often process data quickly enough that caching may not be necessary. The author calls for better resources on implementing file caches, recommending the Go tool's cache as a model and referencing relevant literature for further insights.

- Tool caches should prioritize correctness and seamless operation.

- Poor cache practices can lead to unnecessary complexity and errors.

- Developers should manage dependencies that affect caching behavior.

- Proper cache location and user override options are essential.

- Modern tools may not need caching due to sufficient processing speeds.