« get me outta code hell

cli.js « util « src - hsmusic-wiki - HSMusic - static wiki software cataloguing collaborative creation
about summary refs log tree commit diff
path: root/src/util/cli.js
blob: 9f2b35abca0103b14f71d0760a4b1aca3c701c90 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
// Utility functions for CLI- and de8ugging-rel8ted stuff.
//
// A 8unch of these depend on process.stdout 8eing availa8le, so they won't
// work within the 8rowser.

const {process} = globalThis;

export const ENABLE_COLOR =
  process &&
  ((process.env.CLICOLOR_FORCE && process.env.CLICOLOR_FORCE === '1') ??
    (process.env.CLICOLOR &&
      process.env.CLICOLOR === '1' &&
      process.stdout.hasColors &&
      process.stdout.hasColors()) ??
    (process.stdout.hasColors ? process.stdout.hasColors() : true));

const C = (n) =>
  ENABLE_COLOR ? (text) => `\x1b[${n}m${text}\x1b[0m` : (text) => text;

export const colors = {
  bright: C('1'),
  dim: C('2'),
  normal: C('22'),
  black: C('30'),
  red: C('31'),
  green: C('32'),
  yellow: C('33'),
  blue: C('34'),
  magenta: C('35'),
  cyan: C('36'),
  white: C('37'),
};

const logColor =
  (color) =>
  (literals, ...values) => {
    const w = (s) => process.stdout.write(s);
    const wc = (text) => {
      if (ENABLE_COLOR) w(text);
    };

    wc(`\x1b[${color}m`);
    for (let i = 0; i < literals.length; i++) {
      w(literals[i]);
      if (values[i] !== undefined) {
        wc(`\x1b[1m`);
        w(String(values[i]));
        wc(`\x1b[0;${color}m`);
      }
    }
    wc(`\x1b[0m`);
    w('\n');
  };

export const logInfo = logColor(2);
export const logWarn = logColor(33);
export const logError = logColor(31);

// Stolen as #@CK from mtui!
export async function parseOptions(options, optionDescriptorMap) {
  // This function is sorely lacking in comments, but the basic usage is
  // as such:
  //
  // options is the array of options you want to process;
  // optionDescriptorMap is a mapping of option names to objects that describe
  // the expected value for their corresponding options.
  //
  // Returned is...
  // - a mapping of any specified option names to their values
  // - a process.exit(1) and error message if there were any issues
  //
  // Here are examples of optionDescriptorMap to cover all the things you can
  // do with it:
  //
  // optionDescriptorMap: {
  //   'telnet-server': {type: 'flag'},
  //   't': {alias: 'telnet-server'}
  // }
  //
  // options: ['t'] -> result: {'telnet-server': true}
  //
  // optionDescriptorMap: {
  //   'directory': {
  //     type: 'value',
  //     validate(name) {
  //       // const whitelistedDirectories = ['apple', 'banana']
  //       if (whitelistedDirectories.includes(name)) {
  //         return true
  //       } else {
  //         return 'a whitelisted directory'
  //       }
  //     }
  //   },
  //   'files': {type: 'series'}
  // }
  //
  // ['--directory', 'apple'] -> {'directory': 'apple'}
  // ['--directory', 'artichoke'] -> (error)
  // ['--files', 'a', 'b', 'c', ';'] -> {'files': ['a', 'b', 'c']}

  const handleDashless = optionDescriptorMap[parseOptions.handleDashless];
  const handleUnknown = optionDescriptorMap[parseOptions.handleUnknown];

  const result = Object.create(null);
  for (let i = 0; i < options.length; i++) {
    const option = options[i];
    if (option.startsWith('--')) {
      // --x can be a flag or expect a value or series of values
      let name = option.slice(2).split('=')[0]; // '--x'.split('=') = ['--x']
      let descriptor = optionDescriptorMap[name];

      if (!descriptor) {
        if (handleUnknown) {
          handleUnknown(option);
        } else {
          console.error(`Unknown option name: ${name}`);
          process.exit(1);
        }
        continue;
      }

      if (descriptor.alias) {
        name = descriptor.alias;
        descriptor = optionDescriptorMap[name];
      }

      switch (descriptor.type) {
        case 'flag': {
          result[name] = true;
          break;
        }

        case 'value': {
          let value = option.slice(2).split('=')[1];
          if (!value) {
            value = options[++i];
            if (!value || value.startsWith('-')) {
              value = null;
            }
          }

          if (!value) {
            console.error(`Expected a value for --${name}`);
            process.exit(1);
          }

          result[name] = value;
          break;
        }

        case 'series': {
          if (!options.slice(i).includes(';')) {
            console.error(`Expected a series of values concluding with ; (\\;) for --${name}`);
            process.exit(1);
          }

          const endIndex = i + options.slice(i).indexOf(';');
          result[name] = options.slice(i + 1, endIndex);
          i = endIndex;
          break;
        }
      }

      if (descriptor.validate) {
        const validation = await descriptor.validate(result[name]);
        if (validation !== true) {
          console.error(`Expected ${validation} for --${name}`);
          process.exit(1);
        }
      }
    } else if (option.startsWith('-')) {
      // mtui doesn't use any -x=y or -x y format optionuments
      // -x will always just be a flag
      let name = option.slice(1);
      let descriptor = optionDescriptorMap[name];
      if (!descriptor) {
        if (handleUnknown) {
          handleUnknown(option);
        } else {
          console.error(`Unknown option name: ${name}`);
          process.exit(1);
        }
        continue;
      }

      if (descriptor.alias) {
        name = descriptor.alias;
        descriptor = optionDescriptorMap[name];
      }

      if (descriptor.type === 'flag') {
        result[name] = true;
      } else {
        console.error(`Use --${name} (value) to specify ${name}`);
        process.exit(1);
      }
    } else if (handleDashless) {
      handleDashless(option);
    }
  }
  return result;
}

