tinyinput 0.0.1 → 0.0.2

package/.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Code quality
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          persist-credentials: false
+      - name: Setup Biome
+        uses: biomejs/setup-biome@v2
+        with:
+          version: latest
+      - name: Run Biome
+        run: biome ci .

package/README.md

@@ -27,20 +27,73 @@ npm install tinyinput
 **Usage**
 -----
 
-To use TinyInput, simply import the library and call the `input()` function:
+To use TinyInput, import the library and call the `input()` function. By default, it returns a string and ensures the input is not empty.
+
 ```ts
 import { input } from 'tinyinput';
 
-async function main(){
-    const userInput = await input('Please enter your name: ', opt);
-    console.log(`Hello, ${userInput}!`);
-}
+async function main() {
+    // Basic usage (returns string)
+    const name = await input('What is your name? ');
+    console.log(`Hello, ${name}!`);
+
+    // Integer input (retries until valid)
+    const age = await input('How old are you? ', 'int');
+    console.log(`Next year you will be ${age + 1}`);
+
+    // Float input (retries until valid)
+    const price = await input('Enter price: ', 'float');
+    console.log(`Total with tax: ${(price * 1.15).toFixed(2)}`);
+
+    // Password input (hides typing)
+    const password = await input('Enter password: ', 'password');
+    console.log('Securely received password');
 
-main()
+    // Email validation
+    const email = await input("Enter email: ", "email");
+    console.log(`Updating record for ${email}`);
 
-//opt can be "int" | "float" | "string"
+    // Confirmation (returns boolean)
+    const save = await confirm("Save changes?");
+    if (save) {
+        console.log("Saved!");
+    }
+
+    // Selection (returns the string choice)
+    const color = await select("Pick a color", ["Red", "Green", "Blue"]);
+    console.log(`You chose ${color}`);
+}
+
+main();
 ```
 
+**API Reference**
+-----------
+
+### `input(question, opt)`
+
+The main function for reading input. Returns a `Promise<string | number>`.
+
+*   **question** (string): The prompt to show.
+*   **opt** (string, optional):
+    *   `"string"` (default): Returns trimmed, non-empty string.
+    *   `"int"`: Parses and returns a valid integer.
+    *   `"float"`: Parses and returns a valid number.
+    *   `"password"`: Hides input while typing.
+    *   `"email"`: Validates email format.
+
+### `confirm(question, defaultValue?)`
+
+Simplified helper for yes/no questions. Returns a `Promise<boolean>`.
+
+*   **defaultValue** (boolean, optional): Defaults to `true`. Used if the user just presses Enter.
+
+### `select(question, choices)`
+
+Displays a numbered list of choices. Returns a `Promise<string>`.
+
+*   **choices** (string[]): A non-empty array of options to choose from.
+
 **Technologies**
 -------------
 

package/biome.json

@@ -0,0 +1,34 @@
+{
+	"$schema": "https://biomejs.dev/schemas/2.3.13/schema.json",
+	"vcs": {
+		"enabled": true,
+		"clientKind": "git",
+		"useIgnoreFile": true
+	},
+	"files": {
+		"includes": ["**", "!!**/dist"]
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "tab"
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "double"
+		}
+	},
+	"assist": {
+		"enabled": true,
+		"actions": {
+			"source": {
+				"organizeImports": "on"
+			}
+		}
+	}
+}

package/dist/index.d.mts

@@ -1,5 +1,7 @@
-type Opt = "int" | "float" | "string";
+type Opt = "int" | "float" | "string" | "password" | "email";
 
-declare function input(question: string, opt: Opt): Promise<string | number>;
+declare function input(question: string, opt?: Opt): Promise<string | number>;
+declare function confirm(question: string, defaultValue?: boolean): Promise<boolean>;
+declare function select(question: string, choices: string[]): Promise<string>;
 
-export { input };
+export { confirm, input, select };

package/dist/index.d.ts

@@ -1,5 +1,7 @@
-type Opt = "int" | "float" | "string";
+type Opt = "int" | "float" | "string" | "password" | "email";
 
-declare function input(question: string, opt: Opt): Promise<string | number>;
+declare function input(question: string, opt?: Opt): Promise<string | number>;
+declare function confirm(question: string, defaultValue?: boolean): Promise<boolean>;
+declare function select(question: string, choices: string[]): Promise<string>;
 
