Feat: gracefully error on missing message (#1575)

---------

Co-authored-by: Simon Boudrias <[email protected]>

packages/core/core.test.ts

@@ -631,6 +631,18 @@ it('fail on aborted signals', async () => {
 });
 
 describe('Error handling', () => {
+  it('gracefully error on missing content', async () => {
+    // @ts-expect-error Testing an invalid behavior.
+    const prompt = createPrompt(function TestPrompt() {});
+    const { answer } = await render(prompt, {});
+    await expect(answer).rejects.toMatchInlineSnapshot(
+      `
+      [Error: Prompt functions must return a string.
+          at ${import.meta.filename}]
+    `,
+    );
+  });
+
   it('surface errors in render functions', async () => {
     const Prompt = () => {
       throw new Error('Error in render function');

packages/core/src/lib/create-prompt.ts

@@ -14,7 +14,28 @@ type ViewFunction<Value, Config> = (
   done: (value: Value) => void,
 ) => string | [string, string | undefined];
 
+function getCallSites() {
+  const _prepareStackTrace = Error.prepareStackTrace;
+  try {
+    let result: NodeJS.CallSite[] = [];
+    Error.prepareStackTrace = (_, callSites) => {
+      const callSitesWithoutCurrent = callSites.slice(1);
+      result = callSitesWithoutCurrent;
+      return callSitesWithoutCurrent;
+    };
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-expressions, unicorn/error-message
+    new Error().stack;
+    return result;
+  } finally {
+    Error.prepareStackTrace = _prepareStackTrace;
+  }
+}
+
 export function createPrompt<Value, Config>(view: ViewFunction<Value, Config>) {
+  const callSites = getCallSites();
+  const callerFilename = callSites[1]?.getFileName?.();
+
   const prompt: Prompt<Value, Config> = (config, context = {}) => {
     // Default `input` to stdin
     const { input = process.stdin, signal } = context;
@@ -75,6 +96,14 @@ export function createPrompt<Value, Config>(view: ViewFunction<Value, Config>) {
             setImmediate(() => resolve(value));
           });
 
+          // Typescript won't allow this, but not all users rely on typescript.
+          // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+          if (nextView === undefined) {
+            throw new Error(
+              `Prompt functions must return a string.\n    at ${callerFilename}`,
+            );
+          }
+
           const [content, bottomContent] =
             typeof nextView === 'string' ? [nextView] : nextView;
           screen.render(content, bottomContent);