feat: add pre-commit hook support #795

ccoVeille · 2024-07-17T10:00:55Z

Description

Add pre-commit.com support in mockery.

Fixes Feature request: pre-commit hooks #791

Type of change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Version of Go used when building/testing:

How Has This Been Tested?

Locally, by following the guide I provide in installation.md file

Checklist

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes

Fixes vektra#791

liveFreeOrCode · 2024-07-17T15:37:50Z

.pre-commit-hooks.yaml

+  additional_dependencies:
+    - github.com/vektra/mockery/v2@latest
+  entry: mockery


Rather than using additional_dependencies, the pre-commit-hook will already have access to the file system. We should just be able to use go run . to enact the mockery ... command I believe.

Also, we may only want this hook to run when .go files are in the commit. What do you think?

Suggested change

additional_dependencies:

- github.com/vektra/mockery/v2@latest

entry: mockery

entry: go run .

files: \.go$

I'm unsure it will launch the code you expect to run.

I will make some tests.

But, I think keeping mockery call here would be clearer.

Using additional dependencies like this won't allow people to specify version in pre commit file because no matter what version they reference, you're pulling latest

Indeed, I'm unsure if there is something that can be done here, I will have to check

For now,it seems to me, that it would imply to maintain the version in sync in this file vs the tag. Quite a pain

liveFreeOrCode · 2024-07-17T15:39:08Z

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+---
+repos:
+  - repo: https://github.com/ccoVeille/mockery


Is this just in here for testing right now? Unless mockery uses itself to generate mocks, and wants to use the pre-commit functionality, I don't think this is required to get this to work for consumers.

Yes, only for the test. I forgot to mention about it in the PR

I had to create a fake "2.43.3" tag on my repository to be able to make it work.

liveFreeOrCode · 2024-07-17T15:39:48Z

docs/installation.md

+
+```yaml
+repos:
+  - repo: https://github.com/ccoVeille/mockery


Suggested change

- repo: https://github.com/ccoVeille/mockery

- repo: https://github.com/vektra/mockery

I kept it in sync to help mockery mainteners to be able to test

But yes, I will have to change this one

liveFreeOrCode · 2024-07-17T15:40:42Z

docs/installation.md

+```yaml
+repos:
+  - repo: https://github.com/ccoVeille/mockery
+    rev: v2


nit/nb: It would be great if this could be automatically updated on new releases.

Suggested change

rev: v2

rev: v2.43.2

There is no need usually. precommit manage this well with this kind of tag

liveFreeOrCode · 2024-07-17T15:42:07Z

docs/installation.md

+Then install the hook with the following command:
+
+```shell
+pre-commit autoupdate


Ah, this is why you have it as v2 above, calling for autoupdate will which bump the version to latest. May be better to be explicit about the versioning system, and call for pre-commit install versus autoupdate.

Indeed, I'm used to use autoupdate for everything.

I think "pre-commit install" would also bump it locally. I will make some tests.

Then I will update the documentation based on my tests

ccoVeille · 2024-07-17T17:18:16Z

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+---


Note for myself

I will have to add Co-Authored-By metadata

ccoVeille · 2024-07-18T19:45:00Z

anyway @liveFreeOrCode could you confirm it "works" as this ?

ccoVeille · 2024-07-31T08:31:29Z

@liveFreeOrCode (or anyone) could you confirm ? thanks

Then I will remove the oddities present to make it works with my branch, and switch to vektra/mokery one

ccoVeille · 2024-07-31T20:59:55Z

Hi @liveFreeOrCode

You commented the PR, thanks.

But you didn't reply my question. Does it work on your computer now with current code I provided.

I understand you might dislike the current implementation. I agree it could be improved. But right now,I would like to get a simple reply to the following question.

Does it work?

liveFreeOrCode · 2024-07-31T21:01:20Z

Hi @liveFreeOrCode

You commented the PR, thanks.

But you didn't reply my question. Does it work on your computer now with current code I provided.

I understand you might dislike the current implementation. I agree it could be improved. But right now,I would like to get a simple reply to the following question.

Does it work?

Yeah sorry I'm traveling without my PC. I can't test until next week

ccoVeille · 2024-07-31T21:58:12Z

OK thanks for replying, we can also wait

LandonTClipp · 2024-11-13T19:45:10Z

Closing due to inactivity, feel free to resurrect it if you find the time to finish it.

ccoVeille · 2024-11-13T19:47:20Z

Hi @LandonTClipp

Please reopen.

I was waiting for someone feedbacks.

The code is ready.

feat: add pre-commit hook support

df6b998

Fixes vektra#791

liveFreeOrCode reviewed Jul 17, 2024

View reviewed changes

ccoVeille commented Jul 17, 2024

View reviewed changes

.pre-commit-config.yaml

@@ -0,0 +1,6 @@

---

Copy link

Contributor Author

ccoVeille Jul 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note for myself

I will have to add Co-Authored-By metadata

ccoVeille marked this pull request as draft July 18, 2024 20:21

LandonTClipp closed this Nov 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add pre-commit hook support #795

feat: add pre-commit hook support #795

ccoVeille commented Jul 17, 2024

liveFreeOrCode Jul 17, 2024

ccoVeille Jul 17, 2024

liveFreeOrCode Jul 31, 2024

ccoVeille Jul 31, 2024

ccoVeille Jul 31, 2024

liveFreeOrCode Jul 17, 2024

ccoVeille Jul 17, 2024 •

edited

Loading

liveFreeOrCode Jul 17, 2024

ccoVeille Jul 17, 2024

liveFreeOrCode Jul 17, 2024

ccoVeille Jul 17, 2024

liveFreeOrCode Jul 17, 2024

ccoVeille Jul 17, 2024

ccoVeille Jul 17, 2024

ccoVeille commented Jul 18, 2024

ccoVeille commented Jul 31, 2024

ccoVeille commented Jul 31, 2024 •

edited

Loading

liveFreeOrCode commented Jul 31, 2024

ccoVeille commented Jul 31, 2024

LandonTClipp commented Nov 13, 2024

ccoVeille commented Nov 13, 2024

	- repo: https://github.com/ccoVeille/mockery
	- repo: https://github.com/vektra/mockery

feat: add pre-commit hook support #795

feat: add pre-commit hook support #795

Conversation

ccoVeille commented Jul 17, 2024

Description

Type of change

Version of Go used when building/testing:

How Has This Been Tested?

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccoVeille Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ccoVeille commented Jul 18, 2024

ccoVeille commented Jul 31, 2024

ccoVeille commented Jul 31, 2024 • edited Loading

liveFreeOrCode commented Jul 31, 2024

ccoVeille commented Jul 31, 2024

LandonTClipp commented Nov 13, 2024

ccoVeille commented Nov 13, 2024

ccoVeille Jul 17, 2024 •

edited

Loading

ccoVeille commented Jul 31, 2024 •

edited

Loading