-export { input };
+export { confirm, input, select };

package/dist/index.js

@@ -1,59 +1,2 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  input: () => input
-});
-module.exports = __toCommonJS(index_exports);
-var import_promises = require("readline/promises");
-async function input(question, opt) {
-  const r1 = (0, import_promises.createInterface)({
-    input: process.stdin,
-    output: process.stdout
-  });
-  let value;
-  let parse;
-  while (true) {
-    value = await r1.question(question);
-    r1.close();
-    value = value.trim();
-    if (opt === "int") {
-      parse = parseInt(value, 10);
-      if (!Number.isNaN(parse)) break;
-      console.log("Please enter a valid integer");
-    } else if (opt === "float") {
-      parse = parseFloat(value);
-      if (!Number.isNaN(value)) break;
-      console.log("Please enter a valid number");
-    } else {
-      if (value.length > 0) {
-        parse = value;
-        break;
-      }
-      console.log("Please enter a non-empty string.");
-    }
-  }
-  return parse;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  input
-});
+"use strict";var a=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var p=Object.getOwnPropertyNames;var m=Object.prototype.hasOwnProperty;var g=(r,e)=>{for(var s in e)a(r,s,{get:e[s],enumerable:!0})},d=(r,e,s,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let t of p(e))!m.call(r,t)&&t!==s&&a(r,t,{get:()=>e[t],enumerable:!(n=f(e,t))||n.enumerable});return r};var w=r=>d(a({},"__esModule",{value:!0}),r);var P={};g(P,{confirm:()=>b,input:()=>y,select:()=>N});module.exports=w(P);var l=require("readline/promises"),u=require("stream");async function y(r,e="string"){let s=!1,n=new u.Writable({write:(o,i,c)=>{s||process.stdout.write(o,i),c()}}),t=(0,l.createInterface)({input:process.stdin,output:n,terminal:!0});try{for(;;){e==="password"&&(process.stdout.write(r),s=!0);let o=await t.question(e==="password"?"":r);if(e==="password"&&(s=!1,process.stdout.write(`
+`)),o=o.trim(),e==="int"){let i=parseInt(o,10);if(!Number.isNaN(i))return i;console.log("Please enter a valid integer")}else if(e==="float"){let i=parseFloat(o);if(!Number.isNaN(i))return i;console.log("Please enter a valid number")}else if(e==="email"){if(/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(o))return o;console.log("Please enter a valid email address")}else{if(o.length>0)return o;console.log(e==="password"?"Password cannot be empty":"Please enter a non-empty string.")}}}finally{t.close()}}async function b(r,e=!0){let s=(0,l.createInterface)({input:process.stdin,output:process.stdout});try{let n=e?" [Y/n] ":" [y/N] ";for(;;){let t=(await s.question(r+n)).toLowerCase().trim();if(t==="")return e;if(t==="y"||t==="yes"||t==="true")return!0;if(t==="n"||t==="no"||t==="false")return!1;console.log("Please enter 'y' or 'n'")}}finally{s.close()}}async function N(r,e){if(e.length===0)throw new Error("Choices array cannot be empty");let s=(0,l.createInterface)({input:process.stdin,output:process.stdout});try{console.log(r);for(let n=0;n<e.length;n++)console.log(`${n+1}) ${e[n]}`);for(;;){let n=(await s.question("Select an option (number): ")).trim(),t=parseInt(n,10)-1;if(!Number.isNaN(t)&&t>=0&&t<e.length)return e[t];console.log(`Please enter a number between 1 and ${e.length}`)}}finally{s.close()}}0&&(module.exports={confirm,input,select});

package/dist/index.mjs

