doc: update

Author: avivkeller

doc/api/repl.md

@@ -1,12 +1,12 @@
 # REPL
 
+<!--introduced_in=v0.10.0-->
+
 ## Stable REPL
 
 > This section documents how to `node:repl` module acts without the
 > `--exprimental-repl` CLI flag enabled.
 
-<!--introduced_in=v0.10.0-->
-
 > Stability: 2 - Stable
 
 <!-- source_link=lib/internal/repl/stable/index.js -->
@@ -21,15 +21,15 @@ const repl = require('node:repl');
 
 ### Design and features
 
-The `node:repl` module exports the [`repl.REPLServer`][11] class. While running,
-instances of [`repl.REPLServer`][11] will accept individual lines of user input,
+The `node:repl` module exports the [`repl.REPLServer`][] class. While running,
+instances of [`repl.REPLServer`][] will accept individual lines of user input,
 evaluate those according to a user-defined evaluation function, then output the
 result. Input and output may be from `stdin` and `stdout`, respectively, or may
-be connected to any Node.js [stream][15].
+be connected to any Node.js [stream][].
 
-Instances of [`repl.REPLServer`][11] support automatic completion of inputs,
+Instances of [`repl.REPLServer`][] support automatic completion of inputs,
 completion preview, simplistic Emacs-style line editing, multi-line inputs,
-[ZSH][02]-like reverse-i-search, [ZSH][02]-like substring-based history search,
+[ZSH][]-like reverse-i-search, [ZSH][]-like substring-based history search,
 ANSI-styled output, saving and restoring current REPL session state, error
 recovery, and customizable evaluation functions. Terminals that do not support
 ANSI styles and Emacs-style line editing automatically fall back to a limited
@@ -78,15 +78,15 @@ The following key combinations in the REPL have these special effects:
   (scope) variables. When pressed while entering other input, displays relevant
   autocompletion options.
 
-For key bindings related to the reverse-i-search, see [`reverse-i-search`][13].
-For all other key bindings, see [TTY keybindings][01].
+For key bindings related to the reverse-i-search, see [`reverse-i-search`][].
+For all other key bindings, see [TTY keybindings][].
 
 #### Default evaluation
 
-By default, all instances of [`repl.REPLServer`][11] use an evaluation function
+By default, all instances of [`repl.REPLServer`][] use an evaluation function
 that evaluates JavaScript expressions and provides access to Node.js built-in
 modules. This default behavior can be overridden by passing in an alternative
-evaluation function when the [`repl.REPLServer`][11] instance is created.
+evaluation function when the [`repl.REPLServer`][] instance is created.
 
 ##### JavaScript expressions
 
@@ -164,14 +164,14 @@ changes:
                  repl is used as standalone program.
 -->
 
-The REPL uses the [`domain`][08] module to catch all uncaught exceptions for that
+The REPL uses the [`domain`][] module to catch all uncaught exceptions for that
 REPL session.
 
-This use of the [`domain`][08] module in the REPL has these side effects:
+This use of the [`domain`][] module in the REPL has these side effects:
 
-* Uncaught exceptions only emit the [`'uncaughtException'`][03] event in the
+* Uncaught exceptions only emit the [`'uncaughtException'`][] event in the
   standalone REPL. Adding a listener for this event in a REPL within
-  another Node.js program results in [`ERR_INVALID_REPL_INPUT`][06].
+  another Node.js program results in [`ERR_INVALID_REPL_INPUT`][].
 
   ```js
   const r = repl.start();
@@ -184,8 +184,8 @@ This use of the [`domain`][08] module in the REPL has these side effects:
   r.close();
   ```
 
-* Trying to use [`process.setUncaughtExceptionCaptureCallback()`][09] throws
-  an [`ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE`][05] error.
+* Trying to use [`process.setUncaughtExceptionCaptureCallback()`][] throws
+  an [`ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE`][] error.
 
 ##### Assignment of the `_` (underscore) variable
 
