Skip to content

fix: export missing types from @clack/core #238

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/afraid-worms-help.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clack/core': patch
---

fix: export `*Options` types for prompts.
9 changes: 9 additions & 0 deletions packages/core/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
export type { ClackState as State } from './types';
export type { ClackSettings } from './utils/settings';

export type { ConfirmOptions } from './prompts/confirm';
export type { GroupMultiSelectOptions } from './prompts/group-multiselect';
export type { MultiSelectOptions } from './prompts/multi-select';
export type { PasswordOptions } from './prompts/password';
export type { PromptOptions } from './prompts/prompt';
export type { SelectOptions } from './prompts/select';
export type { SelectKeyOptions } from './prompts/select-key';
export type { TextOptions } from './prompts/text';

export { default as ConfirmPrompt } from './prompts/confirm';
export { default as GroupMultiSelectPrompt } from './prompts/group-multiselect';
export { default as MultiSelectPrompt } from './prompts/multi-select';
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/prompts/confirm.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import { cursor } from 'sisteransi';
import Prompt, { type PromptOptions } from './prompt';

interface ConfirmOptions extends PromptOptions<ConfirmPrompt> {
export interface ConfirmOptions extends PromptOptions<ConfirmPrompt> {
active: string;
inactive: string;
initialValue?: boolean;
}

export default class ConfirmPrompt extends Prompt {
get cursor() {
return this.value ? 0 : 1;
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/prompts/group-multiselect.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import Prompt, { type PromptOptions } from './prompt';

interface GroupMultiSelectOptions<T extends { value: any }>
export interface GroupMultiSelectOptions<T extends { value: any }>
extends PromptOptions<GroupMultiSelectPrompt<T>> {
options: Record<string, T[]>;
initialValues?: T['value'][];
required?: boolean;
cursorAt?: T['value'];
}

export default class GroupMultiSelectPrompt<T extends { value: any }> extends Prompt {
options: (T & { group: string | boolean })[];
cursor = 0;
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/prompts/multi-select.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import Prompt, { type PromptOptions } from './prompt';

interface MultiSelectOptions<T extends { value: any }> extends PromptOptions<MultiSelectPrompt<T>> {
export interface MultiSelectOptions<T extends { value: any }>
extends PromptOptions<MultiSelectPrompt<T>> {
options: T[];
initialValues?: T['value'][];
required?: boolean;
cursorAt?: T['value'];
}

export default class MultiSelectPrompt<T extends { value: any }> extends Prompt {
options: T[];
cursor = 0;
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/prompts/password.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import color from 'picocolors';
import Prompt, { type PromptOptions } from './prompt';

interface PasswordOptions extends PromptOptions<PasswordPrompt> {
export interface PasswordOptions extends PromptOptions<PasswordPrompt> {
mask?: string;
}

export default class PasswordPrompt extends Prompt {
valueWithCursor = '';
private _mask = '•';
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/prompts/select-key.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
import Prompt, { type PromptOptions } from './prompt';

interface SelectKeyOptions<T extends { value: any }> extends PromptOptions<SelectKeyPrompt<T>> {
export interface SelectKeyOptions<T extends { value: any }>
extends PromptOptions<SelectKeyPrompt<T>> {
options: T[];
}

export default class SelectKeyPrompt<T extends { value: any }> extends Prompt {
options: T[];
cursor = 0;
Expand Down
3 changes: 2 additions & 1 deletion packages/core/src/prompts/select.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
import Prompt, { type PromptOptions } from './prompt';

interface SelectOptions<T extends { value: any }> extends PromptOptions<SelectPrompt<T>> {
export interface SelectOptions<T extends { value: any }> extends PromptOptions<SelectPrompt<T>> {
options: T[];
initialValue?: T['value'];
}

export default class SelectPrompt<T extends { value: any }> extends Prompt {
options: T[];
cursor = 0;
Expand Down
Loading