Skip to content
This repository was archived by the owner on Mar 23, 2024. It is now read-only.

Commit 91cc6d6

Browse files
ficristomarkelog
authored andcommitted
Docs: improve a bit the docs for "requireObjectKeysOnNewLine" rule
Closes gh-1976
1 parent 102399b commit 91cc6d6

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

lib/rules/require-object-keys-on-new-line.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
*
44
* Types: `Boolean` or `Object`
55
*
6-
* Values: `true` or Object with `allExcept` Array of quoted identifiers which are exempted
6+
* Values:
7+
* - `true`
8+
* - `Object`:
9+
* - `'allExcept'` array of exceptions:
10+
* - `'sameLine'` ignores the rule if all the keys and values are on the same line
711
*
812
* #### Example
913
*
@@ -31,15 +35,15 @@
3135
* };
3236
* ```
3337
*
34-
* ##### Valid
38+
* ##### Valid for `{ "allExcept": ["sameLine"] }`
3539
*
3640
* ```js
3741
* var a = {
3842
* b: 'b', c: 'c'
3943
* };
4044
* ```
4145
*
42-
* ##### Invalid
46+
* ##### Invalid for `{ "allExcept": ["sameLine"] }`
4347
*
4448
* ```js
4549
* var a = {

0 commit comments

Comments
 (0)