@topcli/prompts 0.1.1 → 1.0.0

package/README.md

@@ -27,23 +27,28 @@ $ yarn add @topcli/prompts
 You can locally run `node ./demo.js`
 
 ```js
-import { prompt, confirm, select } from '@topcli/prompts'
+import { prompt, confirm, select } from '@topcli/prompts';
 
-const kTestRunner = ['node', 'tap', 'tape', 'vitest', 'mocha', 'ava']
+const kTestRunner = ['node', 'tap', 'tape', 'vitest', 'mocha', 'ava'];
 
-const name = await prompt('Project name ?')
-const runner = await select('Choose a test runner', { choices: kTestRunner, maxVisible: 5 })
-const isCLI = await confirm('Your project is a CLI ?', { initial: true })
+const name = await prompt('Project name ?');
+const runner = await select('Choose a test runner', {
+  choices: kTestRunner,
+  maxVisible: 5
+});
+const isCLI = await confirm('Your project is a CLI ?', {
+  initial: true
+});
 
-console.log(name, runner, isCLI)
+console.log(name, runner, isCLI);^
 ```
 
 ## API
 
-### `prompt()`
+### `question()`
 
 ```ts
-prompt(message: string, options?: PromptOptions): Promise<string>
+question(message: string, options?: PromptOptions): Promise<string>
 ```
 
 Simple prompt, similar to `rl.question()` with an improved UI.
@@ -52,14 +57,26 @@ Use `options.validators` to handle user input.
 **Example**
 
 ```js
-const packageName = await prompt('Package name', {
+const packageName = await question('Package name', {
   validators: [
     {
       validate: (value) => !existsSync(join(process.cwd(), value)),
       error: (value) => `Folder ${value} already exists`
     }
   ]
-})
+});
+```
+
+**This package provide some validators for common usage**
+
+- required
+
+```js
+import { prompt, required } from "@topcli/prompts";
+
+const name = await prompt("What's your name ?", {
+  validators: [required()]
+});
 ```
 
 ### `select()`

package/index.d.ts

@@ -1,8 +1,10 @@
 export interface PromptOptions {
-  validators?: {
-    validate: (input: string) => boolean;
-    error: (input: string) => string;
-  }[];
+  validators?: Validator[];
+}
+
+export interface Validator {
+  validate: (input: string) => boolean;
+  error: (input?: string) => string;
 }
 
 export interface Choice {
@@ -21,6 +23,8 @@ export interface ConfirmOptions {
   initial?: boolean;
 }
 
-export function prompt(message: string, options?: PromptOptions): Promise<string>;
+export function question(message: string, options?: PromptOptions): Promise<string>;
 export function select(message: string, options: SelectOptions): Promise<string>;
 export function confirm(message: string, options?: ConfirmOptions): Promise<string>;
+
+export function required(): Validator;

package/index.js

@@ -1,12 +1,13 @@
 // Import Internal Dependencies
 import { ConfirmPrompt } from "./src/confirm-prompt.js";
 import { SelectPrompt } from "./src/select-prompt.js";
-import { TextPrompt } from "./src/text-prompt.js";
+import { QuestionPrompt } from "./src/question-prompt.js";
+import { required } from "./src/validators.js";
 
-export async function prompt(message, options = {}) {
-  const textPrompt = new TextPrompt(message, options);
+export async function question(message, options = {}) {
+  const questionPrompt = new QuestionPrompt(message, options);
 
-  return textPrompt.question();
+  return questionPrompt.question();
 }
 
 export async function select(message, options) {
@@ -20,3 +21,5 @@ export async function confirm(message, options) {
 
   return confirmPrompt.confirm();
 }
+
+export { required };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@topcli/prompts",
-  "version": "0.1.1",
+  "version": "1.0.0",
   "description": "Node.js user input library for command-line interfaces.",
   "scripts": {
     "test": "node --loader=esmock --test ./test/**.test.js",

package/src/{text-prompt.js → question-prompt.js}

@@ -9,7 +9,7 @@ import stripAnsi from "strip-ansi";
 import { AbstractPrompt } from "./abstract-prompt.js";
 import { SYMBOLS } from "./constants.js";
 
-export class TextPrompt extends AbstractPrompt {
+export class QuestionPrompt extends AbstractPrompt {
   #validators;
 
   constructor(message, options = {}) {

package/src/validators.js

@@ -0,0 +1,6 @@
+export function required() {
+  return {
+    validate: (input) => input !== "",
+    error: () => "required"
+  };
+}