1507007 - Provide a script for local precommit hg/git hooks that run ./mach clang-format

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, enhancement)

Description

[(no longer active)]

We can use https://searchfox.org/mozilla-central/source/tools/lint/hooks.py as a guide.

Comment 1

[Sylvestre Ledru [:Sylvestre]]

I think I have something for that.

With my patch, I am producing the following output:

% hg commit --amend dom/ tools/
Running command: ['/usr/bin/python2.7', '/home/sylvestre/dev/mozilla/mozilla-central.hg/tools/lint/../../mach', 'clang-format', '-s']
--- dom/presentation/PresentationReceiver.cpp	(before formatting)
+++ dom/presentation/PresentationReceiver.cpp	(after formatting)
@@ -67,8 +67,7 @@
   return !mUrl.IsEmpty();
 }
 
-void PresentationReceiver::Shutdown(        )
-{
+void PresentationReceiver::Shutdown() {
   PRES_DEBUG("receiver shutdown:windowId[%" PRId64 "]\n", mWindowId);
 
   // Unregister listener for incoming sessions.

Running command: ['/usr/bin/python2.7', '/home/sylvestre/dev/mozilla/mozilla-central.hg/tools/lint/../../mach', 'lint', '--quiet', '--workdir=staged']
✖ 0 problems (0 errors, 0 warnings)

Comment 2

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1507007 - Update our hook to run clang-format too r?ahal,ehsan

As ride along, other changes:
1) Renamed run_mozlint =>run_linters
2) Show the command being executed (we have the mozlint output anyway)
3) Add a link to the doc on how to use it

Comment 3

[(no longer active)]

Do the hg hooks work for mq patches?

Comment 4

[Sylvestre Ledru [:Sylvestre]]

Andrew is the real expert here :)

Comment 5

[Andrew Halberstadt [:ahal]]

I had to Google it, but looks like you can do stuff like:

[hooks]
pre-qrefresh.lint = hook.py

So I guess yes :). Though I'm also not sure how mq interacts with |mach lint|'s --workdir and --outgoing flags respectively (which is what the hooks call into). So further testing is needed to properly answer that.

Comment 6

[Andrew Halberstadt [:ahal]]

Also the hooks.py file looks for either "commit" or "push" in the hook name. So we'd have to teach it about 'qrefresh' (or whatever other mq commands we need).

Comment 7

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1507007 - Add a clang-format hook r?ahal,ehsan

Comment 8

[Masatoshi Kimura [:emk]]

Please make sure that this hook will not prevent win32 native python from landing commits. (See bug 1511594 for context.)

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/e2b466629175
Add a clang-format hook r=ahal,Ehsan

Comment 10

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/e2b466629175

Comment 11

[Sylvestre Ledru [:Sylvestre]]

Here is how this can be configured:
----
[hooks]
pretxncommit.clang-format = python:./tools/lint/hooks_clang_format.py:hg
----
in .hg/hgrc

Comment 12

[Kartikaya Gupta (email:[e-mail])]

This doesn't work in git:

Traceback (most recent call last):
  File ".git/hooks/pre-commit", line 48, in <module>
    sys.exit(git())
  File ".git/hooks/pre-commit", line 44, in git
    return run_clang_format(hooktype, [])
TypeError: run_clang_format() takes exactly 3 arguments (2 given)


Also hooks_clang_format.py should be marked executable for best results.

Comment 13

[Sylvestre Ledru [:Sylvestre]]

I didn't test this on git, let me fix that.