[Request] Track prompt history

[natemoo-re]

Is your feature request related to a problem? Please describe.
It would be interesting if individual prompts tracked their own submission history

Describe the solution you'd like
This could be an option enabled via something like updateSettings({ history: { id: 'my-package' } }), which would then create and store global prompt history for open ended input prompts. Each of those would need a unique ID, and we'd need to key the history against the package version as well.

Describe alternatives you've considered
Is this even a good idea? We could not implement this! Which, tbh, is also perfectly valid.

Additional context
See discussion thar sparked this idea in #186

[lilnasy]

Is it to enable going back to a previous prompt while maintaining the originally submitted inputs?

[mdjastrzebski]

As an alternative, text prompt could provide history: string[] option, which would allow users to have greater control over available history (e.g. filtering out some entries).

I've tried to implement it myself in @clack/core:

  constructor(opts: TextOptions) {
    // ...

    const history = opts.history;
    if (history) {
      this.on("cursor", (key) => {
        switch (key) {
          case "up":
            this.historyIndex = Math.max(this.historyIndex - 1, 0);
            if (history[this.historyIndex]) {
              this.value = history[this.historyIndex];
              this._cursor = this.value.length;
            }
            break;
          case "down":
            this.historyIndex = Math.min(this.historyIndex + 1, history.length);
            this.value = history[this.historyIndex] ?? "";
            this._cursor = this.value.length;
            break;
        }
      });
  }
}

However, when pressing Enter, TextPrompt would ignore this.value I've set in the cursor event and use this.value = this.rl?.line.replace(/\t/g, ''); from prompt.ts. When I would disable track option I've lost ability to display text. 🤷‍♂️

[auvred]

I managed to get it working by monkey patching the TextPrompt a bit.

I wanted to preserve the original look of text from @clack/prompts without copy-pasting it.
It would be cool if there were a way to customize the prompt logic, while still using the styled render from the @clack/prompts.

import { AsyncLocalStorage } from 'node:async_hooks'
import { TextPrompt } from '@clack/core'
import { text, type TextOptions } from '@clack/prompts'

const textPromptAsyncStorage = new AsyncLocalStorage<(self: TextPrompt) => void>()

{
  const orig = TextPrompt.prototype.prompt
  TextPrompt.prototype.prompt = function (...args) {
    textPromptAsyncStorage.getStore()?.(this)
    return orig.apply(this, args)
  }
}

declare function somehowLoadHistory(): Promise<string[]>
declare function somehowStoreHistory(history: string[]): Promise<void>

async function textWithHistory(opts: TextOptions): Promise<string | symbol> {
  const history: string[] = await somehowLoadHistory()
  let historyItemIdx = history.length

  return textPromptAsyncStorage.run(self => {
    self.on('cursor', e => {
      if (e === 'up' && historyItemIdx !== 0) {
        self['rl'].clearLine()
        self['rl'].write(history[--historyItemIdx])
      } else if (e === 'down' && historyItemIdx !== history.length) {
        self['rl'].clearLine()
        if (++historyItemIdx === history.length) {
          self.value = ''
        } else {
          self['rl'].write(history[historyItemIdx])
        }
      }
    })
    self.on('key', () => historyItemIdx = history.length)
    self.on('finalize', () => {
      if (self.state === 'submit') {
        history.push(self.value)
        somehowStoreHistory(history)
      }
    })
  }, () => clack.text(opts))
}

const answer = await textWithHistory({ message: 'Text prompt with history' })