feat: support specifying files to use for the cache key (#45)

Author: bradzacher

.github/workflows/ci.generate.ts

@@ -1,10 +1,10 @@
 import * as yaml from "https://deno.land/std@0.170.0/encoding/yaml.ts";
 
 enum OperatingSystem {
-  Macx86 = "macos-12",
+  Macx86 = "macos-13",
   MacArm = "macos-latest",
   Windows = "windows-latest",
-  Linux = "ubuntu-20.04",
+  Linux = "ubuntu-22.04",
 }
 
 interface ProfileData {
@@ -91,6 +91,13 @@ const ci = {
         RUST_BACKTRACE: "full",
       },
       steps: [
+        {
+          name: "Prepare git",
+          run: [
+            "git config --global core.autocrlf false",
+            "git config --global core.eol lf",
+          ].join("\n"),
+        },
         { uses: "actions/checkout@v4" },
         { uses: "dsherret/rust-toolchain-file@v1" },
         {

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       matrix:
         config:
-          - os: macos-12
+          - os: macos-13
             run_tests: 'true'
             target: x86_64-apple-darwin
             cross: 'false'
@@ -32,23 +32,23 @@ jobs:
             run_tests: 'true'
             target: x86_64-pc-windows-msvc
             cross: 'false'
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04
             run_tests: 'true'
             target: x86_64-unknown-linux-gnu
             cross: 'false'
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04
             run_tests: 'false'
             target: x86_64-unknown-linux-musl
             cross: 'false'
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04
             run_tests: 'false'
             target: aarch64-unknown-linux-gnu
             cross: 'false'
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04
             run_tests: 'false'
             target: aarch64-unknown-linux-musl
             cross: 'false'
-          - os: ubuntu-20.04
+          - os: ubuntu-22.04
             run_tests: 'false'
             target: riscv64gc-unknown-linux-gnu
             cross: 'true'
@@ -65,6 +65,10 @@ jobs:
       CARGO_INCREMENTAL: 0
       RUST_BACKTRACE: full
     steps:
+      - name: Prepare git
+        run: |-
+          git config --global core.autocrlf false
+          git config --global core.eol lf
       - uses: actions/checkout@v4
       - uses: dsherret/rust-toolchain-file@v1
       - name: Cache cargo

Cargo.lock

@@ -23,6 +23,7 @@ dprint-core = { version = "0.67.0", features = ["process"] }
 globset = "0.4.14"
 handlebars = "5.1.2"
 serde = { version = "1.0.204", features = ["derive"] }
+sha2 = "0.10.9"
 splitty = "1.0.1"
 tokio = { version = "1.38.0", features = ["time"] }
 

Cargo.toml

@@ -49,6 +49,7 @@ This plugin executes CLI commands to format code via stdin (recommended) or via
 General config:
 
 - `cacheKey` - Optional value used to bust dprint's incremental cache (ex. provide `"1"`). This is useful if you want to force formatting to occur because the underlying command's code has changed.
+  - If you want to automatically calculate the cache key, consider using `command.cacheKeyFiles`.
 - `timeout` - Number of seconds to allow an executable format to occur before a timeout error occurs (default: `30`).
 - `cwd` - Recommend setting this to `${configDir}` to force it to use the cwd of the current config file.
 
@@ -61,6 +62,7 @@ Command config:
   - You may have associations match multiple binaries in order to format a file with multiple binaries instead of just one. The order in the config file will dictate the order the formatting occurs in.
 - `stdin` - If the text should be provided via stdin (default: `true`)
 - `cwd` - Current working directory to use when launching this command (default: dprint's cwd or the root `cwd` setting if set)
+- `cacheKeyFiles` - A list of paths (relative to `cwd`) to files used to automatically compute a `cacheKey`. This allows automatic invalidation of dprint's incremental cache when any of these files are changed.
 
 Command templates (ex. see the prettier example above):
 
@@ -118,7 +120,12 @@ Use the `rustfmt` binary so you can format stdin.
     "cwd": "${configDir}",
     "commands": [{
       "command": "rustfmt --edition 2021",
-      "exts": ["rs"]
+      "exts": ["rs"],
+      // add the config files for automatic cache invalidation when the rust version or rustfmt config changes
+      "cacheKeyFiles": [
+        "rustfmt.toml",
+        "rust-toolchain.toml"
+      ]
     }]
   },
   "plugins": [
@@ -139,7 +146,11 @@ Consider using [dprint-plugin-prettier](https://dprint.dev/plugins/prettier/) in
     "commands": [{
       "command": "prettier --stdin-filepath {{file_path}} --tab-width {{indent_width}} --print-width {{line_width}}",
       // add more extensions that prettier should format
-      "exts": ["js", "ts", "html"]
+      "exts": ["js", "ts", "html"],
+      // add the config files for automatic cache invalidation when the prettier config config changes
+      "cacheKeyFiles": [
+        ".prettierrc.json"
+      ]
     }]
   },
   "plugins": [

README.md

@@ -1,3 +1,3 @@
 [toolchain]
-channel = "1.79.0"
+channel = "1.82.0"
 components = ["clippy", "rustfmt"]