@inquirer/prompts 5.2.0 → 5.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -22
- package/package.json +12 -12
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<img width="75px" height="75px" align="right" alt="Inquirer Logo" src="https://raw.githubusercontent.com/SBoudrias/Inquirer.js/
|
|
1
|
+
<img width="75px" height="75px" align="right" alt="Inquirer Logo" src="https://raw.githubusercontent.com/SBoudrias/Inquirer.js/main/assets/inquirer_readme.svg?sanitize=true" title="Inquirer.js"/>
|
|
2
2
|
|
|
3
3
|
# Inquirer
|
|
4
4
|
|
|
@@ -41,7 +41,7 @@ yarn add @inquirer/prompts
|
|
|
41
41
|
</table>
|
|
42
42
|
|
|
43
43
|
> [!NOTE]
|
|
44
|
-
> Inquirer recently underwent a rewrite from the ground up to reduce the package size and improve performance. The previous version of the package is still maintained (though not actively developed), and offered hundreds of community contributed prompts that might not have been migrated to the latest API. If this is what you're looking for, the [previous package is over here](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
44
|
+
> Inquirer recently underwent a rewrite from the ground up to reduce the package size and improve performance. The previous version of the package is still maintained (though not actively developed), and offered hundreds of community contributed prompts that might not have been migrated to the latest API. If this is what you're looking for, the [previous package is over here](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/inquirer).
|
|
45
45
|
|
|
46
46
|
# Usage
|
|
47
47
|
|
|
@@ -53,7 +53,7 @@ const answer = await input({ message: 'Enter your name' });
|
|
|
53
53
|
|
|
54
54
|
# Prompts
|
|
55
55
|
|
|
56
|
-
## [Input](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
56
|
+
## [Input](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/input)
|
|
57
57
|
|
|
58
58
|

|
|
59
59
|
|
|
@@ -61,9 +61,9 @@ const answer = await input({ message: 'Enter your name' });
|
|
|
61
61
|
import { input } from '@inquirer/prompts';
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
64
|
+
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/input) for usage example and options documentation.
|
|
65
65
|
|
|
66
|
-
## [Select](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
66
|
+
## [Select](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/select)
|
|
67
67
|
|
|
68
68
|

|
|
69
69
|
|
|
@@ -71,9 +71,9 @@ import { input } from '@inquirer/prompts';
|
|
|
71
71
|
import { select } from '@inquirer/prompts';
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
74
|
+
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/select) for usage example and options documentation.
|
|
75
75
|
|
|
76
|
-
## [Checkbox](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
76
|
+
## [Checkbox](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/checkbox)
|
|
77
77
|
|
|
78
78
|

|
|
79
79
|
|
|
@@ -81,9 +81,9 @@ import { select } from '@inquirer/prompts';
|
|
|
81
81
|
import { checkbox } from '@inquirer/prompts';
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
-
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
84
|
+
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/checkbox) for usage example and options documentation.
|
|
85
85
|
|
|
86
|
-
## [Confirm](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
86
|
+
## [Confirm](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/confirm)
|
|
87
87
|
|
|
88
88
|

|
|
89
89
|
|
|
@@ -91,9 +91,9 @@ import { checkbox } from '@inquirer/prompts';
|
|
|
91
91
|
import { confirm } from '@inquirer/prompts';
|
|
92
92
|
```
|
|
93
93
|
|
|
94
|
-
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
94
|
+
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/confirm) for usage example and options documentation.
|
|
95
95
|
|
|
96
|
-
## [Password](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
96
|
+
## [Password](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/password)
|
|
97
97
|
|
|
98
98
|

|
|
99
99
|
|
|
@@ -101,9 +101,9 @@ import { confirm } from '@inquirer/prompts';
|
|
|
101
101
|
import { password } from '@inquirer/prompts';
|
|
102
102
|
```
|
|
103
103
|
|
|
104
|
-
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
104
|
+
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/password) for usage example and options documentation.
|
|
105
105
|
|
|
106
|
-
## [Expand](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
106
|
+
## [Expand](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/expand)
|
|
107
107
|
|
|
108
108
|

|
|
109
109
|

