prompt() questions input type is incompatible with @yeoman/adapter

[jmuzina]

Calling Generator.prompt() with an array of questions of type PromptQuestions throws a type error.

import type { PromptAnswers, PromptQuestions } from "@yeoman/types";
import Generator from "yeoman-generator";

interface ComponentGeneratorAnswers extends PromptAnswers {
  // answer types here...
}

export default class ComponentGenerator extends Generator {
  answers?: ComponentGeneratorAnswers;
  questions: PromptQuestions<ComponentGeneratorAnswers> = [];

  async prompting() {
    this.answers = await this.prompt<ComponentGeneratorAnswers>(this.questions);
  }
}

Argument of type
import("node_modules/@yeoman/ adapter/ types/ adapter", {with: {"resolution-mode": "import"}}).PromptQuestions<ComponentGeneratorAnswers>
is not assignable to parameter of type
import("node_modules/ yeoman-generator/ dist/ questions", {with: {"resolution-mode": "import"}}).PromptQuestions<ComponentGeneratorAnswers>
Type NumberQuestion<ComponentGeneratorAnswers> is not assignable to type PromptQuestions<ComponentGeneratorAnswers>
Type NumberQuestion<ComponentGeneratorAnswers> is not assignable to type
NumberQuestion<ComponentGeneratorAnswers> & {   name: string;   storage?: Storage | undefined;   store?: boolean | undefined; }
Type NumberQuestion<ComponentGeneratorAnswers> is not assignable to type
{   name: string;   storage?: Storage | undefined;   store?: boolean | undefined; }
Types of property name are incompatible.
Type string | undefined is not assignable to type string
Type undefined is not assignable to type string

Directly passing an array of questions into prompt() is valid:

  interface ComponentGeneratorAnswers extends PromptAnswers {
    myQuestion: string
  }
  // ....
  async prompting() {
    this.answers = await this.prompt<ComponentGeneratorAnswers>([
      {
        name: "myQuestion",
        type: "input",
      },
    ]);
  }

But storing them in a variable is not:

  interface ComponentGeneratorAnswers extends PromptAnswers {
    myQuestion: string
  }
  // ....
  async prompting() {
    // Throws an error
    this.answers = await this.prompt<ComponentGeneratorAnswers>(this.questions);
  }

Am I doing something wrong storing these prompt questions into an attribute? I'd like to store them this way so i can do more with them than just prompt interactive questions (such as create CLI arguments).

[jmuzina]

I believe I've found the source of this issue.

The yeoman-generator PromptQuestions type declares name as required:

generator/src/questions.d.ts

Lines 9 to 10 in 34781f7

	export type PromptQuestion<T extends PromptAnswers = PromptAnswers> = PromptQuestionApi<T> & {
	name: string;

@types/inquirer declares the name key as optional:
https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e777b97e68ff2f3609772d29e44361d501b0c25c/types/inquirer/index.d.ts#L359

@yeoman/adapter, which is re-exported by @yeoman/types, re-exports the inquirer types here:
https://github.com/yeoman/yeoman-api/blob/3b77ad9325d6ab8cb4bcb2d42580ed7988b552bb/workspaces/adapter/types/adapter.d.ts#L9

This means that the Yeoman adapter and Yeoman types are treating name as optional, just like Inquirer does, but the prompt() function in yeoman-generator treats name as required.

Possibly a modification could be made to @yeoman/adapter to fix the issue:

export type PromptQuestion<A extends PromptAnswers = PromptAnswers> = DistinctQuestion<A> & { name: string };

[jmuzina]

I've created a PR for @yeoman/adapter to try and fix the issue. Maybe this issue should be transferred to yeoman-api

[mshima]

Generator's types should be used instead.
https://github.com/yeoman/generator/blob/main/src/questions.d.ts

Maybe it’s not exported yet.

[jmuzina]

Generator's types should be used instead. https://github.com/yeoman/generator/blob/main/src/questions.d.ts

Maybe it’s not exported yet.

@mshima Yes, PromptQuestion and similar types from questions.d.ts are not exported by this package. I can raise a PR that exports them if you like.

[mshima]

Please go ahead