@sap-ux/inquirer-common 0.2.0
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/LICENSE +201 -0
- package/README.md +14 -0
- package/dist/i18n.d.ts +14 -0
- package/dist/i18n.js +45 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +19 -0
- package/dist/prompts/separator.d.ts +36 -0
- package/dist/prompts/separator.js +48 -0
- package/dist/prompts/utility.d.ts +30 -0
- package/dist/prompts/utility.js +105 -0
- package/dist/translations/inquirer-common.i18n.json +8 -0
- package/dist/types.d.ts +65 -0
- package/dist/types.js +3 -0
- package/package.json +46 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# @sap-ux/inquirer-common
|
|
2
|
+
|
|
3
|
+
Commonly used shared functionality that supports prompting. Currently used by inquirer modules for example `@sap-ux/ui5-application-inquirer`, `@sap-ux/ui5-library-inquirer`. For example, choice searching and UI5 choice grouping. Add functionality that may be used by multiple prompting modules to prompte re-use.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## License
|
|
7
|
+
|
|
8
|
+
Read [License](./LICENSE).
|
|
9
|
+
|
|
10
|
+
## Keywords
|
|
11
|
+
inquirer
|
|
12
|
+
SAP
|
|
13
|
+
UI5
|
|
14
|
+
prompt
|
package/dist/i18n.d.ts
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { TOptions } from 'i18next';
|
|
2
|
+
/**
|
|
3
|
+
* Initialize i18next with the translations for this module.
|
|
4
|
+
*/
|
|
5
|
+
export declare function initI18nInquirerCommon(): Promise<void>;
|
|
6
|
+
/**
|
|
7
|
+
* Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
|
|
8
|
+
*
|
|
9
|
+
* @param key i18n key
|
|
10
|
+
* @param options additional options
|
|
11
|
+
* @returns {string} localized string stored for the given key
|
|
12
|
+
*/
|
|
13
|
+
export declare function t(key: string, options?: TOptions): string;
|
|
14
|
+
//# sourceMappingURL=i18n.d.ts.map
|
package/dist/i18n.js
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
3
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
4
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
5
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
6
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
7
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
8
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
9
|
+
});
|
|
10
|
+
};
|
|
11
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
12
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
13
|
+
};
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.t = exports.initI18nInquirerCommon = void 0;
|
|
16
|
+
const i18next_1 = __importDefault(require("i18next"));
|
|
17
|
+
const inquirer_common_i18n_json_1 = __importDefault(require("./translations/inquirer-common.i18n.json"));
|
|
18
|
+
const inquirerCommonI18nNamespace = 'inquirer-common';
|
|
19
|
+
/**
|
|
20
|
+
* Initialize i18next with the translations for this module.
|
|
21
|
+
*/
|
|
22
|
+
function initI18nInquirerCommon() {
|
|
23
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
24
|
+
yield i18next_1.default.init({ lng: 'en', fallbackLng: 'en' }, () => i18next_1.default.addResourceBundle('en', inquirerCommonI18nNamespace, inquirer_common_i18n_json_1.default));
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
exports.initI18nInquirerCommon = initI18nInquirerCommon;
|
|
28
|
+
/**
|
|
29
|
+
* Helper function facading the call to i18next. Unless a namespace option is provided the local namespace will be used.
|
|
30
|
+
*
|
|
31
|
+
* @param key i18n key
|
|
32
|
+
* @param options additional options
|
|
33
|
+
* @returns {string} localized string stored for the given key
|
|
34
|
+
*/
|
|
35
|
+
function t(key, options) {
|
|
36
|
+
if (!(options === null || options === void 0 ? void 0 : options.ns)) {
|
|
37
|
+
options = Object.assign(options !== null && options !== void 0 ? options : {}, { ns: inquirerCommonI18nNamespace });
|
|
38
|
+
}
|
|
39
|
+
return i18next_1.default.t(key, options);
|
|
40
|
+
}
|
|
41
|
+
exports.t = t;
|
|
42
|
+
initI18nInquirerCommon().catch(() => {
|
|
43
|
+
// Needed for lint
|
|
44
|
+
});
|
|
45
|
+
//# sourceMappingURL=i18n.js.map
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./prompts/utility"), exports);
|
|
18
|
+
__exportStar(require("./types"), exports);
|
|
19
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Separator object. This is a copy of `inquirer@8.2.6` Separator class. Since this is the only implementation needed
|
|
3
|
+
* from `inquirer` we have implemented our own to avoid a heavy dependency.
|
|
4
|
+
*
|
|
5
|
+
* Used to space/separate choices group
|
|
6
|
+
*
|
|
7
|
+
* @class
|
|
8
|
+
* @param {string} line Separation line content (facultative)
|
|
9
|
+
*/
|
|
10
|
+
export declare class Separator {
|
|
11
|
+
type: string;
|
|
12
|
+
line: string;
|
|
13
|
+
/**
|
|
14
|
+
* Create a Separator instance.
|
|
15
|
+
*
|
|
16
|
+
* @param line the separator line
|
|
17
|
+
*/
|
|
18
|
+
constructor(line: string);
|
|
19
|
+
/**
|
|
20
|
+
* Stringify separator.
|
|
21
|
+
*
|
|
22
|
+
* @returns {string} the separator display string
|
|
23
|
+
*/
|
|
24
|
+
toString(): string;
|
|
25
|
+
/**
|
|
26
|
+
* Helper function returning false if object is a separator.
|
|
27
|
+
*
|
|
28
|
+
* @param {object} obj object to test against
|
|
29
|
+
* @param obj.type the object type
|
|
30
|
+
* @returns {boolean} `false` if object is a separator
|
|
31
|
+
*/
|
|
32
|
+
static exclude(obj: {
|
|
33
|
+
type: string;
|
|
34
|
+
}): boolean;
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=separator.d.ts.map
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.Separator = void 0;
|
|
7
|
+
const chalk_1 = __importDefault(require("chalk"));
|
|
8
|
+
const figures_1 = __importDefault(require("figures"));
|
|
9
|
+
/**
|
|
10
|
+
* Separator object. This is a copy of `inquirer@8.2.6` Separator class. Since this is the only implementation needed
|
|
11
|
+
* from `inquirer` we have implemented our own to avoid a heavy dependency.
|
|
12
|
+
*
|
|
13
|
+
* Used to space/separate choices group
|
|
14
|
+
*
|
|
15
|
+
* @class
|
|
16
|
+
* @param {string} line Separation line content (facultative)
|
|
17
|
+
*/
|
|
18
|
+
class Separator {
|
|
19
|
+
/**
|
|
20
|
+
* Create a Separator instance.
|
|
21
|
+
*
|
|
22
|
+
* @param line the separator line
|
|
23
|
+
*/
|
|
24
|
+
constructor(line) {
|
|
25
|
+
this.type = 'separator';
|
|
26
|
+
this.line = chalk_1.default.dim(line || new Array(15).join(figures_1.default.line));
|
|
27
|
+
}
|
|
28
|
+
/**
|
|
29
|
+
* Stringify separator.
|
|
30
|
+
*
|
|
31
|
+
* @returns {string} the separator display string
|
|
32
|
+
*/
|
|
33
|
+
toString() {
|
|
34
|
+
return this.line;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Helper function returning false if object is a separator.
|
|
38
|
+
*
|
|
39
|
+
* @param {object} obj object to test against
|
|
40
|
+
* @param obj.type the object type
|
|
41
|
+
* @returns {boolean} `false` if object is a separator
|
|
42
|
+
*/
|
|
43
|
+
static exclude(obj) {
|
|
44
|
+
return obj.type !== 'separator';
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
exports.Separator = Separator;
|
|
48
|
+
//# sourceMappingURL=separator.js.map
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { ListChoiceOptions } from 'inquirer';
|
|
2
|
+
import { type UI5Version } from '@sap-ux/ui5-info';
|
|
3
|
+
import type { UI5VersionChoice } from '../types';
|
|
4
|
+
import { Separator } from './separator';
|
|
5
|
+
/**
|
|
6
|
+
* Get the UI5 themes as prompt choices applicable for the specified UI5 version.
|
|
7
|
+
*
|
|
8
|
+
* @param ui5Version - UI5 semantic version
|
|
9
|
+
* @returns UI5 themes as list choice options
|
|
10
|
+
*/
|
|
11
|
+
export declare function getUI5ThemesChoices(ui5Version?: string): ListChoiceOptions[];
|
|
12
|
+
/**
|
|
13
|
+
* Finds the search value in the provided list using `fuzzy` search.
|
|
14
|
+
*
|
|
15
|
+
* @param searchVal - the string to search for
|
|
16
|
+
* @param searchList - the list in which to search by fuzzy matching the choice name
|
|
17
|
+
* @returns Inquirer choices filtered by the search value
|
|
18
|
+
*/
|
|
19
|
+
export declare function searchChoices(searchVal: string, searchList: ListChoiceOptions[]): ListChoiceOptions[];
|
|
20
|
+
/**
|
|
21
|
+
* Creates a list of UI5 Versions prompt choices, adding additional maintenance info for use in prompts
|
|
22
|
+
* and grouping according to maintenance status.
|
|
23
|
+
*
|
|
24
|
+
* @param versions ui5Versions
|
|
25
|
+
* @param includeSeparators Include a separator to visually identify groupings, if false then grouping info is included in each entry as additional name text
|
|
26
|
+
* @param defaultChoice optional, provides an additional version choice entry that is added as the first entry in the version choices and sets as the default
|
|
27
|
+
* @returns Array of ui5 version choices and separators if applicable, grouped by maintenance state
|
|
28
|
+
*/
|
|
29
|
+
export declare function ui5VersionsGrouped(versions: UI5Version[], includeSeparators?: boolean, defaultChoice?: UI5VersionChoice): (UI5VersionChoice | Separator)[];
|
|
30
|
+
//# sourceMappingURL=utility.d.ts.map
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
|
|
14
|
+
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
15
|
+
}) : function(o, v) {
|
|
16
|
+
o["default"] = v;
|
|
17
|
+
});
|
|
18
|
+
var __importStar = (this && this.__importStar) || function (mod) {
|
|
19
|
+
if (mod && mod.__esModule) return mod;
|
|
20
|
+
var result = {};
|
|
21
|
+
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
|
|
22
|
+
__setModuleDefault(result, mod);
|
|
23
|
+
return result;
|
|
24
|
+
};
|
|
25
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
+
exports.ui5VersionsGrouped = exports.searchChoices = exports.getUI5ThemesChoices = void 0;
|
|
27
|
+
const fuzzy = __importStar(require("fuzzy"));
|
|
28
|
+
const i18n_1 = require("../i18n");
|
|
29
|
+
const ui5_info_1 = require("@sap-ux/ui5-info");
|
|
30
|
+
const separator_1 = require("./separator");
|
|
31
|
+
/**
|
|
32
|
+
* Get the UI5 themes as prompt choices applicable for the specified UI5 version.
|
|
33
|
+
*
|
|
34
|
+
* @param ui5Version - UI5 semantic version
|
|
35
|
+
* @returns UI5 themes as list choice options
|
|
36
|
+
*/
|
|
37
|
+
function getUI5ThemesChoices(ui5Version) {
|
|
38
|
+
const themes = (0, ui5_info_1.getUi5Themes)(ui5Version);
|
|
39
|
+
return themes.map((theme) => ({
|
|
40
|
+
name: theme.label,
|
|
41
|
+
value: theme.id
|
|
42
|
+
}));
|
|
43
|
+
}
|
|
44
|
+
exports.getUI5ThemesChoices = getUI5ThemesChoices;
|
|
45
|
+
/**
|
|
46
|
+
* Finds the search value in the provided list using `fuzzy` search.
|
|
47
|
+
*
|
|
48
|
+
* @param searchVal - the string to search for
|
|
49
|
+
* @param searchList - the list in which to search by fuzzy matching the choice name
|
|
50
|
+
* @returns Inquirer choices filtered by the search value
|
|
51
|
+
*/
|
|
52
|
+
function searchChoices(searchVal, searchList) {
|
|
53
|
+
return searchVal && searchList
|
|
54
|
+
? fuzzy
|
|
55
|
+
.filter(searchVal, searchList, {
|
|
56
|
+
// Only `choice.name` searching is supported, as this is what is presented to the user by Inquirer
|
|
57
|
+
extract: (choice) => { var _a; return (_a = choice.name) !== null && _a !== void 0 ? _a : ''; }
|
|
58
|
+
})
|
|
59
|
+
.map((el) => el.original)
|
|
60
|
+
: searchList;
|
|
61
|
+
}
|
|
62
|
+
exports.searchChoices = searchChoices;
|
|
63
|
+
/**
|
|
64
|
+
* Creates a list of UI5 Versions prompt choices, adding additional maintenance info for use in prompts
|
|
65
|
+
* and grouping according to maintenance status.
|
|
66
|
+
*
|
|
67
|
+
* @param versions ui5Versions
|
|
68
|
+
* @param includeSeparators Include a separator to visually identify groupings, if false then grouping info is included in each entry as additional name text
|
|
69
|
+
* @param defaultChoice optional, provides an additional version choice entry that is added as the first entry in the version choices and sets as the default
|
|
70
|
+
* @returns Array of ui5 version choices and separators if applicable, grouped by maintenance state
|
|
71
|
+
*/
|
|
72
|
+
function ui5VersionsGrouped(versions, includeSeparators = false, defaultChoice) {
|
|
73
|
+
if (!versions || (Array.isArray(versions) && versions.length === 0)) {
|
|
74
|
+
return [];
|
|
75
|
+
}
|
|
76
|
+
const maintChoices = versions
|
|
77
|
+
.filter((v) => v.maintained === true)
|
|
78
|
+
.map((mainV) => ({
|
|
79
|
+
name: !includeSeparators
|
|
80
|
+
? `${mainV.version} - (${(0, i18n_1.t)('ui5VersionLabels.maintained')} ${(0, i18n_1.t)('ui5VersionLabels.version', {
|
|
81
|
+
count: 1
|
|
82
|
+
})})`
|
|
83
|
+
: mainV.version,
|
|
84
|
+
value: mainV.version
|
|
85
|
+
}));
|
|
86
|
+
const notMaintChoices = versions
|
|
87
|
+
.filter((v) => v.maintained === false)
|
|
88
|
+
.map((mainV) => ({
|
|
89
|
+
name: !includeSeparators
|
|
90
|
+
? `${mainV.version} - (${(0, i18n_1.t)('ui5VersionLabels.outOfMaintenance')} ${(0, i18n_1.t)('ui5VersionLabels.version', { count: 1 })})`
|
|
91
|
+
: mainV.version,
|
|
92
|
+
value: mainV.version
|
|
93
|
+
}));
|
|
94
|
+
if (includeSeparators) {
|
|
95
|
+
maintChoices.unshift(new separator_1.Separator(`${(0, i18n_1.t)('ui5VersionLabels.maintained')} ${(0, i18n_1.t)('ui5VersionLabels.version', { count: 0 })}`));
|
|
96
|
+
notMaintChoices.unshift(new separator_1.Separator(`${(0, i18n_1.t)('ui5VersionLabels.outOfMaintenance')} ${(0, i18n_1.t)('ui5VersionLabels.version', { count: 0 })}`));
|
|
97
|
+
}
|
|
98
|
+
const versionChoices = [...maintChoices, ...notMaintChoices];
|
|
99
|
+
if (defaultChoice) {
|
|
100
|
+
versionChoices.unshift(defaultChoice);
|
|
101
|
+
}
|
|
102
|
+
return versionChoices;
|
|
103
|
+
}
|
|
104
|
+
exports.ui5VersionsGrouped = ui5VersionsGrouped;
|
|
105
|
+
//# sourceMappingURL=utility.js.map
|
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
import { type IMessageSeverity } from '@sap-devx/yeoman-ui-types';
|
|
2
|
+
import type { Answers, ConfirmQuestion as BaseConfirmQuestion, InputQuestion as BaseInputQuestion, ListQuestion as BaseListQuestion, ListChoiceOptions, PromptFunction, PromptModule, Question } from 'inquirer';
|
|
3
|
+
export interface UI5VersionChoice extends ListChoiceOptions {
|
|
4
|
+
/**
|
|
5
|
+
* UI5 semantic version
|
|
6
|
+
*/
|
|
7
|
+
value: string;
|
|
8
|
+
}
|
|
9
|
+
export interface InquirerAdapter {
|
|
10
|
+
/**
|
|
11
|
+
* The prompt function
|
|
12
|
+
*/
|
|
13
|
+
prompt: PromptFunction;
|
|
14
|
+
/**
|
|
15
|
+
* Plugins will be registered on this prompt module if required
|
|
16
|
+
*/
|
|
17
|
+
promptModule?: PromptModule;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* To be replaced when YUI specific types are available from `"@sap-devx/yeoman-ui-types`.
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
export interface GuiOptions {
|
|
24
|
+
/**
|
|
25
|
+
* Provides a tooltip with a YUI prompt
|
|
26
|
+
*/
|
|
27
|
+
hint?: string;
|
|
28
|
+
/**
|
|
29
|
+
* A valid prompt answer is mandatory to progress with prompting
|
|
30
|
+
*/
|
|
31
|
+
mandatory?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* Defaults will be re-applied if a previous answer has changed
|
|
34
|
+
*/
|
|
35
|
+
applyDefaultWhenDirty?: boolean;
|
|
36
|
+
/**
|
|
37
|
+
* Indicate state in the left hand navigation panel in YUI
|
|
38
|
+
*/
|
|
39
|
+
breadcrumb?: boolean | string;
|
|
40
|
+
}
|
|
41
|
+
export type PromptSeverityMessage = (input?: unknown, previousAnswers?: Answers) => IMessageSeverity | undefined;
|
|
42
|
+
export type validate<T> = (input: any, answers?: T) => boolean | string | Promise<boolean | string>;
|
|
43
|
+
export type YUIQuestion<A extends Answers = Answers> = Question<A> & {
|
|
44
|
+
name: string;
|
|
45
|
+
guiOptions?: GuiOptions;
|
|
46
|
+
additionalMessages?: PromptSeverityMessage;
|
|
47
|
+
};
|
|
48
|
+
export interface FileBrowserQuestion<A extends Answers = Answers> extends BaseInputQuestion<A> {
|
|
49
|
+
name: YUIQuestion['name'];
|
|
50
|
+
guiType: 'file-browser' | 'folder-browser';
|
|
51
|
+
guiOptions?: YUIQuestion['guiOptions'];
|
|
52
|
+
}
|
|
53
|
+
export interface ListQuestion<A extends Answers = Answers> extends BaseListQuestion<A> {
|
|
54
|
+
name: YUIQuestion['name'];
|
|
55
|
+
guiOptions?: YUIQuestion['guiOptions'];
|
|
56
|
+
}
|
|
57
|
+
export interface ConfirmQuestion<A extends Answers = Answers> extends BaseConfirmQuestion<A> {
|
|
58
|
+
name: YUIQuestion['name'];
|
|
59
|
+
guiOptions?: YUIQuestion['guiOptions'];
|
|
60
|
+
}
|
|
61
|
+
export interface InputQuestion<A extends Answers = Answers> extends BaseInputQuestion<A> {
|
|
62
|
+
name: YUIQuestion['name'];
|
|
63
|
+
guiOptions?: YUIQuestion['guiOptions'];
|
|
64
|
+
}
|
|
65
|
+
//# sourceMappingURL=types.d.ts.map
|
package/dist/types.js
ADDED
package/package.json
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@sap-ux/inquirer-common",
|
|
3
|
+
"description": "Commonly used shared functionality and types to support inquirer modules.",
|
|
4
|
+
"version": "0.2.0",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/SAP/open-ux-tools.git",
|
|
8
|
+
"directory": "packages/inquirer-common"
|
|
9
|
+
},
|
|
10
|
+
"bugs": {
|
|
11
|
+
"url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Ainquirer-common"
|
|
12
|
+
},
|
|
13
|
+
"license": "Apache-2.0",
|
|
14
|
+
"main": "dist/index.js",
|
|
15
|
+
"files": [
|
|
16
|
+
"LICENSE",
|
|
17
|
+
"dist",
|
|
18
|
+
"!dist/*.map",
|
|
19
|
+
"!dist/**/*.map"
|
|
20
|
+
],
|
|
21
|
+
"dependencies": {
|
|
22
|
+
"fuzzy": "0.1.3",
|
|
23
|
+
"i18next": "23.5.1",
|
|
24
|
+
"chalk": "4.1.2",
|
|
25
|
+
"figures": "3.2.0",
|
|
26
|
+
"@sap-ux/ui5-info": "0.3.2"
|
|
27
|
+
},
|
|
28
|
+
"devDependencies": {
|
|
29
|
+
"@sap-devx/yeoman-ui-types": "1.14.4",
|
|
30
|
+
"@types/inquirer": "8.2.6"
|
|
31
|
+
},
|
|
32
|
+
"engines": {
|
|
33
|
+
"node": ">=18.x"
|
|
34
|
+
},
|
|
35
|
+
"scripts": {
|
|
36
|
+
"build": "tsc --build",
|
|
37
|
+
"clean": "rimraf --glob dist test/test-output coverage *.tsbuildinfo",
|
|
38
|
+
"watch": "tsc --watch",
|
|
39
|
+
"lint": "eslint . --ext .ts",
|
|
40
|
+
"lint:fix": "eslint . --ext .ts --fix",
|
|
41
|
+
"test": "jest --ci --forceExit --detectOpenHandles --colors --passWithNoTests",
|
|
42
|
+
"test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
|
|
43
|
+
"link": "pnpm link --global",
|
|
44
|
+
"unlink": "pnpm unlink --global"
|
|
45
|
+
}
|
|
46
|
+
}
|