repl: Add editor mode support #7275

princejwesley · 2016-06-12T08:58:30Z

Checklist

make -j4 test (UNIX) or vcbuild test nosign (Windows) passes
a test and/or benchmark is included
documentation is changed or added
the commit message follows commit guidelines

Affected core subsystem(s)

repl, doc

Description of change

Enabling ~~paste~~ editor mode support for REPL (inspired by scala REPL).

> node
> .editor
// Entering editor mode (^D to finish, ^C to cancel)
function test() {
  console.log('tested!');
}

test();

// ^D
tested!
undefined
>

benjamingr · 2016-06-12T12:37:18Z

I think this change needs to be voted on or at least discussed first - but personally I'm in favor - thanks for the contribution!

Trott · 2016-06-12T14:41:07Z

Can you add a test for paste mode? Existing repl tests are in test/parallel/test-repl*.

princejwesley · 2016-06-12T15:05:35Z

@Trott Done!

Trott · 2016-06-13T20:22:45Z

/cc @Fishrock123

cjihrig · 2016-06-14T12:59:35Z

test/parallel/test-repl-.paste.js

+
+  stream.write = (msg) => found += msg.replace('\r', '');
+
+  const expected = `${terminalCode}.paste


This code looks strange because of the indentation. Maybe change it to string concatenations.

Trott · 2016-06-14T18:44:32Z

The doc could probably use some information about what paste mode is.

Trott · 2016-06-14T18:48:35Z

Based on git shortlog -n -s lib/repl.js --since 'one year ago', /cc @thefourtheye @bnoordhuis @addaleax

Fishrock123 · 2016-06-15T15:28:55Z

Based on git shortlog -n -s lib/repl.js --since 'one year ago'

Keep in mind that more of us have touched the internal module.

I probably won't get to taking a look soon, but I'll leave my assignee as a self reminder for now.

addaleax · 2016-06-15T19:02:51Z

lib/repl.js

@@ -457,7 +468,8 @@ function REPLServer(prompt,

      // If error was SyntaxError and not JSON.parse error
      if (e) {
-        if (e instanceof Recoverable && !self.lineParser.shouldFail) {
+        if (e instanceof Recoverable && !self.lineParser.shouldFail &&
+          !sawCtrlD) {


This should probably line up with e instanceof Recoverable…

Fishrock123 · 2016-06-17T14:31:29Z

lib/repl.js

+  self.turnOffPasteMode = () => {
+    self.pasteMode = false;
+    self.setPrompt(self._initialPrompt);
+  };


better as a .prototype method?

Fishrock123 · 2016-06-17T14:58:34Z

Could someone elaborate on the benefits of this vs just normally pasting? Is it because you can edit the paste?

Fishrock123 · 2016-06-17T14:59:01Z

CI: https://ci.nodejs.org/job/node-test-pull-request/3014/

princejwesley · 2016-06-17T15:52:44Z

@Fishrock123

All lines of code entered in the paste mode will be executed at one shot. No more guesses on whether the emitted error is recoverable or not! It fixes most of the multiline mode issues.
Even though its called paste mode (copied the name and idea from scala REPL), Its precisely an instant, line buffered editor (Lazy multiline mode).
In paste mode, ~~tab completion~~, history navigation shortcuts are turned off. All other terminal shortcuts are preserved
We can cancel the whole input but the history is preserved since terminal is line buffered(Worked the same way like scala REPL)

Fishrock123 · 2016-06-17T20:04:38Z

@princejwesley Shouldn't tab completion still work?

Sounds like I should give this a try. I'm not so sure .paste is appropriate... maybe .editor?

princejwesley · 2016-06-17T20:17:54Z

@Fishrock123 Yes. .editor is good. I turned off tab complete to keep editor clean from tab completion output! Comment those statements and try!

princejwesley · 2016-08-01T15:59:09Z

ci: https://ci.nodejs.org/job/node-test-pull-request/3485/

princejwesley · 2016-08-02T15:52:52Z

CI is green

trevnorris · 2016-08-02T16:04:30Z

@princejwesley To confirm, there's nothing here that checks for tab press anymore (i.e. would conflict with #7754)?

princejwesley · 2016-08-02T16:29:45Z

@trevnorris Good point. I'll pull the patch and test locally.

princejwesley · 2016-08-02T16:59:23Z

CI: https://ci.nodejs.org/job/node-test-pull-request/3508/

```js > node > .editor // Entering editor mode (^D to finish, ^C to cancel) function test() { console.log('tested!'); } test(); // ^D tested! undefined > ```

