Skip to content

Commit 312bb4d

Browse files
LiviaMedeirosruyadorno
LiviaMedeiros
authored and
ruyadorno
committed
tools: lint js in doc/**/*.md
PR-URL: #55904 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Chemi Atlow <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>
1 parent 352daac commit 312bb4d

17 files changed

+27
-30
lines changed

‎doc/api/errors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Errors that occur within _Asynchronous APIs_ may be reported in multiple ways:
6161
<!-- eslint-disable no-useless-return -->
6262

6363
```js
64-
const fs = require('fs/promises');
64+
const fs = require('node:fs/promises');
6565

6666
(async () => {
6767
let data;

‎doc/api/inspector.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ inspector.Network.requestWillBeSent({
505505
request: {
506506
url: 'https://nodejs.org/en',
507507
method: 'GET',
508-
}
508+
},
509509
});
510510
```
511511

‎doc/api/modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -889,7 +889,7 @@ built-in modules and if a name matching a built-in module is added to the cache,
889889
only `node:`-prefixed require calls are going to receive the built-in module.
890890
Use with care!
891891

892-
<!-- eslint-disable node-core/no-duplicate-requires -->
892+
<!-- eslint-disable node-core/no-duplicate-requires, no-restricted-syntax -->
893893

894894
```js
895895
const assert = require('node:assert');

‎doc/api/perf_hooks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ performance.measure('Start to Now');
2828

2929
performance.mark('A');
3030
(async function doSomeLongRunningProcess() {
31-
await new Promise(r => setTimeout(r, 5000));
31+
await new Promise((r) => setTimeout(r, 5000));
3232
performance.measure('A to Now', 'A');
3333

3434
performance.mark('B');

‎doc/api/process.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2099,10 +2099,10 @@ class Test {
20992099
constructor() {
21002100
finalization.register(this, (ref) => ref.dispose());
21012101

2102-
// even something like this is highly discouraged
2102+
// Even something like this is highly discouraged
21032103
// finalization.register(this, () => this.dispose());
2104-
}
2105-
dispose() {}
2104+
}
2105+
dispose() {}
21062106
}
21072107
```
21082108

‎doc/api/punycode.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The `punycode` module is a bundled version of the [Punycode.js][] module. It
2121
can be accessed using:
2222

2323
```js
24-
const punycode = require('punycode');
24+
const punycode = require('node:punycode');
2525
```
2626

2727
[Punycode][] is a character encoding scheme defined by RFC 3492 that is

‎doc/api/stream.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ events (due to incorrect stream implementations) do not cause unexpected
315315
crashes. If this is unwanted behavior then `options.cleanup` should be set to
316316
`true`:
317317

318-
```js
318+
```mjs
319319
await finished(rs, { cleanup: true });
320320
```
321321

@@ -3916,7 +3916,7 @@ const { StringDecoder } = require('node:string_decoder');
39163916
class StringWritable extends Writable {
39173917
constructor(options) {
39183918
super(options);
3919-
this._decoder = new StringDecoder(options && options.defaultEncoding);
3919+
this._decoder = new StringDecoder(options?.defaultEncoding);
39203920
this.data = '';
39213921
}
39223922
_write(chunk, encoding, callback) {

‎doc/api/test.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3256,7 +3256,7 @@ test('snapshot test with default serialization', (t) => {
32563256

32573257
test('snapshot test with custom serialization', (t) => {
32583258
t.assert.snapshot({ value3: 3, value4: 4 }, {
3259-
serializers: [(value) => JSON.stringify(value)]
3259+
serializers: [(value) => JSON.stringify(value)],
32603260
});
32613261
});
32623262
```

‎doc/api/tls.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -465,13 +465,13 @@ to set the security level to 0 while using the default OpenSSL cipher list, you
465465
const tls = require('node:tls');
466466
const port = 443;
467467

