Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix prompt handler type #617

Merged
merged 1 commit into from
Sep 18, 2023
Merged

Fix prompt handler type #617

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions packages/gasket-cli/src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import type { GasketConfigFile, MaybeAsync } from '@gasket/engine';
import type { PackageManager } from '@gasket/utils';
import type { Config } from '@oclif/config';
import { Inquirer } from 'inquirer';

export interface Dependencies {
dependencies?: Record<string, string>;
Expand Down Expand Up @@ -196,7 +195,7 @@ declare module '@gasket/engine' {
prompt(
context: CreateContext,
utils: {
prompt: Inquirer,
prompt: (prompts: Array<Record<string, any>>) => Promise<Record<string,any>>,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't seem like a very helpful type. Can we find a better way to import the type instead?

Copy link
Contributor

@jpage-godaddy jpage-godaddy Sep 18, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or add @types/inquirer as a dependency so it is exported? Hmm, looks like maybe there was a version bump and the types don't align now?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like @types/inquirer has a PromptFunction type that maybe is what this is?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We set up the prompt function conditionally here. We are using inquirer@6 in the CLI currently, which does not export types. There is a @types/inquirer, but then it becomes a necessary dependency for users to add, unless we make it a direct dependency of the CLI, which doesn't feel right either.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PromptFunction type is in v9 of @types/inquirer here, but it doesn't exist in v6 version here. Maybe I could use PromptModule from v6? But, either way, this will require a hard dependency of the cli on this @types/inquirer to ensure it is synced up.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We will investigate further when upgrading
#618

addPlugins: (plugins: Array<string>) => Promise<void>
}
): MaybeAsync<CreateContext>;
Expand Down