@@ -258,7 +258,7 @@ undefined
 234
 ```
 
-[`--no-experimental-repl-await`][04] shall disable top-level await in REPL.
+[`--no-experimental-repl-await`][] shall disable top-level await in REPL.
 
 #### Reverse-i-search
 
@@ -268,7 +268,7 @@ added:
  - v12.17.0
 -->
 
-The REPL supports bi-directional reverse-i-search similar to [ZSH][02]. It is
+The REPL supports bi-directional reverse-i-search similar to [ZSH][]. It is
 triggered with <kbd>Ctrl</kbd>+<kbd>R</kbd> to search backward
 and <kbd>Ctrl</kbd>+<kbd>S</kbd> to search forwards.
 
@@ -283,7 +283,7 @@ direction from the current position on.
 
 #### Custom evaluation functions
 
-When a new [`repl.REPLServer`][11] is created, a custom evaluation function may be
+When a new [`repl.REPLServer`][] is created, a custom evaluation function may be
 provided. This can be used, for instance, to implement fully customized REPL
 applications.
 
@@ -332,32 +332,32 @@ function isRecoverableError(error) {
 
 #### Customizing REPL output
 
-By default, [`repl.REPLServer`][11] instances format output using the
-[`util.inspect()`][14] method before writing the output to the provided `Writable`
-[stream][15] (`process.stdout` by default). The `showProxy` inspection option is set
+By default, [`repl.REPLServer`][] instances format output using the
+[`util.inspect()`][] method before writing the output to the provided `Writable`
+[stream][] (`process.stdout` by default). The `showProxy` inspection option is set
 to true by default and the `colors` option is set to true depending on the
 REPL's `useColors` option.
 
 The `useColors` boolean option can be specified at construction to instruct the
 default writer to use ANSI style codes to colorize the output from the
-[`util.inspect()`][14] method.
+[`util.inspect()`][] method.
 
 If the REPL is run as standalone program, it is also possible to change the
-REPL's [inspection defaults][14] from inside the REPL by using the
+REPL's [inspection defaults][`util.inspect()`] from inside the REPL by using the
 `inspect.replDefaults` property which mirrors the `defaultOptions` from
-[`util.inspect()`][14].
+[`util.inspect()`][].
 
 ```console
 > util.inspect.replDefaults.compact = false;
 false
-> [01]
+> [1]
 [
   1
 ]
 >
 ```
 
-To fully customize the output of a [`repl.REPLServer`][11] instance pass in a new
+To fully customize the output of a [`repl.REPLServer`][] instance pass in a new
 function for the `writer` option on construction. The following example, for
 instance, simply converts any input text to upper case:
 
@@ -381,10 +381,10 @@ function myWriter(output) {
 added: v0.1.91
 -->
 
-* `options` {Object|string} See [`repl.start()`][12]
+* `options` {Object|string} See [`repl.start()`][]
 * Extends: {readline.Interface}
 
-Instances of `repl.REPLServer` are created using the [`repl.start()`][12] method
+Instances of `repl.REPLServer` are created using the [`repl.start()`][] method
 or directly using the JavaScript `new` keyword.
 
 ```js
@@ -612,9 +612,9 @@ changes:
 * `options` {Object|string}
   * `prompt` {string} The input prompt to display. **Default:** `'> '`
     (with a trailing space).
-  * `input` {[stream][15].Readable} The `Readable` stream from which REPL input will
+  * `input` {[stream][].Readable} The `Readable` stream from which REPL input will
     be read. **Default:** `process.stdin`.
-  * `output` {[stream][15].Writable} The `Writable` stream to which REPL output will
+  * `output` {[stream][].Writable} The `Writable` stream to which REPL output will
     be written. **Default:** `process.stdout`.
   * `terminal` {boolean} If `true`, specifies that the `output` should be
     treated as a TTY terminal.
@@ -637,9 +637,9 @@ changes:
     will not output the return value of a command if it evaluates to
     `undefined`. **Default:** `false`.
   * `writer` {Function} The function to invoke to format the output of each
-    command before writing to `output`. **Default:** [`util.inspect()`][14].
+    command before writing to `output`. **Default:** [`util.inspect()`][].
   * `completer` {Function} An optional function used for custom Tab auto
-    completion. See [`readline.InterfaceCompleter`][10] for an example.
+    completion. See [`readline.InterfaceCompleter`][] for an example.
   * `replMode` {symbol} A flag that specifies whether the default evaluator
     executes all JavaScript commands in strict mode or default (sloppy) mode.
     Acceptable values are:
