🤖 Merge PR DefinitelyTyped#68187 Set up optional pre-commit format hook with husky and lint-staged by @tpluscode

* style: optional formatting on pre-commit hook

* explicit lint-staged config (re lint-staged/lint-staged#1383)

* docs: mention checking out hooks, + tweak hook command

* chore: remove config (moved to .lintstagedrc.jsn)

* refactor: lint-staged everything

* Update README.md

Co-authored-by: Jake Bailey <[email protected]>

* docs: move git hook section

---------

Co-authored-by: Jake Bailey <[email protected]>

Author: tpluscode

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+pnpm lint-staged --config .lintstagedrc.json --allow-empty

.lintstagedrc.json

@@ -0,0 +1 @@
+{ "*": "pnpm dprint fmt --allow-no-files" }

README.md

@@ -488,6 +488,8 @@ Then they are wrong and we've not noticed yet. You can help by submitting a pull
 Yes, using [dprint](https://dprint.dev).
 We recommend using a [dprint extension for your editor](https://dprint.dev/install/#editor-extensions).
 
+Alternatively, you can enable a git hook which will format your code automatically. Run `pnpm run setup-hooks`. Then, when you commit, `dprint fmt` command will be executed on changed files.  If you take advantage of [partial clone](#partial-clone), make sure to call `git sparse-checkout add .husky` to check out the git hooks before running the `setup-hooks` script.
+
 Pull requests do not require correct formatting to be merged.
 Any unformatted code will be automatically reformatted after being merged.
 

package.json

@@ -25,7 +25,8 @@
         "clean-node-modules": "node scripts/clean-node-modules.js",
         "test": "node --enable-source-maps node_modules/@definitelytyped/dtslint/ types",
         "lint": "node --enable-source-maps node_modules/@definitelytyped/dtslint/ types",
-        "prettier": "prettier"
+        "prettier": "prettier",
+        "setup-hooks": "husky install"
     },
     "devDependencies": {
         "@definitelytyped/definitions-parser": "latest",
@@ -39,16 +40,12 @@
         "danger": "^11.2.3",
         "dprint": "^0.45.0",
         "eslint-plugin-jsdoc": "^44.2.7",
+        "husky": "^8.0.3",
+        "lint-staged": "^15.2.0",
         "remark-cli": "^11.0.0",
         "remark-gfm": "^3.0.0",
         "remark-validate-links": "^12.0.0",
         "typescript": "next"
     },
-    "type": "module",
-    "husky": {
-        "hooks": {
-            "_comment": "This will remove husky from when we started migrating to use prettier",
-            "pre-commit": "npm uninstall husky"
-        }
-    }
+    "type": "module"
 }