Skip to content

Commit bd187b9

Browse files
committed
docs(README): update benchmark info, hide in next release
1 parent 1ef2655 commit bd187b9

3 files changed

Lines changed: 17 additions & 16 deletions

File tree

.changeset/long-dryers-wink.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@vnphanquang/githooks": patch
3+
---
4+
5+
remove benchmark info from root README, might be flawed

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ GITHOOKS=2 git commit -m "verbose run"
158158

159159
## Prior Arts & Acknowledgements
160160

161-
### Comparison and Benchmark vs [husky]
161+
### Comparison vs [husky]
162162

163163
This project is greatly inspired by [husky]; it is even fair to consider this as a direct Deno port of `huksy` . Credits should go to [@typicode](https://github.com/typicode). Please show support over there. In fact, today, you can use `husky` directly in Deno:
164164

@@ -168,27 +168,23 @@ deno run -A npm:husky
168168

169169
This project builds upon ideas from `husky` while trying to stay minimal and only extend on some functionality that satisfies my personal needs. It is also an attempt to utilize Deno for more explicit permissions and idiomatic testing (`husky` uses `bash` for tests, which is totally fine but simply not my preference).
170170

171-
Regarding performance, both init scripts of `npm:husky` and `jsr:@vnphanquang/githooks` are comparable:
172-
173-
- `npm:husky init` tends to run **~1.03x faster on linux** compared to `jsr:@vnphanquang/githooks`
174-
- `npm:husky init` tends to run **~1.10x slower on macos** compared to `jsr:@vnphanquang/githooks`
175-
- `npm:husky init` tends to run **as just fast on windows** compared to `jsr:@vnphanquang/githooks`
176-
177-
The numbers above are simplified. See [benchmark runs](https://github.com/vnphanquang/githooks/actions/workflows/benchmark.yaml) for more details. You can try the benchmark on your own machine by cloning the project and running:
178-
179-
```bash
180-
deno task bench
181-
```
182-
183-
Benchmarks live at [benchmarks/*](https://github.com/vnphanquang/githooks/tree/main/benchmarks).
171+
<!-- Regarding performance, `jsr:@vnphanquang/githooks` is relatively faster compared to `npm:husky` in the [latest benchmarks](https://github.com/vnphanquang/githooks/actions/workflows/benchmark.yaml). You can try the benchmark on your own machine by cloning the project and running: -->
172+
<!---->
173+
<!-- ```bash -->
174+
<!-- deno task bench -->
175+
<!-- ``` -->
176+
<!---->
177+
<!-- > [!IMPORTANT] -->
178+
<!-- > Benchmarks can be flawed. I encourage you to inspect them at [benchmarks/*](https://github.com/vnphanquang/githooks/tree/main/benchmarks). Feedback is welcome. -->
184179

185180
### Similar Projects
186181

187182
Other projects with similar objective exists. Please show them some love too.
188183

189184
- [Yakiyo/deno_hooks](https://github.com/Yakiyo/deno_hooks): also inspired by [husky], written in Deno 1; no tests have been implemented as of this writing.
190185
- [xCykrix/githooked](https://github.com/xCykrix/githooked): also inspired by [husky], [originally written in Deno](https://www.reddit.com/r/Deno/comments/thfub7/githooked_the_deno_githook_handler_for_your/) but has likely been migrated away from Deno towards a standalone shell script, which is probably the most lightweight & cross-platform solution.
191-
- [lefthook](https://github.com/evilmartians/lefthook): a more complex Go-based git hooks manager
186+
- [lefthook](https://github.com/evilmartians/lefthook): a more complex Go-based git hooks manager,
187+
definitely worth a look!
192188

193189
## Contributing
194190

deno.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@vnphanquang/githooks",
3-
"version": "1.0.4",
3+
"version": "1.0.5",
44
"exports": {
55
".": "./src/mod.ts",
66
"./bin": "./src/bin.ts",

0 commit comments

Comments
 (0)