|
|
@@ -112,9 +112,9 @@ import { password } from '@inquirer/prompts';
|
|
|
112
112
|
import { expand } from '@inquirer/prompts';
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
-
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
115
|
+
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/expand) for usage example and options documentation.
|
|
116
116
|
|
|
117
|
-
## [Editor](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
117
|
+
## [Editor](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/editor)
|
|
118
118
|
|
|
119
119
|
Launches an instance of the users preferred editor on a temporary file. Once the user exits their editor, the content of the temporary file is read as the answer. The editor used is determined by reading the $VISUAL or $EDITOR environment variables. If neither of those are present, the OS default is used (notepad on Windows, vim on Mac or Linux.)
|
|
120
120
|
|
|
@@ -122,9 +122,9 @@ Launches an instance of the users preferred editor on a temporary file. Once the
|
|
|
122
122
|
import { editor } from '@inquirer/prompts';
|
|
123
123
|
```
|
|
124
124
|
|
|
125
|
-
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
125
|
+
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/editor) for usage example and options documentation.
|
|
126
126
|
|
|
127
|
-
## [Number](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
127
|
+
## [Number](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/number)
|
|
128
128
|
|
|
129
129
|
Very similar to the `input` prompt, but with built-in number validation configuration option.
|
|
130
130
|
|
|
@@ -132,9 +132,9 @@ Very similar to the `input` prompt, but with built-in number validation configur
|
|
|
132
132
|
import { number } from '@inquirer/prompts';
|
|
133
133
|
```
|
|
134
134
|
|
|
135
|
-
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
135
|
+
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/number) for usage example and options documentation.
|
|
136
136
|
|
|
137
|
-
## [Raw List](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
137
|
+
## [Raw List](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/rawlist)
|
|
138
138
|
|
|
139
139
|

|
|
140
140
|
|
|
@@ -142,11 +142,11 @@ import { number } from '@inquirer/prompts';
|
|
|
142
142
|
import { rawlist } from '@inquirer/prompts';
|
|
143
143
|
```
|
|
144
144
|
|
|
145
|
-
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
145
|
+
[See documentation](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/rawlist) for usage example and options documentation.
|
|
146
146
|
|
|
147
147
|
# Create your own prompts
|
|
148
148
|
|
|
149
|
-
The [API documentation is over here](https://github.com/SBoudrias/Inquirer.js/tree/
|
|
149
|
+
The [API documentation is over here](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/core), and our [testing utilities here](https://github.com/SBoudrias/Inquirer.js/tree/main/packages/testing).
|
|
150
150
|
|
|
151
151
|
# Advanced usage
|
|
152
152
|
|
|
@@ -284,7 +284,7 @@ const answer = await confirm({ message: await getMessage() });
|
|
|
284
284
|
|
|
285
285
|
# Community prompts
|
|
286
286
|
|
|
287
|
-
If you created a cool prompt, [send us a PR adding it](https://github.com/SBoudrias/Inquirer.js/edit/
|
|
287
|
+
If you created a cool prompt, [send us a PR adding it](https://github.com/SBoudrias/Inquirer.js/edit/main/README.md) to the list below!
|
|
288
288
|
|
|
289
289
|
[**Interactive List Prompt**](https://github.com/pgibler/inquirer-interactive-list-prompt)<br/>
|
|
290
290
|
Select a choice either with arrow keys + Enter or by pressing a key associated with a choice.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@inquirer/prompts",
|
|
3
|
-
"version": "5.2.
|
|
3
|
+
"version": "5.2.1",
|
|
4
4
|
"description": "Inquirer prompts, combined in a single package",
|
|
5
5
|
"main": "./dist/cjs/index.js",
|
|
6
6
|
"typings": "./dist/cjs/types/index.d.ts",
|
|
@@ -77,20 +77,20 @@
|
|
|
77
77
|
}
|
|
78
78
|
},
|
|
79
79
|
"dependencies": {
|
|
80
|
-
"@inquirer/checkbox": "^2.4.
|
|
81
|
-
"@inquirer/confirm": "^3.1.
|
|
82
|
-
"@inquirer/editor": "^2.1.
|
|
83
|
-
"@inquirer/expand": "^2.1.
|
|
84
|
-
"@inquirer/input": "^2.2.
|
|
85
|
-
"@inquirer/number": "^1.0.
|
|
86
|
-
"@inquirer/password": "^2.1.
|
|
87
|
-
"@inquirer/rawlist": "^2.1.
|
|
88
|
-
"@inquirer/select": "^2.4.
|
|
80
|
+
"@inquirer/checkbox": "^2.4.1",
|
|
81
|
+
"@inquirer/confirm": "^3.1.16",
|
|
82
|
+
"@inquirer/editor": "^2.1.16",
|
|
83
|
+
"@inquirer/expand": "^2.1.16",
|
|
84
|
+
"@inquirer/input": "^2.2.3",
|
|
85
|
+
"@inquirer/number": "^1.0.4",
|
|
86
|
+
"@inquirer/password": "^2.1.16",
|
|
87
|
+
"@inquirer/rawlist": "^2.1.16",
|
|
88
|
+
"@inquirer/select": "^2.4.1"
|
|
89
89
|
},
|
|
90
90
|
"devDependencies": {
|
|
91
91
|
"@inquirer/type": "^1.5.0"
|
|
92
92
|
},
|
|
93
|
-
"homepage": "https://github.com/SBoudrias/Inquirer.js/blob/
|
|
93
|
+
"homepage": "https://github.com/SBoudrias/Inquirer.js/blob/main/packages/prompts/README.md",
|
|
94
94
|
"sideEffects": false,
|
|
95
|
-
"gitHead": "
|
|
95
|
+
"gitHead": "f2c4983dd390c6244fb4668a8e87c9e786e4326f"
|
|
96
96
|
}
|