Skip to content

chore(prompts): destruct limitOption param for better code readability #457

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

Open
Simek wants to merge 1 commit into
base: main
Choose a base branch
from
+23 −16
Open

chore(prompts): destruct limitOption param for better code readability #457

Show file tree
Hide file tree
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
5 changes: 5 additions & 0 deletions .changeset/cool-parrots-throw.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@clack/prompts": patch
---

destruct `limitOption` param for better code readability, tweak types definitions
34 changes: 18 additions & 16 deletions packages/prompts/src/limit-options.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
import type { Writable } from 'node:stream';
import { getColumns, getRows } from '@clack/core';
import { wrapAnsi } from 'fast-wrap-ansi';
import color from 'picocolors';
import type { CommonOptions } from './common.js';

export interface LimitOptionsParams<TOption> extends CommonOptions {
options: TOption[];
maxItems: number | undefined;
cursor: number;
style: (option: TOption, active: boolean) => string;
maxItems?: number;
columnPadding?: number;
rowPadding?: number;
}

const trimLines = (
groups: Array<string[]>,
groups: string[][],
initialLineCount: number,
startIndex: number,
endIndex: number,
Expand All @@ -33,32 +32,35 @@ const trimLines = (
return { lineCount, removals };
};

export const limitOptions = <TOption>(params: LimitOptionsParams<TOption>): string[] => {
const { cursor, options, style } = params;
const output: Writable = params.output ?? process.stdout;
export const limitOptions = <TOption>({
cursor,
options,
style,
output = process.stdout,
maxItems = Number.POSITIVE_INFINITY,
columnPadding = 0,
rowPadding = 4
}: LimitOptionsParams<TOption>): string[] => {
const columns = getColumns(output);
const columnPadding = params.columnPadding ?? 0;
const rowPadding = params.rowPadding ?? 4;
const maxWidth = columns - columnPadding;
const rows = getRows(output);
const overflowFormat = color.dim('...');

const paramMaxItems = params.maxItems ?? Number.POSITIVE_INFINITY;
const outputMaxItems = Math.max(rows - rowPadding, 0);
// We clamp to minimum 5 because anything less doesn't make sense UX wise
const maxItems = Math.max(Math.min(paramMaxItems, outputMaxItems), 5);
const computedMaxItems = Math.max(Math.min(maxItems, outputMaxItems), 5);
let slidingWindowLocation = 0;

if (cursor >= maxItems - 3) {
slidingWindowLocation = Math.max(Math.min(cursor - maxItems + 3, options.length - maxItems), 0);
if (cursor >= computedMaxItems - 3) {
slidingWindowLocation = Math.max(Math.min(cursor - computedMaxItems + 3, options.length - computedMaxItems), 0);
}

let shouldRenderTopEllipsis = maxItems < options.length && slidingWindowLocation > 0;
let shouldRenderTopEllipsis = computedMaxItems < options.length && slidingWindowLocation > 0;
let shouldRenderBottomEllipsis =
maxItems < options.length && slidingWindowLocation + maxItems < options.length;
computedMaxItems < options.length && slidingWindowLocation + computedMaxItems < options.length;

const slidingWindowLocationEnd = Math.min(slidingWindowLocation + maxItems, options.length);
const lineGroups: Array<string[]> = [];
const slidingWindowLocationEnd = Math.min(slidingWindowLocation + computedMaxItems, options.length);
const lineGroups: string[][] = [];
let lineCount = 0;
if (shouldRenderTopEllipsis) {
lineCount++;
Expand Down