feat: Add "pdm-sync" pre-commit hook (#2475)

pdm-project · Dec 8, 2023 · b05d1cb · b05d1cb
1 parent 47e8c69
commit b05d1cb
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/.pre-commit-hooks.yaml b/.pre-commit-hooks.yaml
@@ -13,4 +13,15 @@
   language: python
   language_version: python3
   pass_filenames: false
-  files: ^pdm.lock$  
+  files: ^pdm.lock$
+- id: pdm-sync
+  name: pdm-sync
+  description: sync current working set with pdm.lock
+  entry: pdm sync
+  language: python
+  language_version: python3
+  pass_filenames: false
+  stages:
+    - post-checkout
+    - post-merge
+  always_run: true
diff --git a/docs/docs/usage/advanced.md b/docs/docs/usage/advanced.md
@@ -244,3 +244,14 @@ This hook wraps the command `pdm lock --check` along with any valid argument. It
   hooks:
     - id: pdm-lock-check
 ```
+
+### Sync current working set with `pdm.lock`
+
+This hook wraps the command `pdm sync` along with any valid argument. It can be used as a hook to ensure that your current working set is synced with `pdm.lock` whenever you checkout or merge a branch.
+
+```yaml
+- repo: https://github.com/pdm-project/pdm
+  rev: 2.x.y # a PDM release exposing the hook
+  hooks:
+    - id: pdm-sync
+```
diff --git a/news/2474.feature.md b/news/2474.feature.md
@@ -0,0 +1 @@
+Add "pdm sync" pre-commit hook