@@ -1,34 +1,2 @@
-// src/index.ts
-import { createInterface } from "readline/promises";
-async function input(question, opt) {
-  const r1 = createInterface({
-    input: process.stdin,
-    output: process.stdout
-  });
-  let value;
-  let parse;
-  while (true) {
-    value = await r1.question(question);
-    r1.close();
-    value = value.trim();
-    if (opt === "int") {
-      parse = parseInt(value, 10);
-      if (!Number.isNaN(parse)) break;
-      console.log("Please enter a valid integer");
-    } else if (opt === "float") {
-      parse = parseFloat(value);
-      if (!Number.isNaN(value)) break;
-      console.log("Please enter a valid number");
-    } else {
-      if (value.length > 0) {
-        parse = value;
-        break;
-      }
-      console.log("Please enter a non-empty string.");
-    }
-  }
-  return parse;
-}
-export {
-  input
-};
+import{createInterface as l}from"readline/promises";import{Writable as u}from"stream";async function g(i,e="string"){let n=!1,r=new u({write:(s,o,a)=>{n||process.stdout.write(s,o),a()}}),t=l({input:process.stdin,output:r,terminal:!0});try{for(;;){e==="password"&&(process.stdout.write(i),n=!0);let s=await t.question(e==="password"?"":i);if(e==="password"&&(n=!1,process.stdout.write(`
+`)),s=s.trim(),e==="int"){let o=parseInt(s,10);if(!Number.isNaN(o))return o;console.log("Please enter a valid integer")}else if(e==="float"){let o=parseFloat(s);if(!Number.isNaN(o))return o;console.log("Please enter a valid number")}else if(e==="email"){if(/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(s))return s;console.log("Please enter a valid email address")}else{if(s.length>0)return s;console.log(e==="password"?"Password cannot be empty":"Please enter a non-empty string.")}}}finally{t.close()}}async function d(i,e=!0){let n=l({input:process.stdin,output:process.stdout});try{let r=e?" [Y/n] ":" [y/N] ";for(;;){let t=(await n.question(i+r)).toLowerCase().trim();if(t==="")return e;if(t==="y"||t==="yes"||t==="true")return!0;if(t==="n"||t==="no"||t==="false")return!1;console.log("Please enter 'y' or 'n'")}}finally{n.close()}}async function w(i,e){if(e.length===0)throw new Error("Choices array cannot be empty");let n=l({input:process.stdin,output:process.stdout});try{console.log(i);for(let r=0;r<e.length;r++)console.log(`${r+1}) ${e[r]}`);for(;;){let r=(await n.question("Select an option (number): ")).trim(),t=parseInt(r,10)-1;if(!Number.isNaN(t)&&t>=0&&t<e.length)return e[t];console.log(`Please enter a number between 1 and ${e.length}`)}}finally{n.close()}}export{d as confirm,g as input,w as select};

package/package.json

@@ -1,26 +1,30 @@
 {
-  "name": "tinyinput",
-  "version": "0.0.1",
-  "description": "A simple library that takes user input the same way it is done in python.",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "scripts": {
-    "build": "tsup"
-  },
-  "repository": {
-    "url": "https://github.com/walonCode/tinyinput/"
-  },
-  "keywords": [
-    "input",
-    "stdin",
-    "stdout"
-  ],
-  "author": "Mohamed Lamin Walon-Jalloh",
-  "license": "MIT",
-  "devDependencies": {
-    "@types/node": "^24.3.0",
-    "tsup": "^8.5.0",
-    "typescript": "^5.9.2"
-  }
+	"name": "tinyinput",
+	"version": "0.0.2",
+	"description": "A simple library that takes user input the same way it is done in python.",
+	"main": "./dist/index.js",
+	"module": "./dist/index.mjs",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsup",
+		"test": "vitest run",
+		"lint-format": "biome check --write --unsafe"
+	},
+	"repository": {
+		"url": "https://github.com/walonCode/tinyinput/"
+	},
+	"keywords": [
+		"input",
+		"stdin",
+		"stdout"
+	],
+	"author": "Mohamed Lamin Walon-Jalloh",
+	"license": "MIT",
+	"devDependencies": {
+		"@biomejs/biome": "2.3.13",
+		"@types/node": "^24.3.0",
+		"tsup": "^8.5.0",
+		"typescript": "^5.9.2",
+		"vitest": "^4.0.18"
+	}
 }

package/test/index.test.ts