princejwesley · 2016-08-03T17:38:40Z

ci: https://ci.nodejs.org/job/node-test-pull-request/3520/

princejwesley · 2016-08-06T06:42:27Z

Irrelevant CI failures: #3520, #3626, #3550 @Fishrock123

jasnell · 2016-08-06T06:47:30Z

New run to see if we can get all green... https://ci.nodejs.org/job/node-test-pull-request/3551/

princejwesley · 2016-08-06T10:39:36Z

@jasnell CI is green

jasnell · 2016-08-06T13:58:14Z

Woo! 😀 LGTM, let's land it

```js > node > .editor // Entering editor mode (^D to finish, ^C to cancel) function test() { console.log('tested!'); } test(); // ^D tested! undefined > ``` PR-URL: #7275 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>

princejwesley · 2016-08-06T14:43:59Z

Landed in b779eb42

```js > node > .editor // Entering editor mode (^D to finish, ^C to cancel) function test() { console.log('tested!'); } test(); // ^D tested! undefined > ``` PR-URL: #7275 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Evan Lucas <evanlucas@me.com>

Notable changes: * build: zlib symbols and additional OpenSSL symbols are now exposed on Windows platforms. (Alex Hultman) #7983 and #7576 * child_process, cluster: Forked child processes and cluster workers now support stdio configuration. (Colin Ihrig) #7811 and #7838 * fs: fs.ReadStream now exposes the number of bytes it has read so far. (Linus Unnebäck) #7942 * repl: The REPL now supports editor mode. (Prince J Wesley) #7275 * util: inspect() can now be configured globally using util.inspect.defaultOptions. (Roman Reiss) #8013 Refs: #8020 PR-URL: #8070

Notable changes: * build: zlib symbols and additional OpenSSL symbols are now exposed on Windows platforms. (Alex Hultman) #7983 and #7576 * child_process, cluster: Forked child processes and cluster workers now support stdio configuration. (Colin Ihrig) #7811 and #7838 * child_process: argv[0] can now be set to arbitrary values in spawned processes. (Pat Pannuto) #7696 * fs: fs.ReadStream now exposes the number of bytes it has read so far. (Linus Unnebäck) #7942 * repl: The REPL now supports editor mode. (Prince J Wesley) #7275 * util: inspect() can now be configured globally using util.inspect.defaultOptions. (Roman Reiss) #8013 Refs: #8020 PR-URL: #8070

Notable changes: * build: zlib symbols and additional OpenSSL symbols are now exposed on Windows platforms. (Alex Hultman) nodejs#7983 and nodejs#7576 * child_process, cluster: Forked child processes and cluster workers now support stdio configuration. (Colin Ihrig) nodejs#7811 and nodejs#7838 * child_process: argv[0] can now be set to arbitrary values in spawned processes. (Pat Pannuto) nodejs#7696 * fs: fs.ReadStream now exposes the number of bytes it has read so far. (Linus Unnebäck) nodejs#7942 * repl: The REPL now supports editor mode. (Prince J Wesley) nodejs#7275 * util: inspect() can now be configured globally using util.inspect.defaultOptions. (Roman Reiss) nodejs#8013 Refs: nodejs#8020 PR-URL: nodejs#8070

nbering · 2016-08-16T15:20:28Z

Sorry, a bit late to the issue because I just found it in the release notes. As I understand it this feature is strictly about delaying the execution of the command until you're done entering all the lines? I was hoping when I saw the feature name that it would allow me to fix previous lines if I make an error, but it seems once I hit enter that I can't go back.

PeterAronZentai · 2016-08-26T15:13:59Z

Yeah, that was my first impression too, maybe because it is called .editor. Probably .paste would create less confusion.

nodejs-github-bot added the repl Issues and PRs related to the REPL subsystem. label Jun 12, 2016

Trott added the semver-minor PRs that contain new features and should be released in the next minor version. label Jun 12, 2016

princejwesley force-pushed the repl-paste-mode branch from a3a13dd to 0543975 Compare June 12, 2016 15:03

Fishrock123 self-assigned this Jun 13, 2016

cjihrig reviewed Jun 14, 2016
View reviewed changes

princejwesley force-pushed the repl-paste-mode branch from 0543975 to 542e270 Compare June 14, 2016 14:55

addaleax reviewed Jun 15, 2016
View reviewed changes

