lefthook
+Default: null
Provide a full path to lefthook executable or a command to run lefthook. Bourne shell (sh
) syntax is supported.
++Important: This option does not merge from
+remotes
orextends
for security reasons. But it gets merged from lefthook local config if specified.
There are three reasons you may want to specify lefthook
:
-
+
- You want to force using specific lefthook version from your dependencies (e.g. npm package) +
- You use OnP loader for your JS/TS project, and your
package.json
with lefthook dependency locates in a subfolder
+ - You want to make sure you use concrete lefthook executable path and want to defined it in
lefthook-local.yml
+
Examples
+Specify lefthook executable
+# lefthook.yml
+
+lefthook: /usr/bin/lefthook
+
+pre-commit:
+ jobs:
+ - run: yarn lint
+
+Specify a command to run lefthook
+# lefthook.yml
+
+lefthook: |
+ cd project-with-lefthook
+ pnpm lefthook
+
+pre-commit:
+ jobs:
+ - run: yarn lint
+ root: project-with-lefthook
+
+Force using a version from Rubygems
+# lefthook.yml
+
+lefthook: bundle exec lefthook
+
+pre-commit:
+ jobs:
+ - run: bundle exec rubocop {staged_files}
+
+Enable debug logs
+# lefthook-local.yml
+
+lefthook: lefthook --verbose
+
+
+