repl: add auto‑completion for dynamic import calls

Refs: #33238 Refs: #33282 Co-authored-by: Antoine du Hamel <[email protected]> PR-URL: #37178 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Juan José Arboleda <[email protected]> Reviewed-By: Rich Trott <[email protected]>

Author: ExE-Boss

lib/internal/modules/esm/get_format.js

@@ -7,7 +7,7 @@ const{extname } = require('path');
 const{ getOptionValue }=require('internal/options');
 
 constexperimentalJsonModules=getOptionValue('--experimental-json-modules');
-constexperimentalSpeciferResolution=
+constexperimentalSpecifierResolution=
 getOptionValue('--experimental-specifier-resolution');
 constexperimentalWasmModules=getOptionValue('--experimental-wasm-modules');
 const{ getPackageType }=require('internal/modules/esm/resolve');
@@ -62,7 +62,7 @@ function defaultGetFormat(url, context, defaultGetFormatUnused){
 format=extensionFormatMap[ext];
 }
 if(!format){
-if(experimentalSpeciferResolution==='node'){
+if(experimentalSpecifierResolution==='node'){
 process.emitWarning(
 'The Node.js specifier resolution in ESM is experimental.',
 'ExperimentalWarning');
@@ -75,4 +75,9 @@ function defaultGetFormat(url, context, defaultGetFormatUnused){
 }
 return{format: null};
 }
-exports.defaultGetFormat=defaultGetFormat;
+
+module.exports={
+ defaultGetFormat,
+ extensionFormatMap,
+ legacyExtensionFormatMap,
+};

lib/repl.js

@@ -54,6 +54,7 @@ const{
  ArrayPrototypePush,
  ArrayPrototypeReverse,
  ArrayPrototypeShift,
+ ArrayPrototypeSlice,
  ArrayPrototypeSome,
  ArrayPrototypeSort,
  ArrayPrototypeSplice,
@@ -127,6 +128,8 @@ let _builtinLibs = ArrayPrototypeFilter(
 CJSModule.builtinModules,
 (e)=>!StringPrototypeStartsWith(e,'_')&&!StringPrototypeIncludes(e,'/')
 );
+constnodeSchemeBuiltinLibs=ArrayPrototypeMap(
+_builtinLibs,(lib)=>`node:${lib}`);
 constdomain=require('domain');
 letdebug=require('internal/util/debuglog').debuglog('repl',(fn)=>{
 debug=fn;
@@ -168,6 +171,11 @@ const{
 }=internalBinding('contextify');
 
 consthistory=require('internal/repl/history');
+const{
+ extensionFormatMap,
+ legacyExtensionFormatMap,
+}=require('internal/modules/esm/get_format');
+
 letnextREPLResourceNumber=1;
 // This prevents v8 code cache from getting confused and using a different
 // cache from a resource of the same name
@@ -1135,10 +1143,12 @@ REPLServer.prototype.turnOffEditorMode = deprecate(
 'REPLServer.turnOffEditorMode() is deprecated',
 'DEP0078');
 
+constimportRE=/\bimport\s*\(\s*['"`](([\w@./:-]+\/)?(?:[\w@./:-]*))(?![^'"`])$/;
 constrequireRE=/\brequire\s*\(\s*['"`](([\w@./-]+\/)?(?:[\w@./-]*))(?![^'"`])$/;
 constfsAutoCompleteRE=/fs(?:\.promises)?\.\s*[a-z][a-zA-Z]+\(\s*["'](.*)/;
 constsimpleExpressionRE=
 /(?:[a-zA-Z_$](?:\w|\$)*\??\.)*[a-zA-Z_$](?:\w|\$)*\??\.?$/;
+constversionedFileNamesRe=/-\d+\.\d+/;
 
 functionisIdentifier(str){
 if(str===''){
@@ -1245,7 +1255,6 @@ function complete(line, callback){
 constindexes=ArrayPrototypeMap(extensions,
 (extension)=>`index${extension}`);
 ArrayPrototypePush(indexes,'package.json','index');
-constversionedFileNamesRe=/-\d+\.\d+/;
 
 constmatch=StringPrototypeMatch(line,requireRE);
 completeOn=match[1];
@@ -1299,6 +1308,75 @@ function complete(line, callback){
 if(!subdir){
 ArrayPrototypePush(completionGroups,_builtinLibs);
 }
+}elseif(RegExpPrototypeTest(importRE,line)&&
+this.allowBlockingCompletions){
+// import('...<Tab>')
+// File extensions that can be imported:
+constextensions=ObjectKeys(
+getOptionValue('--experimental-specifier-resolution')==='node' ?
+legacyExtensionFormatMap :
+extensionFormatMap);
+
+// Only used when loading bare module specifiers from `node_modules`:
+constindexes=ArrayPrototypeMap(extensions,(ext)=>`index${ext}`);
+ArrayPrototypePush(indexes,'package.json');
+
+constmatch=StringPrototypeMatch(line,importRE);
+completeOn=match[1];
+constsubdir=match[2]||'';
+filter=completeOn;
+group=[];
+letpaths=[];
+if(completeOn==='.'){
+group=['./','../'];
+}elseif(completeOn==='..'){
+group=['../'];
+}elseif(RegExpPrototypeTest(/^\.\.?\//,completeOn)){
+paths=[process.cwd()];
+}else{
+paths=ArrayPrototypeSlice(module.paths);
+}
+
+ArrayPrototypeForEach(paths,(dir)=>{
+dir=path.resolve(dir,subdir);
+constisInNodeModules=path.basename(dir)==='node_modules';
+constdirents=gracefulReaddir(dir,{withFileTypes: true})||[];
+ArrayPrototypeForEach(dirents,(dirent)=>{
+const{ name }=dirent;
+if(RegExpPrototypeTest(versionedFileNamesRe,name)||
+name==='.npm'){
+// Exclude versioned names that 'npm' installs.
+return;
+}
+
+if(!dirent.isDirectory()){
+constextension=path.extname(name);
+if(StringPrototypeIncludes(extensions,extension)){
+ArrayPrototypePush(group,`${subdir}${name}`);
+}
+return;
+}
+
+ArrayPrototypePush(group,`${subdir}${name}/`);
+if(!subdir&&isInNodeModules){
+constabsolute=path.resolve(dir,name);
+constsubfiles=gracefulReaddir(absolute)||[];
+if(ArrayPrototypeSome(subfiles,(subfile)=>{
+returnArrayPrototypeIncludes(indexes,subfile);
+})){
+ArrayPrototypePush(group,`${subdir}${name}`);
+}
+}
+});
+});
+
+if(group.length){
+ArrayPrototypePush(completionGroups,group);
+}
+
+if(!subdir){
+ArrayPrototypePush(completionGroups,_builtinLibs,nodeSchemeBuiltinLibs);
+}
 }elseif(RegExpPrototypeTest(fsAutoCompleteRE,line)&&
 this.allowBlockingCompletions){
 ({0: completionGroups,1: completeOn}=completeFSFunctions(line));

test/parallel/test-repl-autocomplete.js

@@ -103,6 +103,9 @@ const tests = [
 yield'require("./';
 yieldTABULATION;
 yieldSIGINT;
+yield'import("./';
+yieldTABULATION;
+yieldSIGINT;
 yield'Array.proto';
 yieldRIGHT;
 yield'.pu';

test/parallel/test-repl-tab-complete-import.js

@@ -0,0 +1,158 @@
+'use strict';
+
+constcommon=require('../common');
+constArrayStream=require('../common/arraystream');
+constfixtures=require('../common/fixtures');
+constassert=require('assert');
+const{ builtinModules }=require('module');
+constpublicModules=builtinModules.filter(
+(lib)=>!lib.startsWith('_')&&!lib.includes('/'),
+);
+
+if(!common.isMainThread)
+common.skip('process.chdir is not available in Workers');
+
+// We have to change the directory to ../fixtures before requiring repl
+// in order to make the tests for completion of node_modules work properly
+// since repl modifies module.paths.
+process.chdir(fixtures.fixturesDir);
+
+constrepl=require('repl');
+
+constputIn=newArrayStream();
+consttestMe=repl.start({
+prompt: '',
+input: putIn,
+output: process.stdout,
+allowBlockingCompletions: true
+});
+
+// Some errors are passed to the domain, but do not callback
+testMe._domain.on('error',assert.ifError);
+
+// Tab complete provides built in libs for import()
+testMe.complete('import(\'',common.mustCall((error,data)=>{
+assert.strictEqual(error,null);
+publicModules.forEach((lib)=>{
+assert(
+data[0].includes(lib)&&data[0].includes(`node:${lib}`),
+`${lib} not found`,
+);
+});
+constnewModule='foobar';
+assert(!builtinModules.includes(newModule));
+repl.builtinModules.push(newModule);
+testMe.complete('import(\'',common.mustCall((_,[modules])=>{
+assert.strictEqual(data[0].length+1,modules.length);
+assert(modules.includes(newModule)&&
+!modules.includes(`node:${newModule}`));
+}));
+}));
+
+testMe.complete("import\t( 'n",common.mustCall((error,data)=>{
+assert.strictEqual(error,null);
+assert.strictEqual(data.length,2);
+assert.strictEqual(data[1],'n');
+constcompletions=data[0];
+// import(...) completions include `node:` URL modules:
+publicModules.forEach((lib,index)=>
+assert.strictEqual(completions[index],`node:${lib}`));
+assert.strictEqual(completions[publicModules.length],'');
+// There is only one Node.js module that starts with n:
+assert.strictEqual(completions[publicModules.length+1],'net');
+assert.strictEqual(completions[publicModules.length+2],'');
+// It's possible to pick up non-core modules too
+completions.slice(publicModules.length+3).forEach((completion)=>{
+assert.match(completion,/^n/);
+});
+}));
+
+{
+constexpected=['@nodejsscope','@nodejsscope/'];
+// Import calls should handle all types of quotation marks.
+for(constquotationMarkof["'",'"','`']){
+putIn.run(['.clear']);
+testMe.complete('import(`@nodejs',common.mustCall((err,data)=>{
+assert.strictEqual(err,null);
+assert.deepStrictEqual(data,[expected,'@nodejs']);
+}));
+
+putIn.run(['.clear']);
+// Completions should not be greedy in case the quotation ends.
+constinput=`import(${quotationMark}@nodejsscope${quotationMark}`;
+testMe.complete(input,common.mustCall((err,data)=>{
+assert.strictEqual(err,null);
+assert.deepStrictEqual(data,[[],undefined]);
+}));
+}
+}
+
+{
+putIn.run(['.clear']);
+// Completions should find modules and handle whitespace after the opening
+// bracket.
+testMe.complete('import \t("no_ind',common.mustCall((err,data)=>{
+assert.strictEqual(err,null);
+assert.deepStrictEqual(data,[['no_index','no_index/'],'no_ind']);
+}));
+}
+
+// Test tab completion for import() relative to the current directory
+{
+putIn.run(['.clear']);
+
+constcwd=process.cwd();
+process.chdir(__dirname);
+
+['import(\'.','import(".'].forEach((input)=>{
+testMe.complete(input,common.mustCall((err,data)=>{
+assert.strictEqual(err,null);
+assert.strictEqual(data.length,2);
+assert.strictEqual(data[1],'.');
+assert.strictEqual(data[0].length,2);
+assert.ok(data[0].includes('./'));
+assert.ok(data[0].includes('../'));
+}));
+});
+
+['import(\'..','import("..'].forEach((input)=>{
+testMe.complete(input,common.mustCall((err,data)=>{
+assert.strictEqual(err,null);
+assert.deepStrictEqual(data,[['../'],'..']);
+}));
+});
+
+['./','./test-'].forEach((path)=>{
+[`import('${path}`,`import("${path}`].forEach((input)=>{
+testMe.complete(input,common.mustCall((err,data)=>{
+assert.strictEqual(err,null);
+assert.strictEqual(data.length,2);
+assert.strictEqual(data[1],path);
+assert.ok(data[0].includes('./test-repl-tab-complete.js'));
+}));
+});
+});
+
+['../parallel/','../parallel/test-'].forEach((path)=>{
+[`import('${path}`,`import("${path}`].forEach((input)=>{
+testMe.complete(input,common.mustCall((err,data)=>{
+assert.strictEqual(err,null);
+assert.strictEqual(data.length,2);
+assert.strictEqual(data[1],path);
+assert.ok(data[0].includes('../parallel/test-repl-tab-complete.js'));
+}));
+});
+});
+
+{
+constpath='../fixtures/repl-folder-extensions/f';
+testMe.complete(`import('${path}`,common.mustSucceed((data)=>{
+assert.strictEqual(data.length,2);
+assert.strictEqual(data[1],path);
+assert.ok(data[0].includes(
+'../fixtures/repl-folder-extensions/foo.js/'));
+}));
+}
+
+process.chdir(cwd);
+}