You can also install the checkstyle-idea plugin, which will highlight style
errors, for local development. For an example and installation
instructions, see:

https://wiki.mozilla.org/Mobile/Fennec/Android/Static_analysis/checkstyle-idea

- Mike

On Wed, Apr 6, 2016 at 11:14 AM, Michael Comella <
michael.l.come...@gmail.com> wrote:

> Checkstyle is slightly more useful: it'll now check for trailing
> whitespace! [1] If your reviewee has an any issues with this, ask them to
> run `./mach gradle checkstyle` locally rather than writing "nit:" on every
> instance. :)
>
> Slightly less useful: whitespace checks around Java generics operators
> also landed with [1].
> - Mike
>
> [1]: https://bugzilla.mozilla.org/show_bug.cgi?id=1258794
>
> On Wed, Apr 6, 2016 at 9:49 AM, Michael Comella <
> michael.l.come...@gmail.com> wrote:
>
>> Important note regarding checkstyle in automation: to get the specific
>> checkstyle failures, you have to click the failing test, click "Job
>> Details", "Inspect task", and select the checkstyle artifact (e.g. [0]).
>> Then you need to scroll through a large xml file to find your errors.
>>
>> Instead, if you see failures on try, I think it's easier to just run it
>> locally (`./mach gradle checkstyle`) – the errors should print to stdout.
>>
>> For an example failure on treeherder, see [1].
>> - Mike (:mcomella)
>>
>> [0]:
>> https://public-artifacts.taskcluster.net/PtglwaB0SnywaZHZ-mH4aA/0/public/android/checkstyle/checkstyle.xml
>> [1]:
>> https://treeherder.mozilla.org/#/jobs?repo=try&revision=e9ca2950d7f8&selectedJob=19049224
>>
>> On Wed, Apr 6, 2016 at 9:42 AM, Michael Comella <
>> michael.l.come...@gmail.com> wrote:
>>
>>> And now checkstyle is running in automation [1] – yay!
>>>
>>> It should run automatically when you change files that checkstyle looks
>>> at (e.g. *.java).
>>> - Mike (:mcomella)
>>>
>>> [1]: https://bugzilla.mozilla.org/show_bug.cgi?id=1258787
>>>
>>> On Mon, Apr 4, 2016 at 4:23 PM, Michael Comella <
>>> michael.l.come...@gmail.com> wrote:
>>>
>>>> checkstyle appears to be sticking – happy style checking.
>>>> - Mike (:mcomella)
>>>>
>>>> On Fri, Mar 25, 2016 at 1:55 PM, Michael Comella <
>>>> michael.l.come...@gmail.com> wrote:
>>>>
>>>>> I forgot to include some dependencies so this had to be backed out.
>>>>> I'll reply once it's landed *and* merged this time. :P
>>>>> - Mike
>>>>>
>>>>> On Fri, Mar 25, 2016 at 11:56 AM, Michael Comella <
>>>>> michael.l.come...@gmail.com> wrote:
>>>>>
>>>>>> Hey all.
>>>>>>
>>>>>> As you may have previewed from my static analysis email, I landed
>>>>>> checkstyle in tree [1]. It catches various coding style issues. To run:
>>>>>>
>>>>>> ./mach gradle app:checkstyle
>>>>>>
>>>>>> My thinking here is that instead of typing `nit` for each style issue
>>>>>> in review, we can just say `checkstyle` and ignore the remaining style
>>>>>> issues. However, our current config [2] is minimal and won't help much:
>>>>>> * Don't wrap `package .*` & `import .*` lines
>>>>>> * Don't add tabs to files
>>>>>> * Filename.java must contain a class Filename
>>>>>>
>>>>>> My highest priority checks to add are:
>>>>>> * excess whitespace [3]
>>>>>> * spacing around operators [4] (e.g. `1 + 1`)
>>>>>>
>>>>>> which I often find the need to nit for.
>>>>>>
>>>>>> For open issues, see the meta bug [5].
>>>>>>
>>>>>> Note: this probably won't be really effective until we land in
>>>>>> automation [6] and prevent regressions.
>>>>>> - Mike (:mcomella)
>>>>>>
>>>>>> [1]: https://bugzilla.mozilla.org/show_bug.cgi?id=1258769
>>>>>> [2]: Once this merges to m-c:
>>>>>> http://mxr.mozilla.org/mozilla-central/source/mobile/android/app/checkstyle.xml
>>>>>> [3]: https://bugzilla.mozilla.org/show_bug.cgi?id=1258794
>>>>>> [4]: https://bugzilla.mozilla.org/show_bug.cgi?id=1258789
>>>>>> [5]: https://bugzilla.mozilla.org/show_bug.cgi?id=1258786
>>>>>> [6]: https://bugzilla.mozilla.org/show_bug.cgi?id=1258787
>>>>>>
>>>>>
>>>>>
>>>>
>>>
>>
>
_______________________________________________
mobile-firefox-dev mailing list
mobile-firefox-dev@mozilla.org
https://mail.mozilla.org/listinfo/mobile-firefox-dev

Reply via email to