[webkit-dev] Proposal: Adopt Web Inspector coding style for all WebKit JS/CSS source code

[Brady Eidson]

> On Jul 10, 2016, at 3:04 PM, Anthony Ricaud <rik at webkit.org> wrote:
> 
> It would be nice for contributors if those rules were enforced by a linter, like ESLint.

Individual contributors are, of course, welcome to have their own linters/style plugins for their preferred editor(s), but it greatly reduces the burden on the project as a whole to rely on a single, universal script like check-webkit-style.

This has the huge benefit of being a script anybody can run no matter what their preferred IDE/text editor is, as well as being something that the EWS and CommitQueue bots can run.

Thanks,
~Brady

> 
>> On 10 Jul 2016, at 00:22, Sam Weinig <weinig at apple.com> wrote:
>> 
>> 👍👍
>> 
>> It should probably get a parallel page to https://webkit.org/code-style-guidelines/ and be updated with the same type of right / wrong examples.  
>> 
>> Our of curiosity, other than for features that simply aren’t available in C++ / Objective-C (or vice-versa), are there places where the inspector JS guideline deviates from what we do in the rest of WebKit?  
>> 
>> - Sam
>> 
>>> On Jul 7, 2016, at 11:29 AM, Geoffrey Garen <ggaren at apple.com> wrote:
>>> 
>>> 👍
>>> 
>>> To make this policy easy for new folks, I agree with Ryosuke that we should extract a JS and CSS style guide that is separate from Inspector-specific concerns.
>>> 
>>> Geoff
>>> 
>>>> On Jul 6, 2016, at 10:17 PM, Filip Pizlo <fpizlo at apple.com> wrote:
>>>> 
>>>> I like the idea of adopting inspector style for JS builtins!
>>>> 
>>>> It might also be good to adopt it for JS tests that we write ourselves, with an escape hatch if you need to violate style to test some feature. For example, it should be a goal to follow inspector style for the JetStream harness code, and probably for all of ES6SampleBench. New JS tests in JavaScriptCore/tests/stress that we write ourselves probably should follow inspector style, because it's code that we have to read and understand and I can't think of a reason not to be consistent. Thoughts?
>>>> 
>>>> -Filip
>>>> 
>>>>> On Jul 6, 2016, at 7:53 PM, Ryosuke Niwa <rniwa at webkit.org> wrote:
>>>>> 
>>>>>> On Wed, Jul 6, 2016 at 7:34 PM, Dean Jackson <dino at apple.com> wrote:
>>>>>> I propose we make it official that the Web Inspector Coding Style is what must be used for all JavaScript and CSS that count as source code in the project.
>>>>>> https://trac.webkit.org/wiki/WebInspectorCodingStyleGuide
>>>>>> 
>>>>>> Now that JavaScript is used in more places (JS builtins, some parts of the DOM, media controls) it would be nice to make it all consistent. Note that the page above can't decide if it is just JS or both JS and CSS, but I think it should be both.
>>>>> 
>>>>> It's hard to tell which parts of the above guide would apply to
>>>>> non-Inspector JS code because it has a bunch of Inspector specific
>>>>> guidelines such as layering guides and references to
>>>>> https://trac.webkit.org/browser/trunk/Source/WebInspectorUI/UserInterface/Views/Variables.css
>>>>> 
>>>>> We should probably extract the parts that matter into a separate MD
>>>>> file or a section in the wiki page before we proceed with this
>>>>> discussion.
>>>>> 
>>>>> - R. Niwa
>>>>> _______________________________________________
>>>>> webkit-dev mailing list
>>>>> webkit-dev at lists.webkit.org
>>>>> https://lists.webkit.org/mailman/listinfo/webkit-dev
>>>> _______________________________________________
>>>> webkit-dev mailing list
>>>> webkit-dev at lists.webkit.org
>>>> https://lists.webkit.org/mailman/listinfo/webkit-dev
>>> 
>>> _______________________________________________
>>> webkit-dev mailing list
>>> webkit-dev at lists.webkit.org
>>> https://lists.webkit.org/mailman/listinfo/webkit-dev
>> 
>> _______________________________________________
>> webkit-dev mailing list
>> webkit-dev at lists.webkit.org
>> https://lists.webkit.org/mailman/listinfo/webkit-dev
> 
> _______________________________________________
> webkit-dev mailing list
> webkit-dev at lists.webkit.org
> https://lists.webkit.org/mailman/listinfo/webkit-dev