Add note on keeping lint settings in sync

fwcd · Sep 7, 2024 · f355c62 · f355c62
1 parent 816697d
commit f355c62
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,4 +1,8 @@
 {
+  // NOTE: This should be kept in sync with scripts/lint. Unfortunately it looks
+  // like we cannot just let rust-analyzer invoke our script, so we'll have to
+  // sync this manually until we figure out how to configure clippy directly
+  // (e.g. via the Cargo.toml).
   "rust-analyzer.check.command": "clippy",
   "rust-analyzer.check.extraArgs": [
     "--",

diff --git a/scripts/lint b/scripts/lint
@@ -3,6 +3,11 @@
 set -e
 cd "$(dirname $0)/.."
 
+# NOTE: This should be kept in sync with .vscode/settings.json. Unfortunately it
+# looks like we cannot just let rust-analyzer invoke our script, so we'll have
+# to sync this manually until we figure out how to configure clippy directly
+# (e.g. via the Cargo.toml).
+
 # TODO: Figure out if we can configure this properly from Cargo.toml
 # [lints.clippy] seems to be unstable currently.