index.js 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. import { AsyncResource } from 'node:async_hooks';
  2. import { editAsync } from 'external-editor';
  3. import { createPrompt, useEffect, useState, useKeypress, usePrefix, isEnterKey, makeTheme, } from '@inquirer/core';
  4. const editorTheme = {
  5. validationFailureMode: 'keep',
  6. };
  7. export default createPrompt((config, done) => {
  8. const { waitForUseInput = true, file: { postfix = config.postfix ?? '.txt', ...fileProps } = {}, validate = () => true, } = config;
  9. const theme = makeTheme(editorTheme, config.theme);
  10. const [status, setStatus] = useState('idle');
  11. const [value = '', setValue] = useState(config.default);
  12. const [errorMsg, setError] = useState();
  13. const prefix = usePrefix({ status, theme });
  14. function startEditor(rl) {
  15. rl.pause();
  16. // Note: The bind call isn't strictly required. But we need it for our mocks to work as expected.
  17. const editCallback = AsyncResource.bind(async (error, answer) => {
  18. rl.resume();
  19. if (error) {
  20. setError(error.toString());
  21. }
  22. else {
  23. setStatus('loading');
  24. const isValid = await validate(answer);
  25. if (isValid === true) {
  26. setError(undefined);
  27. setStatus('done');
  28. done(answer);
  29. }
  30. else {
  31. if (theme.validationFailureMode === 'clear') {
  32. setValue(config.default);
  33. }
  34. else {
  35. setValue(answer);
  36. }
  37. setError(isValid || 'You must provide a valid value');
  38. setStatus('idle');
  39. }
  40. }
  41. });
  42. editAsync(value, (error, answer) => void editCallback(error, answer), {
  43. postfix,
  44. ...fileProps,
  45. });
  46. }
  47. useEffect((rl) => {
  48. if (!waitForUseInput) {
  49. startEditor(rl);
  50. }
  51. }, []);
  52. useKeypress((key, rl) => {
  53. // Ignore keypress while our prompt is doing other processing.
  54. if (status !== 'idle') {
  55. return;
  56. }
  57. if (isEnterKey(key)) {
  58. startEditor(rl);
  59. }
  60. });
  61. const message = theme.style.message(config.message, status);
  62. let helpTip = '';
  63. if (status === 'loading') {
  64. helpTip = theme.style.help('Received');
  65. }
  66. else if (status === 'idle') {
  67. const enterKey = theme.style.key('enter');
  68. helpTip = theme.style.help(`Press ${enterKey} to launch your preferred editor.`);
  69. }
  70. let error = '';
  71. if (errorMsg) {
  72. error = theme.style.error(errorMsg);
  73. }
  74. return [[prefix, message, helpTip].filter(Boolean).join(' '), error];
  75. });