Changes between Version 7 and Version 8 of WebInspectorCodingStyleGuide

Timestamp:

Feb 4, 2014 10:56:29 AM (10 years ago)

Author:

BJ Burg

Comment:

nit about model/view layering, and when to spell out identifier

WebInspectorCodingStyleGuide

@@ -19 +19 @@
 * Consider using [http://people.mozilla.org/~jorendorff/es6-draft.html#sec-keyed-collection `Map` and `Set` collections] instead of plain objects.
 * Consider using `rgb()` over hex colors in CSS
-* Firewall the protocol inside the Manager classes. JSON objects received from the protocol are called "payload" in the code. The payload is usually deconstructed at the Managers level and passes down as smart objects inheriting from `WebInspector.Object`. 
+* Firewall the protocol inside the Manager classes. JSON objects received from the protocol are called "payload" in the code. The payload is usually deconstructed at the Managers level and passes down as smart objects inheriting from `WebInspector.Object`.
+* Avoid accessing *View classes from *Manager or *Object classes. This is a layering violation that prevents writing tests for models.
+* Avoid storing DOM elements in *Manager or *Object classes. (see above.)
+* Spell out `identifier` instead of `id` if not doing so would result in a name ending with capitalized `Id`. For example, just `this.id` is fine, but `this.breakpointId` should be `this.breakpointIdentifier`.
 
 The new Inspector object classes should have the following format: