Skip to content

Commit dc8c14b

Browse files
authored
Update style for rule fail/pass examples (4/5) (#2756)
1 parent 3740084 commit dc8c14b

24 files changed

+543
-463
lines changed

docs/rules/prefer-dom-node-dataset.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -9,54 +9,56 @@
99

1010
Use [`.dataset`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset) on DOM elements over `getAttribute(…)`, `.setAttribute(…)`, `.removeAttribute(…)` and `.hasAttribute(…)`.
1111

12-
## Fail
12+
## Examples
1313

1414
```js
15+
//
1516
const unicorn = element.getAttribute('data-unicorn');
16-
```
17-
18-
```js
19-
element.setAttribute('data-unicorn', '🦄');
20-
```
2117

22-
```js
23-
element.removeAttribute('data-unicorn');
24-
```
25-
26-
```js
27-
const hasUnicorn = element.hasAttribute('data-unicorn');
28-
```
29-
30-
## Pass
31-
32-
```js
18+
//
3319
const {unicorn} = element.dataset;
3420
```
3521

3622
```js
23+
//
24+
element.setAttribute('data-unicorn', '🦄');
25+
26+
//
3727
element.dataset.unicorn = '🦄';
3828
```
3929

4030
```js
31+
//
32+
element.removeAttribute('data-unicorn');
33+
34+
//
4135
delete element.dataset.unicorn;
4236
```
4337

4438
```js
39+
//
40+
const hasUnicorn = element.hasAttribute('data-unicorn');
41+
42+
//
4543
const hasUnicorn = Object.hasOwn(element.dataset, 'unicorn');
4644
```
4745

4846
```js
47+
//
4948
const foo = element.getAttribute('foo');
5049
```
5150

5251
```js
52+
//
5353
element.setAttribute('not-dataset', '🦄');
5454
```
5555

5656
```js
57+
//
5758
element.removeAttribute('not-dataset');
5859
```
5960

6061
```js
62+
//
6163
const hasFoo = element.hasAttribute('foo');
6264
```

docs/rules/prefer-dom-node-remove.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,20 @@
99

1010
Enforces the use of, for example, `child.remove();` over `child.parentNode.removeChild(child);`. The DOM function [`Node#remove()`](https://developer.mozilla.org/en-US/docs/Web/API/ChildNode/remove) is preferred over the indirect removal of an object with [`Node#removeChild()`](https://developer.mozilla.org/en-US/docs/Web/API/Node/removeChild).
1111

12-
## Fail
12+
## Examples
1313

1414
```js
15+
//
1516
parentNode.removeChild(foo);
16-
parentNode.removeChild(this);
17-
```
1817

19-
## Pass
18+
//
19+
foo.remove();
20+
```
2021

2122
```js
22-
foo.remove();
23+
//
24+
parentNode.removeChild(this);
25+
26+
//
2327
this.remove();
2428
```

docs/rules/prefer-dom-node-text-content.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,28 @@ There are [some advantages of using `.textContent`](https://developer.mozilla.or
1313

1414
Note that there are [differences](https://developer.mozilla.org/en-US/docs/Web/API/Node/textContent#differences_from_innertext) between them.
1515

16-
## Fail
16+
## Examples
1717

1818
```js
19+
//
1920
const text = foo.innerText;
20-
```
21-
22-
```js
23-
const {innerText} = foo;
24-
```
2521

26-
```js
27-
foo.innerText = '🦄';
28-
```
29-
30-
## Pass
31-
32-
```js
22+
//
3323
const text = foo.textContent;
3424
```
3525

3626
```js
27+
//
28+
const {innerText} = foo;
29+
30+
//
3731
const {textContent} = foo;
3832
```
3933

4034
```js
35+
//
36+
foo.innerText = '🦄';
37+
38+
//
4139
foo.textContent = '🦄';
4240
```

docs/rules/prefer-event-target.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,24 @@ This rule reduces the bundle size and makes your code more cross-platform friend
1111

1212
See the [differences](https://nodejs.org/api/events.html#eventtarget-and-event-api) between `EventEmitter` and `EventTarget`.
1313

14-
## Fail
14+
## Examples
1515

1616
```js
17+
//
1718
import {EventEmitter} from 'node:event';
1819

1920
class Foo extends EventEmitter {}
20-
```
21-
22-
```js
23-
const emitter = new EventEmitter();
24-
```
25-
26-
## Pass
2721

28-
```js
22+
//
2923
class Foo extends EventTarget {}
3024
```
3125

3226
```js
27+
//
28+
import {EventEmitter} from 'node:event';
29+
30+
const emitter = new EventEmitter();
31+
32+
//
3333
const target = new EventTarget();
3434
```

docs/rules/prefer-export-from.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,48 +9,46 @@
99

1010
When re-exporting from a module, it's unnecessary to import and then export. It can be done in a single `export…from` declaration.
1111

12-
## Fail
12+
## Examples
1313

1414
```js
15+
//
1516
import defaultExport from './foo.js';
1617
export default defaultExport;
18+
19+
//
20+
export {default} from './foo.js';
1721
```
1822

1923
```js
24+
//
2025
import {named} from './foo.js';
2126
export {named};
27+
28+
//
29+
export {named} from './foo.js';
2230
```
2331

2432
```js
33+
//
2534
import * as namespace from './foo.js';
2635
export {namespace};
36+
37+
//
38+
export * as namespace from './foo.js';
2739
```
2840

2941
```js
42+
//
3043
import defaultExport, {named} from './foo.js';
3144
export default defaultExport;
3245
export {
3346
defaultExport as renamedDefault,
3447
named,
3548
named as renamedNamed,
3649
};
37-
```
38-
39-
## Pass
40-
41-
```js
42-
export {default} from './foo.js';
43-
```
4450

45-
```js
46-
export {named} from './foo.js';
47-
```
48-
49-
```js
50-
export * as namespace from './foo.js';
51-
```
52-
53-
```js
51+
//
5452
export {
5553
default,
5654
default as renamedDefault,
@@ -60,6 +58,7 @@ export {
6058
```
6159

6260
```js
61+
//
6362
// There is no substitution
6463
import * as namespace from './foo.js';
6564
export default namespace;
@@ -74,21 +73,19 @@ Default: `false`
7473

7574
When `true`, if an import is used in other places than just a re-export, all variables in the import declaration will be ignored.
7675

77-
#### Fail
78-
7976
```js
8077
// eslint unicorn/prefer-export-from: ["error", {"ignoreUsedVariables": false}]
78+
//
8179
import {named1, named2} from './foo.js';
8280

8381
use(named1);
8482

8583
export {named1, named2};
8684
```
8785

88-
#### Pass
89-
9086
```js
9187
// eslint unicorn/prefer-export-from: ["error", {"ignoreUsedVariables": true}]
88+
//
9289
import {named1, named2} from './foo.js';
9390

9491
use(named1);

docs/rules/prefer-global-this.md

Lines changed: 65 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -19,58 +19,98 @@ The complete list of permitted APIs can be found in the rule's [source code](../
1919
## Examples
2020

2121
```js
22-
window; //
23-
globalThis; //
22+
//
23+
window;
24+
25+
//
26+
globalThis;
2427
```
2528

2629
```js
27-
window.foo; //
28-
globalThis.foo; //
30+
//
31+
window.foo;
32+
33+
//
34+
globalThis.foo;
2935
```
3036

3137
```js
32-
window[foo]; //
33-
globalThis[foo]; //
38+
//
39+
window[foo];
40+
41+
//
42+
globalThis[foo];
3443
```
3544

3645
```js
37-
global; //
38-
globalThis; //
46+
//
47+
global;
48+
49+
//
50+
globalThis;
3951
```
4052

4153
```js
42-
global.foo; //
43-
globalThis.foo; //
54+
//
55+
global.foo;
56+
57+
//
58+
globalThis.foo;
4459
```
4560

4661
```js
47-
const {foo} = window; //
48-
const {foo} = globalThis; //
62+
//
63+
const {foo} = window;
64+
65+
//
66+
const {foo} = globalThis;
4967
```
5068

5169
```js
52-
window.location; //
53-
globalThis.location; //
70+
//
71+
window.navigator;
5472

55-
window.innerWidth; // (Window specific API)
56-
window.innerHeight; // ✅ (Window specific API)
73+
//
74+
globalThis.navigator;
5775
```
5876

5977
```js
60-
window.navigator; //
61-
globalThis.navigator; //
78+
//
79+
window.location;
80+
81+
//
82+
globalThis.location;
6283
```
6384

6485
```js
65-
self.postMessage('Hello'); // ✅ (Web Worker specific API)
66-
self.onmessage = () => {}; // ✅ (Web Worker specific API)
86+
//
87+
window.innerWidth;
88+
89+
//
90+
window.innerHeight;
6791
```
6892

6993
```js
70-
window.addEventListener('click', () => {}); //
71-
globalThis.addEventListener('click', () => {}); //
94+
//
95+
self.postMessage('Hello');
96+
97+
//
98+
self.onmessage = () => {};
99+
```
100+
101+
```js
102+
//
103+
window.addEventListener('click', () => {});
104+
105+
//
106+
globalThis.addEventListener('click', () => {});
107+
108+
//
109+
window.addEventListener('resize', () => {});
110+
111+
//
112+
window.addEventListener('load', () => {});
72113

73-
window.addEventListener('resize', () => {}); // ✅ (Window specific event)
74-
window.addEventListener('load', () => {}); // ✅ (Window specific event)
75-
window.addEventListener('unload', () => {}); // ✅ (Window specific event)
114+
//
115+
window.addEventListener('unload', () => {});
76116
```

0 commit comments

Comments
 (0)