Skip to content

doc: add esm examples to node:repl #55432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nodejs-github-bot merged 2 commits into from
Dec 14, 2024
Merged

doc: add esm examples to node:repl #55432

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d285c4a
doc: add esm examples to node:repl
mfdebian Oct 17, 2024
f8e78b1
apply suggestions from @bnb code review
mfdebian Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
apply suggestions from @bnb code review
  • Loading branch information
@mfdebian
mfdebian committed Oct 17, 2024
commit f8e78b159ffdeeb95513583efb57326fe8dba964
21 changes: 11 additions & 10 deletions doc/api/repl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,33 +303,34 @@ 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.

The following illustrates a hypothetical example of a REPL that performs
translation of text from one language to another:
The following illustrates an example of a REPL that squares a given number:

```mjs
import repl from 'node:repl';
import { Translator } from 'translator';

const myTranslator = new Translator('en', 'fr');
function byThePowerOfTwo(number) {
return number * number;
}

function myEval(cmd, context, filename, callback) {
callback(null, myTranslator.translate(cmd));
callback(null, byThePowerOfTwo(cmd));
}

repl.start({ prompt: '> ', eval: myEval });
repl.start({ prompt: 'Enter a number: ', eval: myEval });
```
Comment on lines +309 to +320

@bnb bnb Oct 17, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this code block adds a mock dependency to a module that actually exists and is very dormant (translator). IMO we should try to avoid that and the alternative of using a module that doesn't exist.

While this is also true of the previously existing example, since it's being updated now with a totally new example I think it's a good time to adjust it.

@mfdebian mfdebian Oct 17, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed! I also thought about that example since it throws an error when you try to execute it as is and new users can be frustrated by that, I'll come up with a good alternative and update as soon as I can! Thanks for the feedback! 🙌

@mfdebian mfdebian Oct 17, 2024

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the example, tell me what you think! 😊 And again, thank you for taking the time to provide feedback! 🙏


```cjs
const repl = require('node:repl');
const { Translator } = require('translator');

const myTranslator = new Translator('en', 'fr');
function byThePowerOfTwo(number) {
return number * number;
}

function myEval(cmd, context, filename, callback) {
callback(null, myTranslator.translate(cmd));
callback(null, byThePowerOfTwo(cmd));
}

repl.start({ prompt: '> ', eval: myEval });
repl.start({ prompt: 'Enter a number: ', eval: myEval });
```

#### Recoverable errors
Expand Down