468-
tls.createServer({ciphers: 'DEFAULT@SECLEVEL=0', minVersion: 'TLSv1'}, function (socket) {
468+
tls.createServer({ ciphers: 'DEFAULT@SECLEVEL=0', minVersion: 'TLSv1' }, function(socket) {
469469
console.log('Client connected with protocol:', socket.getProtocol());
470470
socket.end();
471471
this.close();
472-
}).
473-
listen(port, () => {
474-
tls.connect(port, {ciphers: 'DEFAULT@SECLEVEL=0', maxVersion: 'TLSv1'});
472+
})
473+
.listen(port, () => {
474+
tls.connect(port, { ciphers: 'DEFAULT@SECLEVEL=0', maxVersion: 'TLSv1' });
475475
});
476476
```
477477

‎doc/api/tracing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ console.log(trace_events.getEnabledCategories());
245245
```js
246246
'use strict';
247247

248-
const { Session } = require('inspector');
248+
const { Session } = require('node:inspector');
249249
const session = new Session();
250250
session.connect();
251251

‎doc/api/util.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ The mapping between error codes and string messages is platform-dependent.
483483
```js
484484
fs.access('file/that/does/not/exist', (err) => {
485485
const name = util.getSystemErrorMessage(err.errno);
486-
console.error(name); // no such file or directory
486+
console.error(name); // No such file or directory
487487
});
488488
```
489489

‎doc/api/v8.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1294,7 +1294,7 @@ is as follows.
12941294
Here's an example.
12951295

12961296
```js
1297-
const { GCProfiler } = require('v8');
1297+
const { GCProfiler } = require('node:v8');
12981298
const profiler = new GCProfiler();
12991299
profiler.start();
13001300
setTimeout(() => {

‎doc/api/vm.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1618,12 +1618,12 @@ in the outer context.
16181618
const vm = require('node:vm');
16191619
16201620
// An undefined `contextObject` option makes the global object contextified.
1621-
let context = vm.createContext();
1621+
const context = vm.createContext();
16221622
console.log(vm.runInContext('globalThis', context) === context); // false
16231623
// A contextified global object cannot be frozen.
16241624
try {
16251625
vm.runInContext('Object.freeze(globalThis);', context);
1626-
} catch(e) {
1626+
} catch (e) {
16271627
console.log(e); // TypeError: Cannot freeze
16281628
}
16291629
console.log(vm.runInContext('globalThis.foo = 1; foo;', context)); // 1
@@ -1648,7 +1648,7 @@ const context = vm.createContext(vm.constants.DONT_CONTEXTIFY);
16481648
vm.runInContext('Object.freeze(globalThis);', context);
16491649
try {
16501650
vm.runInContext('bar = 1; bar;', context);
1651-
} catch(e) {
1651+
} catch (e) {
16521652
console.log(e); // Uncaught ReferenceError: bar is not defined
16531653
}
16541654
```
@@ -1677,7 +1677,7 @@ console.log(vm.runInContext('bar;', context)); // 1
16771677
Object.freeze(context);
16781678
try {
16791679
vm.runInContext('baz = 1; baz;', context);
1680-
} catch(e) {
1680+
} catch (e) {
16811681
console.log(e); // Uncaught ReferenceError: baz is not defined
16821682
}
16831683
```

‎doc/api/worker_threads.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ markAsUncloneable(anyObject);
218218
const { port1 } = new MessageChannel();
219219
try {
220220
// This will throw an error, because anyObject is not cloneable.
221-
port1.postMessage(anyObject)
221+
port1.postMessage(anyObject);
222222
} catch (error) {
223223
// error.name === 'DataCloneError'
224224
}
@@ -908,6 +908,8 @@ not preserved. In particular, [`Buffer`][] objects will be read as
908908
plain [`Uint8Array`][]s on the receiving side, and instances of JavaScript
909909
classes will be cloned as plain JavaScript objects.
910910
911+
<!-- eslint-disable no-unused-private-class-members -->
912+
911913
```js
912914
const b = Symbol('b');
913915

‎doc/api/zlib.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -190,10 +190,7 @@ http.createServer((request, response) => {
190190
const raw = fs.createReadStream('index.html');
191191
// Store both a compressed and an uncompressed version of the resource.
192192
response.setHeader('Vary', 'Accept-Encoding');
193-
let acceptEncoding = request.headers['accept-encoding'];
194-
if (!acceptEncoding) {
195-
acceptEncoding = '';
196-
}
193+
const acceptEncoding = request.headers['accept-encoding'] || '';
197194

198195
const onError = (err) => {
199196
if (err) {

‎doc/contributing/writing-and-running-benchmarks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -538,7 +538,7 @@ The arguments of `createBenchmark` are:
538538
source: ['buffer', 'string'],
539539
len: [2048],
540540
n: [50, 2048],
541-
}
541+
},
542542
}, { byGroups: true });
543543
```
544544

‎eslint.config.mjs

-2
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,7 @@ export default [
4343
'**/node_modules/**',
4444
'benchmark/fixtures/**',
4545
'benchmark/tmp/**',
46-
'doc/**/*.js',
4746
'doc/changelogs/CHANGELOG_V1*.md',
48-
'!doc/api_assets/*.js',
4947
'!doc/changelogs/CHANGELOG_V18.md',
5048
'lib/punycode.js',
5149
'test/.tmp.*/**',

0 commit comments

Comments
 (0)