From 41bb3f13217239d128ac1578c016e2ce0f4743c4 Mon Sep 17 00:00:00 2001 From: Erick Zhao Date: Tue, 4 May 2021 01:17:04 -0700 Subject: [PATCH] docs: update REPL guide (#28943) * docs: update REPL guide * Update docs/tutorial/repl.md Co-authored-by: Mark Lee Co-authored-by: Mark Lee --- docs/README.md | 1 + docs/tutorial/repl.md | 28 ++++++++++++---------------- 2 files changed, 13 insertions(+), 16 deletions(-) diff --git a/docs/README.md b/docs/README.md index 5d5c512fa6..c4e26f81b7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -68,6 +68,7 @@ an issue: * [Testing on Headless CI Systems (Travis, Jenkins)](tutorial/testing-on-headless-ci.md) * [DevTools Extension](tutorial/devtools-extension.md) * [Automated Testing with a Custom Driver](tutorial/automated-testing-with-a-custom-driver.md) + * [REPL](tutorial/repl.md) * [Distribution](tutorial/application-distribution.md) * [Supported Platforms](tutorial/support.md#supported-platforms) * [Code Signing](tutorial/code-signing.md) diff --git a/docs/tutorial/repl.md b/docs/tutorial/repl.md index a07df7f949..82d9c035e1 100644 --- a/docs/tutorial/repl.md +++ b/docs/tutorial/repl.md @@ -1,27 +1,23 @@ # REPL -Read-Eval-Print-Loop (REPL) is a simple, interactive computer programming -environment that takes single user inputs (i.e. single expressions), evaluates -them, and returns the result to the user. +[Read-Eval-Print-Loop](https://en.wikipedia.org/wiki/Read%E2%80%93eval%E2%80%93print_loop) (REPL) +is a simple, interactive computer programming environment that takes single user +inputs (i.e. single expressions), evaluates them, and returns the result to the user. -The `repl` module provides a REPL implementation that can be accessed using: +## Main process -* Assuming you have `electron` or `electron-prebuilt` installed as a local - project dependency: +Electron exposes the [Node.js `repl` module](https://nodejs.org/dist/latest/docs/api/repl.html) +through the `--interactive` CLI flag. Assuming you have `electron` installed as a local project +dependency, you should be able to access the REPL with the following command: ```sh ./node_modules/.bin/electron --interactive ``` -* Assuming you have `electron` or `electron-prebuilt` installed globally: +**Note:** `electron --interactive` is not available on Windows +(see [electron/electron#5776](https://github.com/electron/electron/pull/5776) for more details). - ```sh - electron --interactive - ``` +## Renderer process -This only creates a REPL for the main process. You can use the Console -tab of the Dev Tools to get a REPL for the renderer processes. - -**Note:** `electron --interactive` is not available on Windows. - -More information can be found in the [Node.js REPL docs](https://nodejs.org/dist/latest/docs/api/repl.html). +You can use the DevTools Console tab to get a REPL for any renderer process. +To learn more, read [the Chrome documentation](https://developer.chrome.com/docs/devtools/console/).