repl: added support for custom completions #8484

diosney · 2014-10-01T21:21:08Z

Currently I'm working on a project that uses the REPL to implement a mid complex CLI app found out that the REPL module doesn't have a way to override the default complete() function, which is used for TAB completions of commands.

I think that the REPL module can benefit from this addition, and specifically the repl applications that may wants to use this functionality.

I added the docs & tests, and the tests passed fine in my environment, this is just a little change, after all.

diosney · 2014-10-01T21:23:58Z

Simple example:

var repl = require('repl')
  .start({
    terminal : true,
    completer: function completer(line) {
      var completions = 'aaa aa1 aa2 bbb ccc ddd eee'.split(' ');

      var hits = completions.filter(function (item) {
        return item.indexOf(line) == 0;
      });

      // Show all completions if none was found.
      return [
        hits.length
          ? hits
          : completions,
        line
      ];
    }
  });

diosney · 2014-12-05T16:02:11Z

Hi, any decision on this?.

cjihrig · 2014-12-05T17:02:19Z

lib/repl.js

@@ -429,6 +428,9 @@ var requireRE = /\brequire\s*\(['"](([\w\.\/-]+\/)?([\w\.\/-]*))/;
 var simpleExpressionRE =
    /(([a-zA-Z_$](?:\w|\$)*)\.)*([a-zA-Z_$](?:\w|\$)*)\.?$/;

+REPLServer.prototype.complete = function() {
+  this.completer.apply(this, arguments);


Why not just pass line and callback by name?

Just to avoid in the future if anyone adds more parameters to the original function but forgot to put them there. A little silly but removes complexity by having only one source of truth.

cjihrig · 2014-12-05T17:02:45Z

It's not up to me, but I'm OK with this change (assuming it works).

diosney · 2014-12-05T18:24:36Z

OK, thanks for your opinion. I added the related tests too, so test if it works can be done automatically.

diosney · 2015-02-18T14:08:44Z

Hi, any plans to review this? Thanks

jasnell · 2015-02-20T17:20:16Z

Also not up to me to accept it or not but this looks like a good addition.

cjihrig · 2015-02-24T16:21:58Z

test/simple/test-repl-tab-complete.js

+  completer: function customCompleter(line, cb) {
+    var completions = 'aaa aa1 aa2 bbb bb1 bb2 bb3 ccc ddd eee'.split(' ');
+    var hits = completions.filter(function (item) {
+      return item.indexOf(line) == 0;


Please make this ===

Fixed. Thanks.

cjihrig · 2015-02-24T16:25:34Z

A few comments, but mostly LGTM. Please squash this down to a single commit. If no one has a problem with this, I'll land it.

diosney · 2015-06-13T21:55:50Z

@cjihrig Sorry for the delay, somehow I got noticed right now of your comments about this :( I don't know why was until now that my email client delayed the related github notifications o_O.

Thanks for your comments, I fixed all the pointed issues and squashed the commits into a single one, so, do you think that this feature can land now?

Thanks

thefourtheye · 2015-06-15T03:01:28Z

doc/api/repl.markdown

@@ -64,6 +64,9 @@ the following values:
   returns the formatting (including coloring) to display. Defaults to
   `util.inspect`.

+ - `completer` - an optional function that is used for Tab autocompletion.
+   See [Readline Interface][] for an example of using this.


Are we forgetting to include a link here?

Well, at the time I made the PR, that was the way in the other docs that the linking was done, maybe this changed in the meantime. Search in https://raw.githubusercontent.com/joyent/node/master/doc/api/https.markdown for [tls.createServer()][] for an example.

If there is other way to do it, just point me in the rigth direction please, but looking at the docs code I didn't found an example of direct linking.

@thefourtheye Well, I ended direct linking to the page, I searched a bit more through the docs I found a way to do it. Compiled the docs and the links worked as expected.

I think you need to use https://nodejs.org/api/readline.html#readline_readline_createinterface_options

No, it seems that it had to be the relative path, something like readline.html#readline_readline_createinterface_options.

diosney · 2015-06-15T21:02:10Z

@cjihrig OK, links in the docs fixed too, waiting for your approval.

cjihrig · 2015-06-16T16:27:14Z

lib/repl.js

-    self.complete(text, callback);
-  }
+  // Figure out which "complete" function to use.
+  self.completer = options.completer || complete;


Can you change this to self.completer = typeof options.completer === 'function' ? options.completer : complete; just to ensure that completer is a function.

Edit: You may have to split this across lines if it goes past 80 characters.

diosney · 2015-06-18T12:06:32Z

@cjihrig Is everything okey now? I hope so :D

cjihrig · 2015-06-24T02:18:48Z

test/simple/test-repl-tab-complete.js

+      return item.indexOf(line) === 0;
+    });
+    // Show all completions if none was found.
+    cb([hits.length ? hits : completions, line]);


Do you not need to pass an error argument here?

What do you mean? Can you be more explicit?

Most callbacks take an error as their first argument. Is that not the case here?

cjihrig · 2015-06-24T02:20:18Z

Can you please open this PR against io.js. Since this is a new feature, it no longer makes sense to have it in joyent/node.

cjihrig · 2015-06-24T02:20:36Z

LGTM, by the way.

diosney · 2015-06-25T12:55:30Z

@cjihrig This is really frustrating man. Seriously. It seems that the Contributing docs have to be updated.

cjihrig · 2015-06-25T14:09:46Z

Sorry, I'm not sure how closely you've been following along, but Node.js is moving into a foundation and merging with io.js. This repo (joyent/node) is going to become a maintenance branch. The new repo will live at nodejs/node. However, the converged repo is not quite ready yet, so new features (such as the one in this PR) are going into io.js.

jasnell · 2015-06-25T16:52:54Z

@diosney ... definitely can appreciate the frustration. We're currently in mid transition working on bringing node.js and io.js back together and it is a bit confusing where new contributions need to go (or even where old contributions need to land if they haven't already). The documentation will get updated but there are quite a few moving parts. All I can ask is a bit of patience ;-). The patch looks good, btw. Would love to see it land.

Allow user code to override the default `complete()` function from `readline.Interface`. See: https://nodejs.org/api/readline.html#readline_use_of_the_completer_function Ref: nodejs/node-v0.x-archive#8484 PR-URL: #7527 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Lance Ball <lball@redhat.com>

Nodejs-Jenkins added pr master labels Oct 1, 2014

trevnorris added feature-request repl labels Oct 7, 2014

cjihrig reviewed Dec 5, 2014
View reviewed changes

cjihrig reviewed Feb 24, 2015
View reviewed changes

diosney force-pushed the repl-add-custom-completion-support branch from 266bd4f to 231d34d Compare June 13, 2015 21:45

thefourtheye reviewed Jun 15, 2015
View reviewed changes

diosney force-pushed the repl-add-custom-completion-support branch from 231d34d to 92d779e Compare June 15, 2015 14:01

cjihrig reviewed Jun 16, 2015
View reviewed changes

repl: added support for custom completions

823dacb

diosney force-pushed the repl-add-custom-completion-support branch from 92d779e to 823dacb Compare June 16, 2015 19:05

cjihrig reviewed Jun 24, 2015
View reviewed changes

cjihrig closed this Jun 24, 2015

diosney mentioned this pull request Jul 3, 2016

repl: added support for custom completions. nodejs/node#7527

Closed

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

repl: added support for custom completions #8484

repl: added support for custom completions #8484

diosney commented Oct 1, 2014

diosney commented Oct 1, 2014

diosney commented Dec 5, 2014

cjihrig Dec 5, 2014

diosney Dec 5, 2014

cjihrig commented Dec 5, 2014

diosney commented Dec 5, 2014

diosney commented Feb 18, 2015

jasnell commented Feb 20, 2015

cjihrig Feb 24, 2015

diosney Jun 13, 2015

cjihrig commented Feb 24, 2015

diosney commented Jun 13, 2015

thefourtheye Jun 15, 2015

diosney Jun 15, 2015

diosney Jun 15, 2015

thefourtheye Jun 15, 2015

diosney Jun 15, 2015

diosney commented Jun 15, 2015

cjihrig Jun 16, 2015

diosney Jun 16, 2015

diosney commented Jun 18, 2015

cjihrig Jun 24, 2015

diosney Jun 25, 2015

cjihrig Jun 25, 2015

cjihrig commented Jun 24, 2015

cjihrig commented Jun 24, 2015

diosney commented Jun 25, 2015

cjihrig commented Jun 25, 2015

jasnell commented Jun 25, 2015

repl: added support for custom completions #8484

repl: added support for custom completions #8484

Conversation

diosney commented Oct 1, 2014

diosney commented Oct 1, 2014

diosney commented Dec 5, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cjihrig commented Dec 5, 2014

diosney commented Dec 5, 2014

diosney commented Feb 18, 2015

jasnell commented Feb 20, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cjihrig commented Feb 24, 2015

diosney commented Jun 13, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diosney commented Jun 15, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

diosney commented Jun 18, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cjihrig commented Jun 24, 2015

cjihrig commented Jun 24, 2015

diosney commented Jun 25, 2015

cjihrig commented Jun 25, 2015

jasnell commented Jun 25, 2015