-
Notifications
You must be signed in to change notification settings - Fork 220
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
32 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,44 @@ | ||
# Introduction | ||
|
||
<img align="right" width="147" height="125" title="Lefthook logo" | ||
src="./favicon.svg"> | ||
|
||
**Lefthook** is a Git hooks manager. This documentation provides the reference for installing, configuring and using the lefthook. | ||
|
||
Maybe you are looking for | ||
|
||
- **[Installation instructions](./installation)** to install lefthook to your system or just project. | ||
- **[Installation instructions](./installation)** to install lefthook to your OS or project. | ||
|
||
- **[Examples](./examples)** of lefthook common usage. | ||
|
||
- **[Configuration](./configuration)** with details explanation of lefthook options. | ||
- **[Configuration](./configuration)** with detailed explanation of lefthook options. | ||
|
||
|
||
**Example:** Run your linters on `pre-commit` hook and forget about the routine. | ||
|
||
```yml | ||
# lefthook.yml | ||
|
||
pre-commit: | ||
parallel: true | ||
jobs: | ||
- run: yarn run stylelint --fix {staged_files} | ||
glob: "*.css" | ||
stage_fixed: true | ||
|
||
- run: yarn run eslint --fix "{staged_files}" | ||
glob: | ||
- "*.ts" | ||
- "*.js" | ||
- "*.tsx" | ||
- "*.jsx" | ||
stage_fixed: true | ||
``` | ||
--- | ||
<a href="https://evilmartians.com/?utm_source=lefthook"> | ||
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a> | ||
|
||
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="100%" height="54"></a> | ||
❓If you have a question or found a mistake in the documentation, please create a new [discussion](https://github.com/evilmartians/lefthook/discussions/new/choose). Small contributions help maintaining the quality of the project. | ||
❓_If you have a question or found a mistake in the documentation, please create a new [discussion](https://github.com/evilmartians/lefthook/discussions/new/choose). Small contributions help maintaining the quality of the project._ | ||