@@ -656,7 +656,7 @@ changes:
     there are no previews and the value of `preview` has no effect.
 * Returns: {repl.REPLServer}
 
-The `repl.start()` method creates and starts a [`repl.REPLServer`][11] instance.
+The `repl.start()` method creates and starts a [`repl.REPLServer`][] instance.
 
 If `options` is a string, then it specifies the input prompt:
 
@@ -786,7 +786,7 @@ For an example of running a "full-featured" (`terminal`) REPL over
 a `net.Server` and `net.Socket` instance, see:
 <https://gist.github.com/TooTallNate/2209310>.
 
-For an example of running a REPL instance over [`curl(1)`][07], see:
+For an example of running a REPL instance over [`curl(1)`][], see:
 <https://gist.github.com/TooTallNate/2053342>.
 
 ## Experimental REPL
@@ -804,7 +804,7 @@ const experimentalREPL = require('node:repl');
 ### Design and Features
 
 When running in experimental mode, the `node:repl` module exports the
-[`repl.ExperimentalREPLServer`][21] class. This class, similar to the
+[`repl.ExperimentalREPLServer`][] class. This class, similar to the
 stable REPL, accepts individual lines of user input.
 
 Most features from the stable REPL are also available in this REPL, including:
@@ -813,8 +813,8 @@ Most features from the stable REPL are also available in this REPL, including:
 * Completion preview
 * Simplistic Emacs-style line editing
 * Multi-line inputs
-* [ZSH][02]-like [reverse-i-search][13]
-* [ZSH][02]-like substring-based history search
+* [ZSH][]-like [`reverse-i-search`][]
+* [ZSH][]-like substring-based history search
 * ANSI-styled output
 * Error recovery
 
@@ -835,7 +835,7 @@ Special commands supported by all ExperimentalREPL instances:
 * `.help`: Shows a list of special commands.
 * `.clear`: Clears the screen.
 
-Additional commands may be implemented via the [`defineCommand(name, help, fn)`][17] function.
+Additional commands may be implemented via the [`defineCommand(name, help, fn)`][] function.
 
 Special key combinations in the REPL:
 
@@ -850,8 +850,8 @@ Special key combinations in the REPL:
   * Displays global and local (scope) variables on a blank line.
   * Displays relevant autocompletion options when pressed while entering other input.
 
-For key bindings related to the reverse-i-search, see [`reverse-i-search`][13].
-For all other key bindings, see [TTY keybindings][01].
+For key bindings related to the reverse-i-search, see [`reverse-i-search`][].
+For all other key bindings, see [TTY keybindings][].
 
 ##### Special Variables
 
@@ -885,9 +885,10 @@ libraries.
 
 ### Class: `ExperimentalREPLServer`
 
-* Extends: {[events.EventEmitter][18]}
+* Extends: {[events.EventEmitter][]}
 
-Instances of the `repl.ExperimentalREPLServer` class can be created either via the constructor or the static [`repl.start()`][19] method.
+Instances of the `repl.ExperimentalREPLServer` class can be created either via the constructor or the static
+[`repl.start()`][(Experimental) `repl.start()`] method.
 
 ```cjs
 (async () => {
@@ -907,7 +908,7 @@ Instances of the `repl.ExperimentalREPLServer` class can be created either via t
 #### Event: `'exit'`
 
 The `'exit'` event is emitted when the REPL is exited via the
-[`experimentalReplServer.close()`][20] method. This event can be useful for
+[`experimentalReplServer.close()`][] method. This event can be useful for
 cleanup tasks or logging when the REPL session ends.
 
 ```js
@@ -983,7 +984,7 @@ experimentalReplServer.preview('os.arch()'); // undefined (as this calls a funct
 * `uncaught` {boolean}: Whether or not an error was incurred.
 * `line` {number}: The line number of the execution.
 * `value` {any}: The output of the line's execution.
-* Returns: {string}: The [`util.inspect()`][14]ed result of the `value`.
+* Returns: {string}: The [`util.inspect()`][]ed result of the `value`.
 
 The `experimentalReplServer.updateInspect(uncaught, line, value)` method
 updates the underscore variables and returns the inspected result. It's
