mirror of
https://github.com/nodejs/node.git
synced 2026-11-09 15:11:11 -05:00
Rich Trott
4e6dc00401
There has been occasional nits for spacing in object literals in PRs but
the project does not lint for it and it is not always handled
consistently in the existing code, even on adjacent lines of a file.
This change enables a linting rule requiring no space between the key
and the colon, and requiring at least one space (but allowing for more
so property values can be lined up if desired) between the colon and the
value. This appears to be the most common style used in the current code
base.
Example code the complies with lint rule:
myObj = { foo: 'bar' };
Examples that do not comply with the lint rule:
myObj = { foo : 'bar' };
myObj = { foo:'bar' };
PR-URL: https://github.com/nodejs/node/pull/6592
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Here's how the node docs work.
1:1 relationship from lib/<module>.js to doc/api/<module>.md
Each type of heading has a description block.
## module
<!-- YAML
added: v0.10.0
-->
Stability: 3 - Stable
description and examples.
### module.property
<!-- YAML
added: v0.10.0
-->
* Type
description of the property.
### module.someFunction(x, y, [z=100])
<!-- YAML
added: v0.10.0
-->
* `x` {String} the description of the string
* `y` {Boolean} Should I stay or should I go?
* `z` {Number} How many zebras to bring.
A description of the function.
### Event: 'blerg'
<!-- YAML
added: v0.10.0
-->
* Argument: SomeClass object.
Modules don't usually raise events on themselves. `cluster` is the
only exception.
## Class: SomeClass
<!-- YAML
added: v0.10.0
-->
description of the class.
### Class Method: SomeClass.classMethod(anArg)
<!-- YAML
added: v0.10.0
-->
* `anArg` {Object} Just an argument
* `field` {String} anArg can have this field.
* `field2` {Boolean} Another field. Default: `false`.
* Return: {Boolean} `true` if it worked.
Description of the method for humans.
### someClass.nextSibling()
<!-- YAML
added: v0.10.0
-->
* Return: {SomeClass object | null} The next someClass in line.
### someClass.someProperty
<!-- YAML
added: v0.10.0
-->
* String
The indication of what someProperty is.
### Event: 'grelb'
<!-- YAML
added: v0.10.0
-->
* `isBlerg` {Boolean}
This event is emitted on instances of SomeClass, not on the module itself.
- Modules have (description, Properties, Functions, Classes, Examples)
- Properties have (type, description)
- Functions have (list of arguments, description)
- Classes have (description, Properties, Methods, Events)
- Events have (list of arguments, description)
- Methods have (list of arguments, description)
- Properties have (type, description)