640055 - Move all files to the "var %modulename% = exports" method of exporting

Status: RESOLVED FIXED

(Mozilla QA Graveyard :: Mozmill Tests, defect)

Description

[Geo Mealer [:geo] -- This account is inactive after 2015-07-07]

Henrik has taken to doing something cool in his submissions. After defining the doc namespace with @name, he then creates an alias to the common.js exports object with the desired name of the namespace.

I like this method because it clearly establishes--within the file itself--how we'd like other files to import it.

Ex:

/**
 * @namespace Defines wrapper methods for back-end services
 */
var services = exports;

Note to Henrik: we don't need @name services anymore. It'll use the name of the var as it should. We only needed @name when there was no actual variable.

Comment 1

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Makes it even simpler then. :)

Comment 2

[Geo Mealer [:geo] -- This account is inactive after 2015-07-07]

Attachment: Added module namespace aliases for exports and removed unnecessary @names from namespaces

https://github.com/geoelectric/mozmill-api-refactor/tree/ms1-exports

Note that I didn't add namespace jsdocs for files that didn't have it already. We still need to figure out the best way to document the map, so I'm intentionally holding off.

Comment 3

[Henrik Skupin [:whimboo][⌚️UTC+2]]

Comment on attachment 519540 [details] [diff] [review]
Added module namespace aliases for exports and removed unnecessary @names from namespaces

>+var dom = exports;

As talked on IRC please add a jsdoc comment for the dom module.

>+var navBar = exports;

Question here is should we use camelCase or simply have an 1:1 naming schema with the file name:

session.js -> var session = exports;
navbar.js  -> var navbar = exports;

The latter option would make it more clear that we put objects onto the module scope.


Otherwise looks fine. r=me with the first part updated.

Comment 4

[Geo Mealer [:geo] -- This account is inactive after 2015-07-07]

Will do on the dom comment.

Re: camelCasing, I originally had it as "navbar" and "tabbar," but checked the current project and we'd camel-cased domUtils and similar. So I changed it.

I could go either way, though I think there are some compound words (like tabbar) where it's a bit ugly. I thought about the exact same thing re: matching filename to identifier, and agree that'd be the reason, if any.

Comment 5

[Geo Mealer [:geo] -- This account is inactive after 2015-07-07]

Landed on master: https://github.com/geoelectric/mozmill-api-refactor/commit/04cad37b20879df1a238d2de02fbafbedab47b81