princejwesley force-pushed the repl-paste-mode branch from 542e270 to b837360 Compare June 16, 2016 01:43

Fishrock123 reviewed Jun 17, 2016
View reviewed changes

princejwesley force-pushed the repl-paste-mode branch from b837360 to 0d1ef06 Compare June 17, 2016 16:22

princejwesley force-pushed the repl-paste-mode branch from 0d1ef06 to 482a4fe Compare June 17, 2016 20:33

princejwesley added 6 commits August 3, 2016 22:43

repl: Add editor mode support

9eb96a1

```js > node > .editor // Entering editor mode (^D to finish, ^C to cancel) function test() { console.log('tested!'); } test(); // ^D tested! undefined > ```

completeOn can be undefined

ac1f9a2

Add example for editor mode

23e5842

Move longestCommonPrefix outside tab complete

233ecc5

Prevent double tab behavior

4134ddd

Fix linter issue

370616c

princejwesley force-pushed the repl-paste-mode branch from caf100a to 370616c Compare August 3, 2016 17:37

princejwesley closed this Aug 6, 2016

cjihrig mentioned this pull request Aug 8, 2016

v6.4.0 Release Proposal #8020

Closed

cjihrig mentioned this pull request Aug 11, 2016

v6.4.0 Proposal #8070

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

repl: Add editor mode support #7275

repl: Add editor mode support #7275

princejwesley commented Jun 12, 2016 •

edited

Loading

benjamingr commented Jun 12, 2016 •

edited

Loading

Trott commented Jun 12, 2016

princejwesley commented Jun 12, 2016

Trott commented Jun 13, 2016

cjihrig Jun 14, 2016

Trott commented Jun 14, 2016

Trott commented Jun 14, 2016

Fishrock123 commented Jun 15, 2016

addaleax Jun 15, 2016

Fishrock123 Jun 17, 2016

Fishrock123 commented Jun 17, 2016

Fishrock123 commented Jun 17, 2016

princejwesley commented Jun 17, 2016 •

edited

Loading

Fishrock123 commented Jun 17, 2016

princejwesley commented Jun 17, 2016

princejwesley commented Aug 1, 2016

princejwesley commented Aug 2, 2016

trevnorris commented Aug 2, 2016

princejwesley commented Aug 2, 2016

princejwesley commented Aug 2, 2016

princejwesley commented Aug 3, 2016

princejwesley commented Aug 6, 2016

jasnell commented Aug 6, 2016

princejwesley commented Aug 6, 2016

jasnell commented Aug 6, 2016

princejwesley commented Aug 6, 2016

nbering commented Aug 16, 2016

PeterAronZentai commented Aug 26, 2016


		stream.write = (msg) => found += msg.replace('\r', '');

		const expected = `${terminalCode}.paste

repl: Add editor mode support #7275

repl: Add editor mode support #7275

Conversation

princejwesley commented Jun 12, 2016 • edited Loading

Checklist

Affected core subsystem(s)

Description of change

benjamingr commented Jun 12, 2016 • edited Loading

Trott commented Jun 12, 2016

princejwesley commented Jun 12, 2016

Trott commented Jun 13, 2016

cjihrig Jun 14, 2016

Choose a reason for hiding this comment

Trott commented Jun 14, 2016

Trott commented Jun 14, 2016

Fishrock123 commented Jun 15, 2016

addaleax Jun 15, 2016

Choose a reason for hiding this comment

Fishrock123 Jun 17, 2016

Choose a reason for hiding this comment

Fishrock123 commented Jun 17, 2016

Fishrock123 commented Jun 17, 2016

princejwesley commented Jun 17, 2016 • edited Loading

Fishrock123 commented Jun 17, 2016

princejwesley commented Jun 17, 2016

princejwesley commented Aug 1, 2016

princejwesley commented Aug 2, 2016

trevnorris commented Aug 2, 2016

princejwesley commented Aug 2, 2016

princejwesley commented Aug 2, 2016

princejwesley commented Aug 3, 2016

princejwesley commented Aug 6, 2016

jasnell commented Aug 6, 2016

princejwesley commented Aug 6, 2016

jasnell commented Aug 6, 2016

princejwesley commented Aug 6, 2016

nbering commented Aug 16, 2016

PeterAronZentai commented Aug 26, 2016

princejwesley commented Jun 12, 2016 •

edited

Loading

benjamingr commented Jun 12, 2016 •

edited

Loading

princejwesley commented Jun 17, 2016 •

edited

Loading