feat: use adapter abstraction instead of inquirer (#890)

Author: mshima

lib/cli.js

@@ -2,6 +2,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import process from 'node:process';
+import {TerminalAdapter} from '@yeoman/adapter';
 import chalk from 'chalk';
 import updateNotifier from 'update-notifier';
 import yosay from 'yosay';
@@ -167,7 +168,8 @@ async function init() {
 }
 
 function runYo(env) {
-  const router = new Router(env);
+  const adapter = new TerminalAdapter();
+  const router = new Router({adapter, env});
   router.registerRoute('help', routes.help);
   router.registerRoute('update', routes.update);
   router.registerRoute('run', routes.run);

lib/router.js

@@ -14,9 +14,15 @@ import pkg from './utils/project-package.js';
  * @param  {Configstore} [conf] An optional config store instance
  */
 export default class Router {
-  constructor(env, config) {
+  /** @type {import('yeoman-environment').default} */
+  env;
+  /** @type {import('@yeoman/adapter').TerminalAdapter} */
+  adapter;
+
+  constructor({adapter, env, config}) {
     this.routes = {};
     this.env = env;
+    this.adapter = adapter ?? env.adapter;
     this.conf = config || new Configstore(pkg.name, {
       generatorRunCount: {},
     });

lib/routes/clear-config.js

@@ -4,6 +4,10 @@ import inquirer from 'inquirer';
 import globalConfig from '../utils/global-config.js';
 import {namespaceToName} from '../utils/namespace.js';
 
+/**
+ * @param {import('../router.js').default} app
+ * @returns
+ */
 export const clearConfig = async app => {
   const defaultChoices = [
     {
@@ -43,7 +47,7 @@ export const clearConfig = async app => {
     });
   }
 
-  return inquirer.prompt([{
+  return app.adapter.prompt([{
     name: 'whatNext',
     type: 'list',
     message: 'Which store would you like to clear?',

lib/routes/help.js

@@ -1,7 +1,10 @@
-import inquirer from 'inquirer';
 import open from 'open';
 
-export const help = async app => inquirer.prompt([{
+/**
+ * @param {import('../router.js').default} app
+ * @returns
+ */
+export const help = async app => app.adapter.prompt([{
   name: 'whereTo',
   type: 'list',
   message: 'Here are a few helpful resources.\n\nI will open the link you select in your browser for you',

lib/routes/home.js

@@ -5,6 +5,10 @@ import inquirer from 'inquirer';
 import {namespaceToName} from '../utils/namespace.js';
 import globalConfig from '../utils/global-config.js';
 
+/**
+ * @param {import('../router.js').default} app
+ * @returns
+ */
 export const home = async app => {
   const defaultChoices = [{
     name: 'Install a generator',
@@ -53,7 +57,7 @@ export const home = async app => {
   return fullname().then(name => {
     const allo = (name && _.isString(name)) ? `'Allo ${name.split(' ')[0]}! ` : '\'Allo! ';
 
-    return inquirer.prompt([{
+    return app.adapter.prompt([{
       name: 'whatNext',
       type: 'list',
       message: `${allo}What would you like to do?`,

lib/routes/install.js

@@ -1,7 +1,6 @@
 
 import _ from 'lodash';
 import chalk from 'chalk';
-import inquirer from 'inquirer';
 import spawn from 'cross-spawn';
 import sortOn from 'sort-on';
 import figures from 'figures';
@@ -29,7 +28,11 @@ const OFFICIAL_GENERATORS = new Set([
   'generator-webapp',
 ]);
 
-export const install = app => inquirer.prompt([{
+/**
+ * @param {import('../router.js').default} app
+ * @returns
+ */
+export const install = app => app.adapter.prompt([{
   name: 'searchTerm',
   message: 'Search npm for generators:',
 }]).then(answers => searchNpm(app, answers.searchTerm));
@@ -72,6 +75,10 @@ async function searchNpm(app, term) {
   return promptInstallOptions(app, sortOn(packages, ['official', 'name']));
 }
 
+/**
+ * @param {import('../router.js').default} app
+ * @returns
+ */
 function promptInstallOptions(app, choices) {
   let introMessage = 'Sorry, no results matches your search term';
 
@@ -92,7 +99,7 @@ function promptInstallOptions(app, choices) {
     }],
   }];
 
-  return inquirer.prompt(resultsPrompt).then(answer => {
+  return app.adapter.prompt(resultsPrompt).then(answer => {
     if (answer.toInstall === 'home' || answer.toInstall === 'install') {
       return app.navigate(answer.toInstall);
     }

lib/routes/update.js

@@ -1,5 +1,4 @@
 import chalk from 'chalk';
-import inquirer from 'inquirer';
 import spawn from 'cross-spawn';
 
 const successMessage = 'I\'ve just updated your generators. Remember, you can update\na specific generator with npm by running:\n'
@@ -17,7 +16,11 @@ function updateGenerators(app, pkgs) {
     .on('close', updateSuccess.bind(null, app));
 }
 
-export const update = app => inquirer.prompt([{
+/**
+ * @param {import('../router.js').default} app
+ * @returns
+ */
+export const update = app => app.adapter.prompt([{
   name: 'generators',
   message: 'Generators to update',
   type: 'checkbox',