@@ -0,0 +1,143 @@
+import * as readline from "node:readline/promises";
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import { confirm, input, select } from "../src/index";
+
+// Mock readline/promises
+vi.mock("readline/promises", () => {
+	return {
+		createInterface: vi.fn(),
+	};
+});
+
+describe("tinyinput", () => {
+	let mockRl: any;
+
+	beforeEach(() => {
+		vi.clearAllMocks();
+		mockRl = {
+			question: vi.fn(),
+			close: vi.fn(),
+		};
+		(readline.createInterface as any).mockReturnValue(mockRl);
+	});
+
+	describe("input", () => {
+		it("should return a string when opt is 'string'", async () => {
+			mockRl.question.mockResolvedValueOnce("hello");
+			const result = await input("Question?", "string");
+			expect(result).toBe("hello");
+			expect(mockRl.question).toHaveBeenCalledWith("Question?");
+			expect(mockRl.close).toHaveBeenCalled();
+		});
+
+		it("should return an integer when opt is 'int'", async () => {
+			mockRl.question.mockResolvedValueOnce("42");
+			const result = await input("Age?", "int");
+			expect(result).toBe(42);
+			expect(mockRl.close).toHaveBeenCalled();
+		});
+
+		it("should return a float when opt is 'float'", async () => {
+			mockRl.question.mockResolvedValueOnce("3.14");
+			const result = await input("Pi?", "float");
+			expect(result).toBe(3.14);
+			expect(mockRl.close).toHaveBeenCalled();
+		});
+
+		it("should retry if invalid integer is provided", async () => {
+			mockRl.question
+				.mockResolvedValueOnce("abc") // Invalid
+				.mockResolvedValueOnce("10"); // Valid
+
+			const result = await input("Number?", "int");
+			expect(result).toBe(10);
+			expect(mockRl.question).toHaveBeenCalledTimes(2);
+		});
+
+		it("should retry if empty string is provided when opt is 'string'", async () => {
+			mockRl.question
+				.mockResolvedValueOnce("") // Invalid
+				.mockResolvedValueOnce("   ") // Invalid (trimmed)
+				.mockResolvedValueOnce("Valid"); // Valid
+
+			const result = await input("Name?", "string");
+			expect(result).toBe("Valid");
+			expect(mockRl.question).toHaveBeenCalledTimes(3);
+		});
+
+		it("should default to 'string' if opt is not provided", async () => {
+			mockRl.question.mockResolvedValueOnce("default value");
+			const result = await input("Prompt?");
+			expect(result).toBe("default value");
+		});
+
+		it("should return a trimmed string for email if valid", async () => {
+			mockRl.question.mockResolvedValueOnce(" test@example.com ");
+			const result = await input("Email?", "email");
+			expect(result).toBe("test@example.com");
+		});
+
+		it("should retry if invalid email is provided", async () => {
+			mockRl.question
+				.mockResolvedValueOnce("invalid-email")
+				.mockResolvedValueOnce("valid@email.com");
+
+			const result = await input("Email?", "email");
+			expect(result).toBe("valid@email.com");
+			expect(mockRl.question).toHaveBeenCalledTimes(2);
+		});
+
+		it("should return password if non-empty", async () => {
+			mockRl.question.mockResolvedValueOnce("secret123");
+			const result = await input("Password:", "password");
+			expect(result).toBe("secret123");
+		});
+
+		it("should retry if empty password is provided", async () => {
+			mockRl.question
+				.mockResolvedValueOnce("")
+				.mockResolvedValueOnce("password123");
+
+			const result = await input("Password:", "password");
+			expect(result).toBe("password123");
+			expect(mockRl.question).toHaveBeenCalledTimes(2);
+		});
+	});
+
+	describe("confirm", () => {
+		it("should return true for 'y'", async () => {
+			mockRl.question.mockResolvedValueOnce("y");
+			const result = await confirm("Sure?");
+			expect(result).toBe(true);
+		});
+
+		it("should return false for 'n'", async () => {
+			mockRl.question.mockResolvedValueOnce("n");
+			const result = await confirm("Sure?");
+			expect(result).toBe(false);
+		});
+
+		it("should return default value for empty input", async () => {
+			mockRl.question.mockResolvedValueOnce("");
+			const result = await confirm("Sure?", true);
+			expect(result).toBe(true);
+		});
+	});
+
+	describe("select", () => {
+		it("should return the chosen option", async () => {
+			mockRl.question.mockResolvedValueOnce("2");
+			const result = await select("Choose:", ["A", "B", "C"]);
+			expect(result).toBe("B");
+		});
+
+		it("should retry if index is out of bounds", async () => {
+			mockRl.question
+				.mockResolvedValueOnce("5") // Invalid
+				.mockResolvedValueOnce("1"); // Valid
+			const result = await select("Choose:", ["A", "B", "C"]);
+			expect(result).toBe("A");
+			expect(mockRl.question).toHaveBeenCalledTimes(2);
+		});
+	});
+});