feat: implement new package prompt and new cli

Author: MinhOmega

package.json

@@ -6,16 +6,15 @@
   "license": "MIT",
   "main": "./lib/src/index.js",
   "dependencies": {
+    "@inquirer/prompts": "^5.5.0",
     "date-fns": "2.28.0",
     "gaxios": "5.0.0",
-    "ora": "5.4.1",
-    "prompts": "2.4.2"
+    "ora": "5.4.1"
   },
   "devDependencies": {
     "@release-it/conventional-changelog": "^8.0.2",
     "@types/jest": "27.5.0",
     "@types/node": "16.11.7",
-    "@types/prompts": "2.0.14",
     "@typescript-eslint/eslint-plugin": "5.22.0",
     "@typescript-eslint/parser": "5.22.0",
     "eslint": "8.14.0",
@@ -27,7 +26,7 @@
     "release-it": "^17.6.0",
     "ts-jest": "28.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "4.6.4"
+    "typescript": "5.6.2"
   },
   "scripts": {
     "build": "tsc",
@@ -54,14 +53,14 @@
       "commitMessage": "chore: release ${version}",
       "tagName": "v${version}",
       "commitMode": "direct",
-      "push": true
+      "push": true,
+      "branch": "release-candidate"
     },
     "npm": {
       "publish": true
     },
     "github": {
-      "release": true,
-      "web": true
+      "release": true
     },
     "plugins": {
       "@release-it/conventional-changelog": {
@@ -71,7 +70,7 @@
     }
   },
   "bin": {
-    "npm-increaser-downloads": "lib/src/cli.js"
+    "nid": "lib/src/cli.js"
   },
   "directories": {
     "lib": "lib"

src/cli/prompts.spec.ts

@@ -1,10 +1,12 @@
-import prompts from "prompts";
+import { input, number } from '@inquirer/prompts';
 import { getPackageName, getNumberOfDownloads, getMaxConcurrentDownloads, getDownloadTimeout, getConfigFromCli } from "./prompts";
 import { Config } from "../models/config.model";
 
-// Mock the prompts module
-jest.mock("prompts");
-const mockPrompts = prompts as jest.MockedFunction<typeof prompts>;
+// Mock the @inquirer/prompts module
+jest.mock('@inquirer/prompts', () => ({
+  input: jest.fn(),
+  number: jest.fn(),
+}));
 
 describe("cli prompts", () => {
   beforeEach(() => {
@@ -13,42 +15,42 @@ describe("cli prompts", () => {
 
   describe("getPackageName", () => {
     it("should return the package name when prompted", async () => {
-      mockPrompts.mockResolvedValue({ value: "test-package" });
+      (input as jest.Mock).mockResolvedValue("test-package");
       const result = await getPackageName();
       expect(result).toBe("test-package");
     });
   });
 
   describe("getNumberOfDownloads", () => {
     it("should return the number of downloads when prompted", async () => {
-      mockPrompts.mockResolvedValue({ value: 1000 });
+      (number as jest.Mock).mockResolvedValue(1000);
       const result = await getNumberOfDownloads();
       expect(result).toBe(1000);
     });
   });
 
   describe("getMaxConcurrentDownloads", () => {
     it("should return the max concurrent downloads when prompted", async () => {
-      mockPrompts.mockResolvedValue({ value: 300 });
+      (number as jest.Mock).mockResolvedValue(300);
       const result = await getMaxConcurrentDownloads();
       expect(result).toBe(300);
     });
   });
 
   describe("getDownloadTimeout", () => {
     it("should return the download timeout when prompted", async () => {
-      mockPrompts.mockResolvedValue({ value: 3000 });
+      (number as jest.Mock).mockResolvedValue(3000);
       const result = await getDownloadTimeout();
       expect(result).toBe(3000);
     });
   });
 
   describe("getConfigFromCli", () => {
     it("should return a complete config object when all prompts are answered", async () => {
-      mockPrompts.mockResolvedValueOnce({ value: "test-package" })
-        .mockResolvedValueOnce({ value: 1000 })
-        .mockResolvedValueOnce({ value: 300 })
-        .mockResolvedValueOnce({ value: 3000 });
+      (input as jest.Mock).mockResolvedValueOnce("test-package");
+      (number as jest.Mock).mockResolvedValueOnce(1000)
+        .mockResolvedValueOnce(300)
+        .mockResolvedValueOnce(3000);
 
       const expectedConfig: Config = {
         packageName: "test-package",

src/cli/prompts.ts

@@ -1,59 +1,39 @@
-import prompts, { Answers } from "prompts";
-
+import { input, number } from '@inquirer/prompts';
 import { Config } from "../models/config.model";
-
 import { validateNumbers, validatePackageName } from "./validators";
 
-// `prompts` package uses generics which accepts string literal values and then uses those values as types
-// This means I have to ensure I use a string literal type that matches a string literal value
-const PROMPT_NAME = "value";
-type PromptType = "value";
-
 export const getPackageName = async (): Promise<string> => {
-  const promptData: Answers<PromptType> = await prompts({
-    name: PROMPT_NAME,
-    type: "text",
+  return input({
     message: "Package name: ",
     validate: (name: string) => validatePackageName(name),
   });
-
-  return promptData[PROMPT_NAME];
 };
 
 export const getNumberOfDownloads = async (): Promise<number> => {
-  const promptData: Answers<PromptType> = await prompts({
-    name: PROMPT_NAME,
-    type: "number",
+  const result = await number({
     message: "Number of downloads: ",
-    initial: 1000,
-    validate: (downloads: number) => validateNumbers(downloads),
+    default: 1000,
+    validate: (downloads: number | undefined) => validateNumbers(downloads),
   });
-
-  return promptData[PROMPT_NAME];
+  return result ?? 1000;
 };
 
 export const getMaxConcurrentDownloads = async (): Promise<number> => {
-  const promptData: Answers<PromptType> = await prompts({
-    name: PROMPT_NAME,
-    type: "number",
+  const result = await number({
     message: "Number of concurrent downloads: ",
-    initial: 300,
-    validate: (downloads: number) => validateNumbers(downloads),
+    default: 300,
+    validate: (downloads: number | undefined) => validateNumbers(downloads),
   });
-
-  return promptData[PROMPT_NAME];
+  return result ?? 300;
 };
 
 export const getDownloadTimeout = async (): Promise<number> => {
-  const promptData: Answers<PromptType> = await prompts({
-    name: PROMPT_NAME,
-    type: "number",
+  const result = await number({
     message: "Time to wait for a download to complete (in ms): ",
-    initial: 3000,
-    validate: (downloads: number) => validateNumbers(downloads),
+    default: 3000,
+    validate: (downloads: number | undefined) => validateNumbers(downloads),
   });
-
-  return promptData[PROMPT_NAME];
+  return result ?? 3000;
 };
 
 const getEmptyConfig = (): Config => {

src/spammer/spammer.ts

@@ -5,6 +5,7 @@ import { NpmjsResponse } from "../models/npmjs-response.model";
 import { NpmsioResponse } from "../models/npmsio-response.model";
 import { Stats } from "../models/stats.model";
 import { getEncodedPackageName, stripOrganisationFromPackageName } from "./utils";
+import { terminalSpinner } from "../cli/logger";
 
 export const getNpmsioResponse = async () => {
   const encodedPackageName: string = getEncodedPackageName(getConfig().packageName);
@@ -36,15 +37,18 @@ export const getNpmjsResponse = async (): Promise<NpmjsResponse> => {
 
 export const getVersionPackage = async (): Promise<string> => {
   try {
+    terminalSpinner.start();
     const npmioResponse = await getNpmsioResponse();
+    terminalSpinner.succeed(`Package version found on npms.io with version ${npmioResponse.collected.metadata.version}`);
     return npmioResponse.collected.metadata.version;
   } catch (npmioError) {
-    console.log("Package not found in npms.io, trying npmjs.com...");
+    terminalSpinner.text = "Package not found in npms.io, trying npmjs.com...";
     try {
       const npmjsResponse = await getNpmjsResponse();
-      console.log(`Package found on npmjs.com with version ${npmjsResponse.version}`);
+      terminalSpinner.succeed(`Package found on npmjs.com with version ${npmjsResponse.version}`);
       return npmjsResponse.version;
     } catch (npmjsError) {
+      terminalSpinner.fail("Failed to get package version");
       throw new Error(`Failed to get package version: ${npmioError.message}, ${npmjsError.message}`);
     }
   }