export const handleDashless = Symbol();
export const handleUnknown = Symbol();

export function decorateTime(arg1, arg2) {
  const [id, functionToBeWrapped] =
    typeof arg1 === 'string' || typeof arg1 === 'symbol'
      ? [arg1, arg2]
      : [Symbol(arg1.name), arg1];

  const meta = decorateTime.idMetaMap[id] ?? {
    wrappedName: functionToBeWrapped.name,
    timeSpent: 0,
    timesCalled: 0,
    displayTime() {
      const averageTime = meta.timeSpent / meta.timesCalled;
      console.log(
        `\x1b[1m${typeof id === 'symbol' ? id.description : id}(...):\x1b[0m ${
          meta.timeSpent
        } ms / ${meta.timesCalled} calls \x1b[2m(avg: ${averageTime} ms)\x1b[0m`
      );
    },
  };

  decorateTime.idMetaMap[id] = meta;

  const fn = function (...args) {
    const start = Date.now();
    const ret = functionToBeWrapped(...args);
    const end = Date.now();
    meta.timeSpent += end - start;
    meta.timesCalled++;
    return ret;
  };

  fn.displayTime = meta.displayTime;

  return fn;
}

decorateTime.idMetaMap = Object.create(null);

decorateTime.displayTime = function () {
  const map = decorateTime.idMetaMap;

  const keys = [
    ...Object.getOwnPropertySymbols(map),
    ...Object.getOwnPropertyNames(map),
  ];

  if (keys.length) {
    console.log(`\x1b[1mdecorateTime results: ` + '-'.repeat(40) + '\x1b[0m');
    for (const key of keys) {
      map[key].displayTime();
    }
  }
};

export function progressPromiseAll(msgOrMsgFn, array) {
  if (!array.length) {
    return Promise.resolve([]);
  }

  const msgFn =
    typeof msgOrMsgFn === 'function' ? msgOrMsgFn : () => msgOrMsgFn;

  let done = 0,
    total = array.length;
  process.stdout.write(`\r${msgFn()} [0/${total}]`);
  const start = Date.now();
  return Promise.all(
    array.map((promise) =>
      Promise.resolve(promise).then((val) => {
        done++;
        // const pc = `${done}/${total}`;
        const pc = (Math.round((done / total) * 1000) / 10 + '%').padEnd(
          '99.9%'.length,
          ' '
        );
        if (done === total) {
          const time = Date.now() - start;
          process.stdout.write(
            `\r\x1b[2m${msgFn()} [${pc}] \x1b[0;32mDone! \x1b[0;2m(${time} ms) \x1b[0m\n`
          );
        } else {
          process.stdout.write(`\r${msgFn()} [${pc}] `);
        }
        return val;
      })
    )
  );
}

export function progressCallAll(msgOrMsgFn, array) {
  if (!array.length) {
    return [];
  }

  const msgFn =
    typeof msgOrMsgFn === 'function' ? msgOrMsgFn : () => msgOrMsgFn;

  const updateInterval = 1000 / 60;

  let done = 0,
    total = array.length;
  process.stdout.write(`\r${msgFn()} [0/${total}]`);
  const start = Date.now();
  const vals = [];
  let lastTime = 0;

  for (const fn of array) {
    const val = fn();
    done++;

    if (done === total) {
      const pc = '100%'.padEnd('99.9%'.length, ' ');
      const time = Date.now() - start;
      process.stdout.write(
        `\r\x1b[2m${msgFn()} [${pc}] \x1b[0;32mDone! \x1b[0;2m(${time} ms) \x1b[0m\n`
      );
    } else if (Date.now() - lastTime >= updateInterval) {
      const pc = (Math.round((done / total) * 1000) / 10 + '%').padEnd('99.9%'.length, ' ');
      process.stdout.write(`\r${msgFn()} [${pc}] `);
      lastTime = Date.now();
    }
    vals.push(val);
  }

  return vals;
}

export function fileIssue({
  topMessage = `This shouldn't happen.`,
} = {}) {
  if (topMessage) {
    console.error(color.red(`${topMessage} Please let the HSMusic developers know:`));
  }
  console.error(color.red(`- https://hsmusic.wiki/feedback/`));
  console.error(color.red(`- https://github.com/hsmusic/hsmusic-wiki/issues/`));
}