Merge pull request #229 from beakerandjake/feature/inquirer-update

Feature/inquirer update

Author: beakerandjake

CHANGELOG.md

@@ -10,7 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added support for 2023 to the config file ([#226](https://github.com/beakerandjake/advent-of-code-runner/issues/226))
 ### Fixed
 - Fix number of solvable problems to be 49 not 50 (day 25 only has one level) ([#224](https://github.com/beakerandjake/advent-of-code-runner/issues/224))
-
+### Changed
+- Replaced inquirer package with @inquirer/prompts, will reduce package size. ([#230](https://github.com/beakerandjake/advent-of-code-runner/issues/230))
 
 ## [1.3.6] - 2023-08-23
 ### Fixed

package-lock.json

@@ -33,6 +33,7 @@
   },
   "homepage": "https://github.com/beakerandjake/advent-of-code-runner",
   "dependencies": {
+    "@inquirer/prompts": "^3.3.0",
     "chalk": "^5.2.0",
     "commander": "^9.4.1",
     "date-fns": "^2.29.3",
@@ -41,7 +42,6 @@
     "dotenv": "^16.0.3",
     "fs-extra": "^11.1.0",
     "htmlparser2": "^8.0.1",
-    "inquirer": "^9.1.4",
     "ora": "^6.1.2",
     "table": "^6.8.1",
     "terminal-link": "^3.0.0",

package.json

@@ -1,22 +1,15 @@
-import inquirer from 'inquirer';
+import { confirm } from '@inquirer/prompts';
 
 /**
  * Creates a link which when invoked will ask the user the specified question.
  * The link will return a boolean value based on if the user answered yes to the question.
- * @param {Object} question - The question passed to inquirer
+ * @param {Object} confirmQuestion - The question passed to the confirm prompt
+ * @param {string} confirmQuestion.message - The question to ask
+ * @param {boolean} confirmQuestion.default - The default answer (true or false)
  */
-export const assertUserConfirmation = (question) => {
-  if (question == null) {
-    throw new Error('null or undefined question');
+export const assertUserConfirmation = async ({ confirmQuestion } = {}) => {
+  if (!confirmQuestion || !confirmQuestion.message) {
+    throw new Error('must specify a message');
   }
-
-  // create a variable for this fn instead of just returning the fn
-  // this gives the fn a .name property and makes debugging easier.
-  const _ = {
-    assertUserConfirmation: async () => {
-      const { confirmed } = await inquirer.prompt({ ...question, type: 'confirm' });
-      return confirmed;
-    },
-  };
-  return _.assertUserConfirmation;
+  return confirm(confirmQuestion);
 };

src/actions/assertUserConfirmation.js

@@ -1,20 +1,34 @@
-import inquirer from 'inquirer';
+import { confirm, select, password } from '@inquirer/prompts';
+
+/**
+ * Prompt the user with an inquirer question.
+ */
+const prompt = (type, args) => {
+  switch (type) {
+    case 'confirm':
+      return confirm(args);
+    case 'select':
+      return select(args);
+    case 'password':
+      return password(args);
+    default:
+      throw new Error(`unsupported question type: ${type}`);
+  }
+};
 
 /**
  * Creates a link which, when invoked will ask the user the specified questions.
  * The link will add the user answers to the args.
- * @param {Object[]} questions - The inquirer.js questions to ask the user
+ * @param {Object} questions - The inquirer.js questions to ask the user
  */
-export const getAnswersFromUser = (questions = []) => {
-  if (questions == null) {
+export const getAnswersFromUser = async ({ questions } = {}) => {
+  if (!questions) {
     throw new Error('null or undefined question');
   }
-
-  // create a variable for this fn instead of just returning the fn
-  // this gives the fn a .name property and makes debugging easier.
-  const _ = {
-    getAnswersFromUser: async () => ({ answers: await inquirer.prompt(questions) }),
-  };
-
-  return _.getAnswersFromUser;
+  const answers = {};
+  for (const [key, { type, ...args }] of Object.entries(questions)) {
+    // eslint-disable-next-line no-await-in-loop
+    answers[key] = await prompt(type, args);
+  }
+  return answers;
 };

src/actions/getAnswersFromUser.js

@@ -1,60 +1,52 @@
 import { Command } from 'commander';
-import { assertInitialized } from '../actions/assertInitialized.js';
-import { assertUserConfirmation } from '../actions/assertUserConfirmation.js';
-import { getAnswersFromUser } from '../actions/getAnswersFromUser.js';
-import { festiveEmoji, festiveStyle, printFestiveTitle } from '../festive.js';
+import { createChain } from '../actions/actionChain.js';
+import * as actions from '../actions/index.js';
+import { festiveStyle, printFestiveTitle } from '../festive.js';
 import { createDotEnv } from '../initialize/index.js';
-import { dotEnvExists } from '../validation/userFilesExist.js';
 import { logger } from '../logger.js';
+import { dotEnvExists } from '../validation/userFilesExist.js';
 
 /**
- * inquirer question which prompts the user for their auth token.
+ * inquirer questions which can be used to prompt the user to input their auth token.
  */
-/* istanbul ignore next */
 export const authTokenQuestion = {
   type: 'password',
-  name: 'authToken',
   message: festiveStyle(
     'Enter your advent of code authentication token (see README for help)'
   ),
-  prefix: festiveEmoji(),
+  mask: true,
   validate: (input) => (input ? true : 'Token cannot be empty!'),
-  filter: (input) => input.trim(),
 };
 
 /**
- * inquirer.js question which makes the user confirm the overwriting the .env file
+ * inquirer question which makes the user confirm the overwriting the .env file
  */
-const confirmOverwriteQuestion = {
-  type: 'confirm',
-  name: 'confirmed',
+const confirmQuestion = {
   message: festiveStyle(
     'It appears a .env file is already present, do you want to overwrite this file?'
   ),
   default: false,
-  prefix: festiveEmoji(),
 };
 
 /**
  * Updates or creates the .env file and writes the users auth token to it.
  * @private
  */
-export const auth = async () => {
-  // don't let the user run this command if they haven't ran the "init" command.
-  if (!(await assertInitialized())) {
-    return;
-  }
+export const authAction = async () => {
+  const actionChain = createChain([
+    actions.assertInitialized,
+    actions.and(dotEnvExists, actions.assertUserConfirmation),
+    actions.getAnswersFromUser,
+    createDotEnv,
+  ]);
 
-  // if there is already a .env file then ask users confirmation.
-  if (
-    (await dotEnvExists()) &&
-    !(await assertUserConfirmation(confirmOverwriteQuestion)())
-  ) {
-    return;
-  }
+  await actionChain({
+    confirmQuestion,
+    questions: {
+      authToken: authTokenQuestion,
+    },
+  });
 
-  const { answers } = await getAnswersFromUser([authTokenQuestion])();
-  await createDotEnv(answers);
   logger.festive(
     'Added auth token to the .env file, do not commit this file to source control'
   );
@@ -67,4 +59,4 @@ export const authCommand = new Command()
   .name('auth')
   .hook('preAction', printFestiveTitle)
   .description('Add or update the .env file with your advent of code auth token.')
-  .action(auth);
+  .action(authAction);

src/cli/auth.js

@@ -2,7 +2,7 @@ import { Command } from 'commander';
 import { createChainWithProgress } from '../actions/actionChainWithProgress.js';
 import { assertUserConfirmation, getAnswersFromUser } from '../actions/index.js';
 import { getConfigValue } from '../config.js';
-import { festiveEmoji, festiveStyle, printFestiveTitle } from '../festive.js';
+import { festiveStyle, printFestiveTitle } from '../festive.js';
 import {
   createDataFile,
   createDotEnv,
@@ -19,32 +19,26 @@ import { authTokenQuestion } from './auth.js';
 /**
  * inquirer.js question which makes the user confirm the initialize operation.
  */
-const confirmInitializeQuestion = {
+const confirmQuestion = {
   type: 'confirm',
-  name: 'confirmed',
   message: festiveStyle(
     'This directory is not empty! This operation will overwrite files, do you want to continue?'
   ),
   default: false,
-  prefix: festiveEmoji(),
 };
 
-/**
- * Array of inquirer questions which will be asked in order.
- * The answers will provide us all of the information we need to initialize.
- */
-const initializeQuestions = [
-  {
+const initializeQuestions = {
+  year: {
     // in future if list of years becomes too large the change to raw input.
-    type: 'list',
-    name: 'year',
+    type: 'select',
     message: festiveStyle('What year of advent of code are you doing?'),
-    prefix: festiveEmoji(),
-    choices: [...getConfigValue('aoc.validation.years')].reverse(),
+    choices: [...getConfigValue('aoc.validation.years')]
+      .reverse()
+      .map((year) => ({ value: year })),
     loop: false,
   },
-  authTokenQuestion,
-];
+  authToken: authTokenQuestion,
+};
 
 /**
  * A Link which creates all required files in the cwd.
@@ -67,15 +61,12 @@ const createFiles = async ({ answers }) => {
  */
 export const initializeAction = async () => {
   // if there are files in the cwd, get confirmation with the user that they want to proceed.
-  if (
-    !(await cwdIsEmpty()) &&
-    !(await assertUserConfirmation(confirmInitializeQuestion)())
-  ) {
+  if (!(await cwdIsEmpty()) && !(await assertUserConfirmation({ confirmQuestion }))) {
     return;
   }
 
   // get all the info we need in order to initialize.
-  const { answers } = await getAnswersFromUser(initializeQuestions)();
+  const answers = await getAnswersFromUser({ questions: initializeQuestions });
 
   // run initialize steps in an action chain that reports its progress to the user.
   const actionChain = createChainWithProgress(

src/cli/initialize.js

@@ -23,7 +23,11 @@ export const createDotEnv = async ({ authToken } = {}) => {
 
   const { source, dest } = getConfigValue('paths.templates.dotenv');
   const templateEnvFileContents = await readFile(source, { encoding: 'utf-8' });
-  const envFile = replaceTokens(envFileTokens, { authToken }, templateEnvFileContents);
+  const envFile = replaceTokens(
+    envFileTokens,
+    { authToken: authToken.trim() },
+    templateEnvFileContents
+  );
   logger.debug('saving .env file to: %s', dest);
   await outputFile(dest, envFile);
 };

src/initialize/createDotEnv.js

@@ -1,14 +1,12 @@
 import { describe, jest, test, afterEach } from '@jest/globals';
 
 // setup mocks
-const mockPrompt = jest.fn();
-jest.unstable_mockModule('inquirer', () => ({
-  default: {
-    prompt: mockPrompt,
-  },
+jest.unstable_mockModule('@inquirer/prompts', () => ({
+  confirm: jest.fn(),
 }));
 
 // import after setting up mocks
+const { confirm } = await import('@inquirer/prompts');
 const { assertUserConfirmation } = await import(
   '../../src/actions/assertUserConfirmation.js'
 );
@@ -18,26 +16,40 @@ describe('assertUserConfirmation()', () => {
     jest.resetAllMocks();
   });
 
-  test.each([null, undefined])('throws if question is %s', (question) => {
-    expect(() => assertUserConfirmation(question)).toThrow();
+  test.each([
+    null,
+    undefined,
+    {},
+    { confirmQuestion: null },
+    { confirmQuestion: {} },
+    { confirmQuestion: { message: '' } },
+    { confirmQuestion: { message: null } },
+  ])('throws if arg is %s', async (args) => {
+    await expect(async () => assertUserConfirmation(args)).rejects.toThrow();
   });
 
-  test('builds and returns function', () => {
-    const result = assertUserConfirmation({});
-    expect(result).toBeInstanceOf(Function);
+  test('invokes confirm only once', async () => {
+    await assertUserConfirmation({ confirmQuestion: { message: 'hi' } });
+    expect(confirm).toHaveBeenCalledTimes(1);
   });
 
-  test('returns true if user confirms', async () => {
-    mockPrompt.mockResolvedValue({ confirmed: true });
-    const fn = assertUserConfirmation({});
-    const result = await fn();
+  test('passes args to confirm', async () => {
+    const input = { confirmQuestion: { message: 'hi' } };
+    await assertUserConfirmation(input);
+    expect(confirm).toBeCalledWith(input.confirmQuestion);
+  });
+
+  test('returns true if confirm returns true', async () => {
+    confirm.mockResolvedValue(true);
+    const input = { confirmQuestion: { message: 'hi' } };
+    const result = await assertUserConfirmation(input);
     expect(result).toBe(true);
   });
 
-  test('returns false if user does not confirm', async () => {
-    mockPrompt.mockResolvedValue({ confirmed: false });
-    const fn = assertUserConfirmation({});
-    const result = await fn();
+  test('returns false if confirm returns false', async () => {
+    confirm.mockResolvedValue(false);
+    const input = { confirmQuestion: { message: 'hi' } };
+    const result = await assertUserConfirmation(input);
     expect(result).toBe(false);
   });
 });

tests/actions/assertUserConfirmation.test.js

@@ -16,8 +16,8 @@ describe('executeUserSolution()', () => {
     jest.resetAllMocks();
   });
 
-  test.each([null, undefined])('throws if question is %s', async (question) => {
-    await expect(async () => executeUserSolution(question)).rejects.toThrow();
+  test.each([null, undefined])('throws if provided %s', async (args) => {
+    await expect(async () => executeUserSolution(args)).rejects.toThrow();
   });
 
   test('returns results', async () => {