1 | import {dirname} from 'node:path';
|
2 | import {fileURLToPath} from 'node:url';
|
3 | import buildParserOptions from 'minimist-options';
|
4 | import parseArguments from 'yargs-parser';
|
5 | import camelCaseKeys from 'camelcase-keys';
|
6 | import decamelize from 'decamelize';
|
7 | import decamelizeKeys from 'decamelize-keys';
|
8 | import trimNewlines from 'trim-newlines';
|
9 | import redent from 'redent';
|
10 | import {readPackageUpSync} from 'read-pkg-up';
|
11 | import hardRejection from 'hard-rejection';
|
12 | import normalizePackageData from 'normalize-package-data';
|
13 |
|
14 | const isFlagMissing = (flagName, definedFlags, receivedFlags, input) => {
|
15 | const flag = definedFlags[flagName];
|
16 | let isFlagRequired = true;
|
17 |
|
18 | if (typeof flag.isRequired === 'function') {
|
19 | isFlagRequired = flag.isRequired(receivedFlags, input);
|
20 | if (typeof isFlagRequired !== 'boolean') {
|
21 | throw new TypeError(`Return value for isRequired callback should be of type boolean, but ${typeof isFlagRequired} was returned.`);
|
22 | }
|
23 | }
|
24 |
|
25 | if (typeof receivedFlags[flagName] === 'undefined') {
|
26 | return isFlagRequired;
|
27 | }
|
28 |
|
29 | return flag.isMultiple && receivedFlags[flagName].length === 0 && isFlagRequired;
|
30 | };
|
31 |
|
32 | const getMissingRequiredFlags = (flags, receivedFlags, input) => {
|
33 | const missingRequiredFlags = [];
|
34 | if (typeof flags === 'undefined') {
|
35 | return [];
|
36 | }
|
37 |
|
38 | for (const flagName of Object.keys(flags)) {
|
39 | if (flags[flagName].isRequired && isFlagMissing(flagName, flags, receivedFlags, input)) {
|
40 | missingRequiredFlags.push({key: flagName, ...flags[flagName]});
|
41 | }
|
42 | }
|
43 |
|
44 | return missingRequiredFlags;
|
45 | };
|
46 |
|
47 | const reportMissingRequiredFlags = missingRequiredFlags => {
|
48 | console.error(`Missing required flag${missingRequiredFlags.length > 1 ? 's' : ''}`);
|
49 | for (const flag of missingRequiredFlags) {
|
50 | console.error(`\t--${decamelize(flag.key, {separator: '-'})}${flag.alias ? `, -${flag.alias}` : ''}`);
|
51 | }
|
52 | };
|
53 |
|
54 | const validateOptions = ({flags}) => {
|
55 | const invalidFlags = Object.keys(flags).filter(flagKey => flagKey.includes('-') && flagKey !== '--');
|
56 | if (invalidFlags.length > 0) {
|
57 | throw new Error(`Flag keys may not contain '-': ${invalidFlags.join(', ')}`);
|
58 | }
|
59 | };
|
60 |
|
61 | const reportUnknownFlags = unknownFlags => {
|
62 | console.error([
|
63 | `Unknown flag${unknownFlags.length > 1 ? 's' : ''}`,
|
64 | ...unknownFlags,
|
65 | ].join('\n'));
|
66 | };
|
67 |
|
68 | const buildParserFlags = ({flags, booleanDefault}) => {
|
69 | const parserFlags = {};
|
70 |
|
71 | for (const [flagKey, flagValue] of Object.entries(flags)) {
|
72 | const flag = {...flagValue};
|
73 |
|
74 | if (
|
75 | typeof booleanDefault !== 'undefined'
|
76 | && flag.type === 'boolean'
|
77 | && !Object.prototype.hasOwnProperty.call(flag, 'default')
|
78 | ) {
|
79 | flag.default = flag.isMultiple ? [booleanDefault] : booleanDefault;
|
80 | }
|
81 |
|
82 | if (flag.isMultiple) {
|
83 | flag.type = flag.type ? `${flag.type}-array` : 'array';
|
84 | flag.default = flag.default || [];
|
85 | delete flag.isMultiple;
|
86 | }
|
87 |
|
88 | parserFlags[flagKey] = flag;
|
89 | }
|
90 |
|
91 | return parserFlags;
|
92 | };
|
93 |
|
94 | const validateFlags = (flags, options) => {
|
95 | for (const [flagKey, flagValue] of Object.entries(options.flags)) {
|
96 | if (flagKey !== '--' && !flagValue.isMultiple && Array.isArray(flags[flagKey])) {
|
97 | throw new Error(`The flag --${flagKey} can only be set once.`);
|
98 | }
|
99 | }
|
100 | };
|
101 |
|
102 | const meow = (helpText, options = {}) => {
|
103 | if (typeof helpText !== 'string') {
|
104 | options = helpText;
|
105 | helpText = '';
|
106 | }
|
107 |
|
108 | if (!(options.importMeta && options.importMeta.url)) {
|
109 | throw new TypeError('The `importMeta` option is required. Its value must be `import.meta`.');
|
110 | }
|
111 |
|
112 | const foundPackage = readPackageUpSync({
|
113 | cwd: dirname(fileURLToPath(options.importMeta.url)),
|
114 | normalize: false,
|
115 | });
|
116 |
|
117 | options = {
|
118 | pkg: foundPackage ? foundPackage.packageJson : {},
|
119 | argv: process.argv.slice(2),
|
120 | flags: {},
|
121 | inferType: false,
|
122 | input: 'string',
|
123 | help: helpText,
|
124 | autoHelp: true,
|
125 | autoVersion: true,
|
126 | booleanDefault: false,
|
127 | hardRejection: true,
|
128 | allowUnknownFlags: true,
|
129 | ...options,
|
130 | };
|
131 |
|
132 | if (options.hardRejection) {
|
133 | hardRejection();
|
134 | }
|
135 |
|
136 | validateOptions(options);
|
137 | let parserOptions = {
|
138 | arguments: options.input,
|
139 | ...buildParserFlags(options),
|
140 | };
|
141 |
|
142 | parserOptions = decamelizeKeys(parserOptions, '-', {exclude: ['stopEarly', '--']});
|
143 |
|
144 | if (options.inferType) {
|
145 | delete parserOptions.arguments;
|
146 | }
|
147 |
|
148 | parserOptions = buildParserOptions(parserOptions);
|
149 |
|
150 | parserOptions.configuration = {
|
151 | ...parserOptions.configuration,
|
152 | 'greedy-arrays': false,
|
153 | };
|
154 |
|
155 | if (parserOptions['--']) {
|
156 | parserOptions.configuration['populate--'] = true;
|
157 | }
|
158 |
|
159 | if (!options.allowUnknownFlags) {
|
160 |
|
161 | parserOptions.configuration['unknown-options-as-args'] = true;
|
162 | }
|
163 |
|
164 | const {pkg: package_} = options;
|
165 | const argv = parseArguments(options.argv, parserOptions);
|
166 | let help = redent(trimNewlines((options.help || '').replace(/\t+\n*$/, '')), 2);
|
167 |
|
168 | normalizePackageData(package_);
|
169 |
|
170 | process.title = package_.bin ? Object.keys(package_.bin)[0] : package_.name;
|
171 |
|
172 | let {description} = options;
|
173 | if (!description && description !== false) {
|
174 | ({description} = package_);
|
175 | }
|
176 |
|
177 | help = (description ? `\n ${description}\n` : '') + (help ? `\n${help}\n` : '\n');
|
178 |
|
179 | const showHelp = code => {
|
180 | console.log(help);
|
181 | process.exit(typeof code === 'number' ? code : 2);
|
182 | };
|
183 |
|
184 | const showVersion = () => {
|
185 | console.log(typeof options.version === 'string' ? options.version : package_.version);
|
186 | process.exit(0);
|
187 | };
|
188 |
|
189 | if (argv._.length === 0 && options.argv.length === 1) {
|
190 | if (argv.version === true && options.autoVersion) {
|
191 | showVersion();
|
192 | } else if (argv.help === true && options.autoHelp) {
|
193 | showHelp(0);
|
194 | }
|
195 | }
|
196 |
|
197 | const input = argv._;
|
198 | delete argv._;
|
199 |
|
200 | if (!options.allowUnknownFlags) {
|
201 | const unknownFlags = input.filter(item => typeof item === 'string' && item.startsWith('-'));
|
202 | if (unknownFlags.length > 0) {
|
203 | reportUnknownFlags(unknownFlags);
|
204 | process.exit(2);
|
205 | }
|
206 | }
|
207 |
|
208 | const flags = camelCaseKeys(argv, {exclude: ['--', /^\w$/]});
|
209 | const unnormalizedFlags = {...flags};
|
210 |
|
211 | validateFlags(flags, options);
|
212 |
|
213 | for (const flagValue of Object.values(options.flags)) {
|
214 | delete flags[flagValue.alias];
|
215 | }
|
216 |
|
217 | const missingRequiredFlags = getMissingRequiredFlags(options.flags, flags, input);
|
218 | if (missingRequiredFlags.length > 0) {
|
219 | reportMissingRequiredFlags(missingRequiredFlags);
|
220 | process.exit(2);
|
221 | }
|
222 |
|
223 | return {
|
224 | input,
|
225 | flags,
|
226 | unnormalizedFlags,
|
227 | pkg: package_,
|
228 | help,
|
229 | showHelp,
|
230 | showVersion,
|
231 | };
|
232 | };
|
233 |
|
234 | export default meow;
|