Manual:Coding conventions/JavaScript

This page describes coding conventions for JavaScript files in the MediaWiki codebase. See also the general conventions.

Linting
We use [https://eslint.org/ ESLint] as our code quality tool, with a [https://github.com/wikimedia/eslint-config-wikimedia custom config for Wikimedia] (eslint-config-wikimedia). The settings for MediaWiki core can be found in  . Many text editors or IDEs have plugins to provide live linting while you type (see [https://eslint.org/docs/user-guide/integrations "Integrations" on ESLint.org]).

The following shows an example ESLint config file using the wikimedia config: See [https://github.com/wikimedia/mediawiki-core/blob/master/.eslintrc.json .eslintrc.json in MediaWiki core] and [https://github.com/wikimedia/mediawiki-extensions-VisualEditor/blob/master/.eslintrc.json VisualEditor] for examples. MediaWiki extensions must always have their own   file. There are several different profiles that projects with uncommon needs can set, such as different language flavours, or expected globals. For example,   requires code is ES5-compatible, whereas other profiles have different requirements. tells ESlint that your code will run on a node server in ES6. <tvar|qunit> </> tells it that your code will run on a node server in ES6). You should expect to use multiple <tvar|eslintrc2> </> files in a repo to set different environmental expectations for different scopes. This makes sure that you don't accidentally use <tvar|window> </> methods in code you expect to run on the server, or reference QUnit in production code. <tvar|eslintrc3> </> files can inherit their rules from each other using relative file paths – <tvar|extends> </> will use the parent directory's configuration and let you over-ride.

You can install a CLI version of ESlint on your machine with: This will install ESLint globally, which is generally a bad idea. Then in any directory belonging to a project with an <tvar|eslintrc> </> file, and local npm dependencies installed, run it like this:

Whitespace
We use white space conventions:
 * Indentation with tabs.
 * No trailing whitespace.
 * Use blank lines to separate one block of logically related code from another.
 * One space on both sides of binary operators and assignment operators.
 * Keywords followed by a "<tvar|leftparenthesis> </>" (left parenthesis) must be separated by one space. This gives visual distinction between keywords and function invocations.
 * There should be no space between the function name and left parenthesis of an argument list.
 * There should be one space on the insides of parentheses (such as in if statements, function calls, and arguments lists).
 * Don't use operators as if they are functions (such as <tvar|delete> </>, <tva|void> </>, <tvar|typeof> </>, <tvar|new> </>, <tvar|return> </>, ..).

These and other aspects of our style guide are enforced with ESLint.

Closure
Avoid leakage of variables from or to other modules by wrapping files in a closure. This gives the contained code its own scope.

This pattern is known as an immediately-invoked function expression (or "iffy"<tvar|ref> </>).

Declarations
Variables must be declared before use, and should be the first statement of the function body. Each assignment must be on its own line. Declarations that don't assign a value should be listed before assignments, on the first line (or longer if there are many). When you have multiple lines for value assignments and non-assigned variables, the extra lines should be indented another level. Functions should be declared before use. In the function body, function declarations should go after the  statement.

Line length
Lines should wrap at no more than 80–100 characters. If a statement does not fit on a single line, split the statement over multiple lines. The continuation of a statement should be indented one extra level.

Function calls and objects should either be on a single line or split over multiple lines with one line for each segment. Avoid closing a function call or object at a different indentation than its opening.

Comments
Comments should be on their own line and go over the code they describe.

Within a comment, the opening syntax (e.g. slash-slash, or slash-star) should be separated from the text by a single space, and the text should start with a capital letter. If the comment is a valid sentence, then a full stop should be placed at the end of it.

Use line comments (<tvar|comment></>) within functions and other code blocks (including for multi-line comments).

Use block comments (<tvar|comment></>) only for documentation>#Documentation</>|documentation blocks. This helps maintain consistent formatting for inline comments (e.g. not some as blocks and some as multi-line comments, or having to convert from one to the other). It also avoids confusing documentation engines. It also makes it easy to disable parts of the code during development by simply moving the end-comment notation a few lines down, without being short-circuited by an inline block comment.

Be liberal with comments and don't fear file size because of it. All code is automatically minified by <tvar|RessourceLoader>ResourceLoader</> before being shipped.

Equality

 * Use strict equality operators (<tvar|3equals> </> and <tvar|exclamationmark2equal> </>) instead of (loose) equality (<tvar|2equal> </> and <tvar|exclamationmark1equal> </>). The latter does type coercion.
 * No Yoda conditionals. ([<tvar|exampleYoda>http://www.globalnerdy.com/wordpress/wp-content/uploads/2010/05/yodaconditional.jpg</> yodaconditional.jpg])

Type checks

 * string:
 * number:
 * boolean:
 * Function:
 * null:
 * object:
 * Plain Object:
 * Array:
 * HTMLElement:
 * undefined:
 * Local variables:
 * Properties:
 * Global variables:

Quotes
Use single quotes instead of double quotes for string literals. Remember there are no "magic quotes" in JavaScript i.e. <tvar|n> </> and <tvar|t> </> work everywhere.

Globals
In addition to the browser's native APIs, the only interfaces safe to use as global variables are <tvar|mw> </>, <tvar|dollar> </> and <tvar|OOUI> </>.

Avoid creating additional global variables. Code functionality exposed via a public identifier, should be added as functions and properties of an object within <tvar|mw> </>, e.g. <tvar|Echo> </>.

Configuration variables exposed by MediaWiki must be accessed via <tvar|mwconfig> </>. For backward compatibility with legacy user scripts and gadgets, many <tvar|wg> </>-prefixed configuration keys are also exposed in the global scope. RLVariables>ResourceLoader/Migration guide (users)#wg* Variables</>|These are deprecated. (See <tvar|T72470></>).

Naming
All variables and functions must use lowerCamelCase for their naming. For functions, verb phrases are preferred (so <tvar|getFoo></> instead of <tvar|Foo></>).

The only exception are constructors used with the <tvar|new1> </> operator. Those names must start with an uppercase letter (<tvar|UpperCaseCamel> </>). JavaScript has no dedicated syntax for classes or constructors, they are declared as any other function. As such there is no compile-time or run-time warning for instantiating a regular function or omitting the <tvar|new2> </> operator on a constructor. This naming convention is our only defence.

Names with acronyms in them should treat the acronym as a normal word and only uppercase the first letter. For example <tvar|getHtmlApiSource> </> as opposed to <tvar|getHTMLAPISource> </>.

jQuery

 *  See also <tvar|jQuery>jQuery</> 

To avoid confusion with raw elements and other variables, prefix variables storing an instance of jQuery with a dollar sign (e.g. <tvar|dollar> </>). This matters because the DOM (e.g. <tvar|getElementById> </>) returns null if no elements were found, therefore (since null casts to boolean false) one would test the plain variable like <tvar|ifFoo> </>. jQuery objects on the other hand (like any array or object in JavaScript) cast to boolean true. If you confuse a jQuery object with the return value of a DOM method, a condition could fail badly. In such case one would use <tvar|length> </> instead.

Creating elements
To create a plain element, use the simple <tvar|tag> </> syntax in the jQuery constructor: When creating elements based on the tag name from a variable (which may contain arbitrary html): Only use <tvar|html></> when you need to parse HTML (as opposed to creating a plain element).

Collections
Different types of collections sometimes look similar but have different behaviour and should be treated as such. This confusion is mostly caused by the fact that arrays in JavaScript look a lot like arrays in other languages, but are in fact just an extension of Object. We use the following conventions: Avoid using a <tvar|for-in1> </> loop to iterate over an array (as opposed to a plain object). A <tvar|for-in2> </> will iterate over the keys instead of over the indices:
 * keys are strings
 * order not guaranteed
 * index can have gaps
 * might include non-numerical properties

Storage
Keys in localStorage and/or sessionStorage should be accessed via <tvar|mwStorage> </> or <tvar|mwStorageSession> </>.

Keys
Keys should start with <tvar|code> </> and use camel case and/or hyphens. Do not use underscores or other separators. Examples of real keys: Beware that contrary to cookies via mw.cookie, there is no wiki prefix or cookie prefix added by default. If values must vary by wiki, you must manually include <tvar|wgCookiePrefix> </> as part of the key.

Values
Values must be strings. Beware that attempting to store other value types will silently cast to a string (e.g. <tvar|false> </> would become <tvar|falseQuoted> </>).

Space is limited. Use short and concise values over object structures where possible. A few example:
 * For boolean state (true/false, expanded/collapsed) use "1" or "0".
 * For values that are always numbers, store them as-is and cast with <tvar|Number> </> on the way out (avoid <tvar|parseInt> </>).
 * For values that are always strings, store them as-is.
 * For lists of software-defined values, consider comma-separate or pipe-separated if possible.
 * For lists of values that may be user-generated or more complex structures, use JSON.

Eviction strategy
Remember that Local storage does not have any eviction strategy by default. Therefore the following should be avoided:
 * Avoid using user-generated input as part of a key name.
 * Avoid keys containing identifiers for user-generated entities (e.g. user names, category names, page ids, or other user-provided or system-provided variables).
 * In general avoid approaches that involve creating a potentially large number of keys.

For example, if feature needs to store state about a variable entity (e.g. current page), it might make sense to use a single key for this and to limit the stored information only to the last few iterations (LRU), despite it having to parse and serialise a slightly larger amount of data on each time. It's discouraged to store these in separate keys as it would grow uncontrolled. Even with a tracking key, this would be subject to leaks because HTML5 web storage is shared between multiple open browser windows without locking mechanism (race conditions to update the tracking key).

When removing use of a local storage key, or when changing the key name that is used, be sure to provide an eviction strategy for cleaning up old values. Typically <tvar|mwRequestIdleCallback>mw.requestIdleCallback</> is used to look for the key and remove it. See <tvar|T121646>T121646</> for a more scalable system in the future.

Personal information
Avoid storing any personal information in the default storage (localStorage) as it remains when a user logs out or closes their browser. Use sessionStorage instead.

Pitfalls
Read more:
 * Be careful to preserve compatibility with left-to-right and right-to-left languages (i.e. <tvar|FloatRight> </> or <tvar|TextAlignRight> </>), especially when styling text containers. Putting those declarations in CSS file will allow them to be automatically flipped for RTL-languages by CSSJanus in ResourceLoader.
 * Use <tvar|attr> </> and <tvar|prop> </> appropriately.
 * jQuery#attr, jQuery API
 * Attributes and custom properties, <tvar|javascriptinfo>javascript.info</>
 * Consistently [<tvar|QuoteAttribute>https://api.jquery.com/category/selectors/attribute-selectors/</> quote attribute] selector values: <tvar|quotedBar> </> instead of <tvar|NotQuotedBar> </> (<tvar|bug>jqbug 8229</>).
 * As of jQuery 1.4 the jQuery constructor has a new feature that allows passing an object as second argument, like <tvar|example> </>. Don't use this. It makes code harder to follow, fails on attributes (such as 'size') that are also methods, and is unstable due to this mixing of jQuery methods with element attributes. A future jQuery method or plugin or called "title" might convert an element into a heading, which means the title attribute can also no longer be set through this method. Be explicit and call <tvar|attr> </>, <tvar|prop> </>, <tvar|on> </> etc. directly.
 * String methods <tvar|substr> </>, <tvar|substring> </>, and <tvar|slice> </> have similar signatures. Prefer <tvar|PreferSlice> </>. ([<tvar|ExampleCommit>https://gerrit.wikimedia.org/r/#/c/158108/</> Example commit].) If need to extract a string of a certain length from a positive non-zero offset, only then should you use <tvar|substr> </>.
 * <tvar|substr> </> doesn't support negative <tvar|start> </> in IE8 and below.
 * <tvar|substring> </> doesn't support negative indices. And its start/end parameters are silently swapped if start is larger than end.

Documentation

 *  Note that we are currently moving to use JSDoc instead of JSDuck as the latter is no longer maintained. The information below will be updated when we are further ahead in that work. 

Use [<tvar|JSDuck>https://github.com/senchalabs/jsduck</> JSDuck] to build documentation (see <tvar|doc>https://doc.wikimedia.org</>). The documentation comment structure is broadly similar to the doxygen format we use in PHP but details differ to accommodate for JavaScript-specific language constructs (such as object inheritance, emitting events and arbitrary augmentation of an constructor's prototype).

</>See the [<tvar|gerringin>https://github.com/senchalabs/jsduck#getting-it</> installation guide] for more information.
 * Installation
 * Standard RubyGems install: <tvar|gerInstallJsDuck>


 * Generate documentation


 * Set up configuration for new projects
 * Create a [<tvar|JSduckConfig>https://github.com/senchalabs/jsduck/wiki/Config-file</> JSDuck configuration file] (at <tvar|JSDuck> </>). See for example <tvar|example1>>/> and <tvar|example2></>.

Documentation comments

 * Text in free-form blocks (e.g. description of methods, parameters, return values etc.) should be sentence case.
 * End sentences in a full stop.
 * Continue sentences belonging to an annotation on the next line, indented with one additional space.
 * Value types should be separated by a pipe character. Use only types that are listed in the types>#Types</>|Types section or the identifier of a different class as specified in your project (e.g. <tvar|mwtitle> </>).

Tags
We use the following annotations. They should be used in the order as they are described here, for consistency. See the [<tvar|JSduckWiki>https://github.com/senchalabs/jsduck/wiki JSDuck</> documentation] for more documentation about how these work.


 * @abstract
 * @private
 * @static
 * @class Name ( name is optional, engine will guess name from context )
 * @singleton
 * @extends ClassName
 * @mixins ClassName
 * @constructor
 * @inheritable
 * @member
 * @method name ( name is optional, guessed )
 * @property name ( name is optional, guessed )
 * @inheritdoc
 * @deprecated
 * @param {Type} name Optional text.
 * @return {Type} Optional text.
 * @chainable
 * @throws {Type}
 * @cfg {Type} [name="default value"] ( used when a configuration object is passed to the class constructor, use one for each property and don't include those of parent constructors )

Types
Primitive types and special values:
 * boolean
 * number
 * string
 * undefined
 * null

Built-in classes:
 * Object
 * Array
 * Function
 * Date
 * RegExp
 * Error

Browser classes: Commonly used classes:
 * HTMLElement
 * jQuery

Reuse <tvar|ResourceLoader>ResourceLoader</> modules
Don't reinvent the wheel. <tvar|ResourceLoader>ResourceLoader</> makes a lot of useful MediaWiki functionality and jQuery plugins available as tested and documented ResourceLoader modules that your code can (literally) depend on. ResourceLoaderModules>ResourceLoader/Modules>/>|Scan the list of RL modules before rolling your own code.

Follow ResourceLoaderMigration>ResourceLoader/Migration guide (users)#Good practices</>|ResourceLoader best practices.

Use CSS for styling many elements
Don't apply styling to lots of elements at once; this has poor performance. Instead use a common parent's class (or add one) and apply CSS in a <tvar|css> </> or <tvar|less> </> file. Thanks to ResourceLoader, this will all be loaded in the same HTTP request, so there's no performance penalty for having a separate CSS file. Do not set CSS into inline "style" attributes, don't insert "style" elements from JS either.

Environment
jQuery doesn't support environments that have manipulated the <tvar|Object> </> as it's considered harmful.

Enforcing
In order to enforce the conventions and/or guidelines, you should consider ContinuousIntegration>Continuous integration/Entry points#Testing JavaScript</>|setting up Continuous integration to check many of them so reviewers don't have to.