Add ability to allow custom enquirer editors

I’m currently using this function inspired by (copied from) the prompt method:

   function createCustomPrompt(task, Prompt, options) {
     task.prompt = true;
     let buffer = Buffer.alloc(64);
  
     const outputStream = through((data) => {
       buffer += data;
  
       // eslint-disable-next-line no-control-regex
       const deleteMultiLineRegexp = new RegExp(/.*(\u001b\[[0-9]*G|\u0007).*/m);          12
       if (deleteMultiLineRegexp.test(buffer.toString())) {
         buffer = Buffer.alloc(64);
        } else {
          task.output = buffer.toString();
        }
      });

      Object.assign(options, { stdout: outputStream });
      return new Prompt(options);
    }

With for example the enquirer-editor like this:

import EditorPrompt from 'enquirer-editor';
import { Manager } from 'listr2';

const manager = new Manager();
manager.add({
  title: 'Editor',
  task: async (_, task) => {
    const prompt = createCustomPrompt(task, EditorPrompt, { type: 'editor', message: 'Please Fill' });
    const message = await prompt.run();
  }
})
manager.runAll();

This works quite well, I was just wondering, @cenk1cenk2 do you think there’s a way to incorporate this into listr2 somehow? Or maybe make the prompt method from TaskWrapper more versatile to accept custom prompt classes?

[cenk1cenk2]

So this seems like a good enough solution for me what do you think?

You pass the class of the EditorPrompt directly to the type section and pass the options in the same way.

Unfortunately, there is no type checking for the options since it can be anything but that can be done manually I preassume with as.

manager.add([
   {
     title: 'Custom prompt test',
     task: async (ctx, task): Promise<void> => {
       ctx.testInput = await task.prompt(EditorPrompt, {
         message: 'Please write a short bio of at least 3 lines',
         initial: 'Start writing!',
         validate: (response): boolean | string => {
           if (response.split('\n').length < 4) {
             return 'The bio must be at least 3 lines.'
           }
           return true
         }
       })
     }
   },
   {
     title: 'Dump',
     task: (ctx, task): void => {
       task.output = ctx.testInput
     },
     persistentOutput: true
   }
 ])

 try {
   ctx = await manager.runAll()
 // eslint-disable-next-line no-empty
 } catch (e){

 }

[cenk1cenk2]

I merged it with v.1.3.7. But just tested basic functionality with the example.ts again, needs more testing.