@@ -1020,8 +1021,8 @@ experimentalReplServer.onLine('.help'); // Prints the help to stdout
 #### `experimentalReplServer.start(options)`
 
 * `options` {Object}: Options for starting the REPL
-* `options.input` {[stream][15].Readable}: The input stream for the REPL (_Default:_ `process.stdin`)
-* `options.output` {[stream][15].Writable}: The output stream for the REPL (_Default:_ `process.stdout`)
+* `options.input` {[stream][].Readable}: The input stream for the REPL (_Default:_ `process.stdin`)
+* `options.output` {[stream][].Writable}: The output stream for the REPL (_Default:_ `process.stdout`)
 * Returns: `Promise<void>`
 
 The `experimentalReplServer.start()` method initializes the REPL session.
@@ -1038,8 +1039,8 @@ The `experimentalReplServer.start()` method initializes the REPL session.
 #### `ExperimentalREPLServer.start(options)`
 
 * `options` {Object}: Options for starting the REPL
-* `options.input` {[stream][15].Readable}: The input stream for the REPL (_Default:_ `process.stdin`)
-* `options.output` {[stream][15].Writable}: The output stream for the REPL (_Default:_ `process.stdout`)
+* `options.input` {[stream][].Readable}: The input stream for the REPL (_Default:_ `process.stdin`)
+* `options.output` {[stream][].Writable}: The output stream for the REPL (_Default:_ `process.stdout`)
 * Returns: `Promise<ExperimentalREPLServer>`
 
 The `ExperimentalREPLServer.start(options)` static method creates and initializes a new REPL.
@@ -1053,26 +1054,24 @@ async () => {
 };
 ```
 
-<!-- eslint-disable -->
-
-[01]: readline.md#tty-keybindings
-[02]: https://en.wikipedia.org/wiki/Z_shell
-[03]: process.md#event-uncaughtexception
-[04]: cli.md#--no-experimental-repl-await
-[05]: errors.md#err_domain_cannot_set_uncaught_exception_capture
-[06]: errors.md#err_invalid_repl_input
-[07]: https://curl.haxx.se/docs/manpage.html
-[08]: domain.md
-[09]: process.md#processsetuncaughtexceptioncapturecallbackfn
-[10]: readline.md#use-of-the-completer-function
-[11]: #class-replserver
-[12]: #replstartoptions
-[13]: #reverse-i-search
-[14]: util.md#utilinspectobject-options
-[15]: stream.md
-[16]: cli.md#--experimental-repl
-[17]: #experimentalreplserverdefinecommandname-help-fn
-[18]: events.md#class-eventemitter
-[19]: #experimentalreplserverstartoptions
-[20]: #experimentalreplserverclose
-[21]: #class-experimentalreplserver
+[(Experimental) `repl.start()`]: #experimentalreplserverstartoptions
+[TTY keybindings]: readline.md#tty-keybindings
+[ZSH]: https://en.wikipedia.org/wiki/Z_shell
+[`'uncaughtException'`]: process.md#event-uncaughtexception
+[`--experimental-repl`]: cli.md#--experimental-repl
+[`--no-experimental-repl-await`]: cli.md#--no-experimental-repl-await
+[`ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE`]: errors.md#err_domain_cannot_set_uncaught_exception_capture
+[`ERR_INVALID_REPL_INPUT`]: errors.md#err_invalid_repl_input
+[`curl(1)`]: https://curl.haxx.se/docs/manpage.html
+[`defineCommand(name, help, fn)`]: #experimentalreplserverdefinecommandname-help-fn
+[`domain`]: domain.md
+[`experimentalReplServer.close()`]: #experimentalreplserverclose
+[`process.setUncaughtExceptionCaptureCallback()`]: process.md#processsetuncaughtexceptioncapturecallbackfn
+[`readline.InterfaceCompleter`]: readline.md#use-of-the-completer-function
+[`repl.ExperimentalREPLServer`]: #class-experimentalreplserver
+[`repl.REPLServer`]: #class-replserver
+[`repl.start()`]: #replstartoptions
+[`reverse-i-search`]: #reverse-i-search
+[`util.inspect()`]: util.md#utilinspectobject-options
+[events.EventEmitter]: events.md#class-eventemitter
+[stream]: stream.md