firest commit
This commit is contained in:
wwweww
+22
@@ -0,0 +1,22 @@
|
||||
Copyright (c) 2025 Simon Boudrias
|
||||
|
||||
Permission is hereby granted, free of charge, to any person
|
||||
obtaining a copy of this software and associated documentation
|
||||
files (the "Software"), to deal in the Software without
|
||||
restriction, including without limitation the rights to use,
|
||||
copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the
|
||||
Software is furnished to do so, subject to the following
|
||||
conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
|
||||
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
|
||||
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
|
||||
OTHER DEALINGS IN THE SOFTWARE.
|
||||
+101
@@ -0,0 +1,101 @@
|
||||
# `@inquirer/input`
|
||||
|
||||
Interactive free text input component for command line interfaces. Supports validation, filtering, transformation, etc.
|
||||
|
||||
|
||||
|
||||
# Installation
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<th>npm</th>
|
||||
<th>yarn</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```sh
|
||||
npm install @inquirer/prompts
|
||||
```
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
```sh
|
||||
yarn add @inquirer/prompts
|
||||
```
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colSpan="2" align="center">Or</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
```sh
|
||||
npm install @inquirer/input
|
||||
```
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
```sh
|
||||
yarn add @inquirer/input
|
||||
```
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
# Usage
|
||||
|
||||
```js
|
||||
import { input } from '@inquirer/prompts';
|
||||
// Or
|
||||
// import input from '@inquirer/input';
|
||||
|
||||
const answer = await input({ message: 'Enter your name' });
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
| Property | Type | Required | Description |
|
||||
| ------------ | ----------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| message | `string` | yes | The question to ask |
|
||||
| default | `string` | no | Default value if no answer is provided; see the prefill option below for governing it's behaviour. |
|
||||
| prefill | `'tab' \| 'editable'` | no | Defaults to `'tab'`. If set to `'tab'`, pressing `backspace` will clear the default and pressing `tab` will inline the value for edits; If set to `'editable'`, the default value will already be inlined to edit. |
|
||||
| required | `boolean` | no | Defaults to `false`. If set to true, `undefined` (empty) will not be accepted for this. |
|
||||
| transformer | `(string, { isFinal: boolean }) => string` | no | Transform/Format the raw value entered by the user. Once the prompt is completed, `isFinal` will be `true`. This function is purely visual, modify the answer in your code if needed. |
|
||||
| validate | `string => boolean \| string \| Promise<boolean \| string>` | no | On submit, validate the filtered answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. |
|
||||
| pattern | `RegExp` | no | Regular expression to validate the input against. If the input doesn't match the pattern, validation will fail with the error message specified in `patternError`. |
|
||||
| patternError | `string` | no | Error message to display when the input doesn't match the `pattern`. Defaults to `'Invalid input'`. |
|
||||
| theme | [See Theming](#Theming) | no | Customize look of the prompt. |
|
||||
|
||||
## Theming
|
||||
|
||||
You can theme a prompt by passing a `theme` object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.
|
||||
|
||||
```ts
|
||||
type Theme = {
|
||||
prefix: string | { idle: string; done: string };
|
||||
spinner: {
|
||||
interval: number;
|
||||
frames: string[];
|
||||
};
|
||||
style: {
|
||||
answer: (text: string) => string;
|
||||
message: (text: string, status: 'idle' | 'done' | 'loading') => string;
|
||||
error: (text: string) => string;
|
||||
defaultAnswer: (text: string) => string;
|
||||
};
|
||||
validationFailureMode: 'keep' | 'clear';
|
||||
};
|
||||
```
|
||||
|
||||
`validationFailureMode` defines the behavior of the prompt when the value submitted is invalid. By default, we'll keep the value allowing the user to edit it. When the theme option is set to `clear`, we'll remove and reset to an empty string.
|
||||
|
||||
# License
|
||||
|
||||
Copyright (c) 2023 Simon Boudrias (twitter: [@vaxilart](https://twitter.com/Vaxilart))<br/>
|
||||
Licensed under the MIT license.
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
import { type Theme } from '@inquirer/core';
|
||||
import type { PartialDeep } from '@inquirer/type';
|
||||
type InputTheme = {
|
||||
validationFailureMode: 'keep' | 'clear';
|
||||
};
|
||||
type InputConfig = {
|
||||
message: string;
|
||||
default?: string;
|
||||
prefill?: 'tab' | 'editable';
|
||||
required?: boolean;
|
||||
transformer?: (value: string, { isFinal }: {
|
||||
isFinal: boolean;
|
||||
}) => string;
|
||||
validate?: (value: string) => boolean | string | Promise<string | boolean>;
|
||||
theme?: PartialDeep<Theme<InputTheme>>;
|
||||
pattern?: RegExp;
|
||||
patternError?: string;
|
||||
};
|
||||
declare const _default: import("@inquirer/type").Prompt<string, InputConfig>;
|
||||
export default _default;
|
||||
+97
@@ -0,0 +1,97 @@
|
||||
import { createPrompt, useState, useKeypress, useEffect, usePrefix, isBackspaceKey, isEnterKey, isTabKey, makeTheme, } from '@inquirer/core';
|
||||
const inputTheme = {
|
||||
validationFailureMode: 'keep',
|
||||
};
|
||||
export default createPrompt((config, done) => {
|
||||
const { prefill = 'tab' } = config;
|
||||
const theme = makeTheme(inputTheme, config.theme);
|
||||
const [status, setStatus] = useState('idle');
|
||||
const [defaultValue = '', setDefaultValue] = useState(config.default);
|
||||
const [errorMsg, setError] = useState();
|
||||
const [value, setValue] = useState('');
|
||||
const prefix = usePrefix({ status, theme });
|
||||
async function validate(value) {
|
||||
const { required, pattern, patternError = 'Invalid input' } = config;
|
||||
if (required && !value) {
|
||||
return 'You must provide a value';
|
||||
}
|
||||
if (pattern && !pattern.test(value)) {
|
||||
return patternError;
|
||||
}
|
||||
if (typeof config.validate === 'function') {
|
||||
return (await config.validate(value)) || 'You must provide a valid value';
|
||||
}
|
||||
return true;
|
||||
}
|
||||
useKeypress(async (key, rl) => {
|
||||
// Ignore keypress while our prompt is doing other processing.
|
||||
if (status !== 'idle') {
|
||||
return;
|
||||
}
|
||||
if (isEnterKey(key)) {
|
||||
const answer = value || defaultValue;
|
||||
setStatus('loading');
|
||||
const isValid = await validate(answer);
|
||||
if (isValid === true) {
|
||||
setValue(answer);
|
||||
setStatus('done');
|
||||
done(answer);
|
||||
}
|
||||
else {
|
||||
if (theme.validationFailureMode === 'clear') {
|
||||
setValue('');
|
||||
}
|
||||
else {
|
||||
// Reset the readline line value to the previous value. On line event, the value
|
||||
// get cleared, forcing the user to re-enter the value instead of fixing it.
|
||||
rl.write(value);
|
||||
}
|
||||
setError(isValid);
|
||||
setStatus('idle');
|
||||
}
|
||||
}
|
||||
else if (isBackspaceKey(key) && !value) {
|
||||
setDefaultValue(undefined);
|
||||
}
|
||||
else if (isTabKey(key) && !value) {
|
||||
setDefaultValue(undefined);
|
||||
rl.clearLine(0); // Remove the tab character.
|
||||
rl.write(defaultValue);
|
||||
setValue(defaultValue);
|
||||
}
|
||||
else {
|
||||
setValue(rl.line);
|
||||
setError(undefined);
|
||||
}
|
||||
});
|
||||
// If prefill is set to 'editable' cut out the default value and paste into current state and the user's cli buffer
|
||||
// They can edit the value immediately instead of needing to press 'tab'
|
||||
useEffect((rl) => {
|
||||
if (prefill === 'editable' && defaultValue) {
|
||||
rl.write(defaultValue);
|
||||
setValue(defaultValue);
|
||||
}
|
||||
}, []);
|
||||
const message = theme.style.message(config.message, status);
|
||||
let formattedValue = value;
|
||||
if (typeof config.transformer === 'function') {
|
||||
formattedValue = config.transformer(value, { isFinal: status === 'done' });
|
||||
}
|
||||
else if (status === 'done') {
|
||||
formattedValue = theme.style.answer(value);
|
||||
}
|
||||
let defaultStr;
|
||||
if (defaultValue && status !== 'done' && !value) {
|
||||
defaultStr = theme.style.defaultAnswer(defaultValue);
|
||||
}
|
||||
let error = '';
|
||||
if (errorMsg) {
|
||||
error = theme.style.error(errorMsg);
|
||||
}
|
||||
return [
|
||||
[prefix, message, defaultStr, formattedValue]
|
||||
.filter((v) => v !== undefined)
|
||||
.join(' '),
|
||||
error,
|
||||
];
|
||||
});
|
||||
+91
@@ -0,0 +1,91 @@
|
||||
{
|
||||
"name": "@inquirer/input",
|
||||
"version": "5.0.4",
|
||||
"description": "Inquirer input text prompt",
|
||||
"keywords": [
|
||||
"answer",
|
||||
"answers",
|
||||
"ask",
|
||||
"base",
|
||||
"cli",
|
||||
"command",
|
||||
"command-line",
|
||||
"confirm",
|
||||
"enquirer",
|
||||
"generate",
|
||||
"generator",
|
||||
"hyper",
|
||||
"input",
|
||||
"inquire",
|
||||
"inquirer",
|
||||
"interface",
|
||||
"iterm",
|
||||
"javascript",
|
||||
"menu",
|
||||
"node",
|
||||
"nodejs",
|
||||
"prompt",
|
||||
"promptly",
|
||||
"prompts",
|
||||
"question",
|
||||
"readline",
|
||||
"scaffold",
|
||||
"scaffolder",
|
||||
"scaffolding",
|
||||
"stdin",
|
||||
"stdout",
|
||||
"terminal",
|
||||
"tty",
|
||||
"ui",
|
||||
"yeoman",
|
||||
"yo",
|
||||
"zsh"
|
||||
],
|
||||
"homepage": "https://github.com/SBoudrias/Inquirer.js/blob/main/packages/input/README.md",
|
||||
"license": "MIT",
|
||||
"author": "Simon Boudrias <admin@simonboudrias.com>",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/SBoudrias/Inquirer.js.git"
|
||||
},
|
||||
"files": [
|
||||
"dist"
|
||||
],
|
||||
"type": "module",
|
||||
"sideEffects": false,
|
||||
"exports": {
|
||||
".": {
|
||||
"types": "./dist/index.d.ts",
|
||||
"default": "./dist/index.js"
|
||||
},
|
||||
"./package.json": "./package.json"
|
||||
},
|
||||
"publishConfig": {
|
||||
"access": "public"
|
||||
},
|
||||
"scripts": {
|
||||
"tsc": "tsc"
|
||||
},
|
||||
"dependencies": {
|
||||
"@inquirer/core": "^11.1.1",
|
||||
"@inquirer/type": "^4.0.3"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@inquirer/testing": "^3.0.4",
|
||||
"typescript": "^5.9.3"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"@types/node": ">=18"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"@types/node": {
|
||||
"optional": true
|
||||
}
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=23.5.0 || ^22.13.0 || ^21.7.0 || ^20.12.0"
|
||||
},
|
||||
"main": "./dist/index.js",
|
||||
"types": "./dist/index.d.ts",
|
||||
"gitHead": "99d00a9adc53be8b7edf5926b2ec4ba0b792f68f"
|
||||
}
|
||||
Reference in New Issue
Block a user