+5

.changeset/floppy-laws-tan.md

Reviewed

··· 1 1 + --- 2 2 + "@clack/prompts": patch 3 3 + --- 4 4 + 5 5 + fix note component overflow bug

+13 -2

packages/prompts/src/note.ts

Reviewed

··· 10 10 S_CORNER_TOP_RIGHT, 11 11 S_STEP_SUBMIT, 12 12 } from './common.js'; 13 13 + import { wrapAnsi } from "fast-wrap-ansi"; 14 14 + import process from "node:process"; 13 15 14 16 export interface NoteOptions extends CommonOptions { 15 17 format?: (line: string) => string; ··· 17 19 18 20 const defaultNoteFormatter = (line: string): string => color.dim(line); 19 21 22 22 + const wrapWithFormat = (message: string, width: number, format: NoteOptions["format"]): string => { 23 23 + const wrapMsg = wrapAnsi(message, width).split("\n"); 24 24 + const maxWidthNormal = wrapMsg.reduce((sum, ln) => Math.max(strip(ln).length, sum), 0); 25 25 + const maxWidthFormat = wrapMsg.map(format).reduce((sum, ln) => Math.max(strip(ln).length, sum), 0); 26 26 + const wrapWidth = width - (maxWidthFormat - maxWidthNormal); 27 27 + return wrapAnsi(message, wrapWidth); 28 28 + } 29 29 + 20 30 export const note = (message = '', title = '', opts?: NoteOptions) => { 31 31 + const output: Writable = opts?.output ?? process.stdout; 21 32 const format = opts?.format ?? defaultNoteFormatter; 22 22 - const lines = ['', ...message.split('\n').map(format), '']; 33 33 + const wrapMsg = wrapWithFormat(message, output.columns - 6, format); 34 34 + const lines = ['', ...wrapMsg.split('\n').map(format), '']; 23 35 const titleLen = strip(title).length; 24 24 - const output: Writable = opts?.output ?? process.stdout; 25 36 const len = 26 37 Math.max( 27 38 lines.reduce((sum, ln) => {

+148

packages/prompts/test/__snapshots__/note.test.ts.snap

Reviewed

··· 1 1 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html 2 2 3 3 + exports[`note (isCI = false) > don't overflow 1`] = ` 4 4 + [ 5 5 + "│ 6 6 + ◇ title ──────────────────────────────────────────────────────────────╮ 7 7 + │ │ 8 8 + │ test string test string test string test string test string test │ 9 9 + │ string test string test string test string test string test string │ 10 10 + │ test string test string test string test string test string test │ 11 11 + │ string test string test string test string test string test string │ 12 12 + │ test string test string test string test string test string test │ 13 13 + │ string test string test string test string test string │ 14 14 + │ test string test string test string test string test string test │ 15 15 + │ string test string test string test string test string test string │ 16 16 + │ test string test string test string test string test string test │ 17 17 + │ string test string test string test string test string test string │ 18 18 + │ test string test string test string test string test string test │ 19 19 + │ string test string test string test string test string │ 20 20 + │ test string test string test string test string test string test │ 21 21 + │ string test string test string test string test string test string │ 22 22 + │ test string test string test string test string test string test │ 23 23 + │ string test string test string test string test string test string │ 24 24 + │ test string test string test string test string test string test │ 25 25 + │ string test string test string test string test string │ 26 26 + │ test string test string test string test string test string test │ 27 27 + │ string test string test string test string test string test string │ 28 28 + │ test string test string test string test string test string test │ 29 29 + │ string test string test string test string test string test string │ 30 30 + │ test string test string test string test string test string test │ 31 31 + │ string test string test string test string test string │ 32 32 + │ │ 33 33 + ├──────────────────────────────────────────────────────────────────────╯ 34 34 + ", 35 35 + ] 36 36 + `; 37 37 + 38 38 + exports[`note (isCI = false) > don't overflow with formatter 1`] = ` 39 39 + [ 40 40 + "│ 41 41 + ◇ title ────────────────────────────────────────────────────────────────╮ 42 42 + │ │ 43 43 + │ * test string test string test string test string test string test * │ 44 44 + │ * string test string test string test string test string test * │ 45 45 + │ * string test string test string test string test string test * │ 46 46 + │ * string test string test string test string test string test * │ 47 47 + │ * string test string test string test string test string test * │ 48 48 + │ * string test string test string test string test string test * │ 49 49 + │ * string test string * │ 50 50 + │ * test string test string test string test string test string test * │ 51 51 + │ * string test string test string test string test string test * │ 52 52 + │ * string test string test string test string test string test * │ 53 53 + │ * string test string test string test string test string test * │ 54 54 + │ * string test string test string test string test string test * │ 55 55 + │ * string test string test string test string test string test * │ 56 56 + │ * string test string * │ 57 57 + │ * test string test string test string test string test string test * │ 58 58 + │ * string test string test string test string test string test * │ 59 59 + │ * string test string test string test string test string test * │ 60 60 + │ * string test string test string test string test string test * │ 61 61 + │ * string test string test string test string test string test * │ 62 62 + │ * string test string test string test string test string test * │ 63 63 + │ * string test string * │ 64 64 + │ * test string test string test string test string test string test * │ 65 65 + │ * string test string test string test string test string test * │ 66 66 + │ * string test string test string test string test string test * │ 67 67 + │ * string test string test string test string test string test * │ 68 68 + │ * string test string test string test string test string test * │ 69 69 + │ * string test string test string test string test string test * │ 70 70 + │ * string test string * │ 71 71 + │ │ 72 72 + ├────────────────────────────────────────────────────────────────────────╯ 73 73 + ", 74 74 + ] 75 75 + `; 76 76 + 3 77 exports[`note (isCI = false) > formatter which adds colors works 1`] = ` 4 78 [ 5 79 "│ ··· 49 123 │ message │ 50 124 │ │ 51 125 ├───────────╯ 126 126 + ", 127 127 + ] 128 128 + `; 129 129 + 130 130 + exports[`note (isCI = true) > don't overflow 1`] = ` 131 131 + [ 132 132 + "│ 133 133 + ◇ title ──────────────────────────────────────────────────────────────╮ 134 134 + │ │ 135 135 + │ test string test string test string test string test string test │ 136 136 + │ string test string test string test string test string test string │ 137 137 + │ test string test string test string test string test string test │ 138 138 + │ string test string test string test string test string test string │ 139 139 + │ test string test string test string test string test string test │ 140 140 + │ string test string test string test string test string │ 141 141 + │ test string test string test string test string test string test │ 142 142 + │ string test string test string test string test string test string │ 143 143 + │ test string test string test string test string test string test │ 144 144 + │ string test string test string test string test string test string │ 145 145 + │ test string test string test string test string test string test │ 146 146 + │ string test string test string test string test string │ 147 147 + │ test string test string test string test string test string test │ 148 148 + │ string test string test string test string test string test string │ 149 149 + │ test string test string test string test string test string test │ 150 150 + │ string test string test string test string test string test string │ 151 151 + │ test string test string test string test string test string test │ 152 152 + │ string test string test string test string test string │ 153 153 + │ test string test string test string test string test string test │ 154 154 + │ string test string test string test string test string test string │ 155 155 + │ test string test string test string test string test string test │ 156 156 + │ string test string test string test string test string test string │ 157 157 + │ test string test string test string test string test string test │ 158 158 + │ string test string test string test string test string │ 159 159 + │ │ 160 160 + ├──────────────────────────────────────────────────────────────────────╯ 161 161 + ", 162 162 + ] 163 163 + `; 164 164 + 165 165 + exports[`note (isCI = true) > don't overflow with formatter 1`] = ` 166 166 + [ 167 167 + "│ 168 168 + ◇ title ────────────────────────────────────────────────────────────────╮ 169 169 + │ │ 170 170 + │ * test string test string test string test string test string test * │ 171 171 + │ * string test string test string test string test string test * │ 172 172 + │ * string test string test string test string test string test * │ 173 173 + │ * string test string test string test string test string test * │ 174 174 + │ * string test string test string test string test string test * │ 175 175 + │ * string test string test string test string test string test * │ 176 176 + │ * string test string * │ 177 177 + │ * test string test string test string test string test string test * │ 178 178 + │ * string test string test string test string test string test * │ 179 179 + │ * string test string test string test string test string test * │ 180 180 + │ * string test string test string test string test string test * │ 181 181 + │ * string test string test string test string test string test * │ 182 182 + │ * string test string test string test string test string test * │ 183 183 + │ * string test string * │ 184 184 + │ * test string test string test string test string test string test * │ 185 185 + │ * string test string test string test string test string test * │ 186 186 + │ * string test string test string test string test string test * │ 187 187 + │ * string test string test string test string test string test * │ 188 188 + │ * string test string test string test string test string test * │ 189 189 + │ * string test string test string test string test string test * │ 190 190 + │ * string test string * │ 191 191 + │ * test string test string test string test string test string test * │ 192 192 + │ * string test string test string test string test string test * │ 193 193 + │ * string test string test string test string test string test * │ 194 194 + │ * string test string test string test string test string test * │ 195 195 + │ * string test string test string test string test string test * │ 196 196 + │ * string test string test string test string test string test * │ 197 197 + │ * string test string * │ 198 198 + │ │ 199 199 + ├────────────────────────────────────────────────────────────────────────╯ 52 200 ", 53 201 ] 54 202 `;

+21

packages/prompts/test/note.test.ts

Reviewed

··· 63 63 64 64 expect(output.buffer).toMatchSnapshot(); 65 65 }); 66 66 + 67 67 + test('don\'t overflow', () => { 68 68 + const input = `${'test string '.repeat(32)}\n`.repeat(4).trim(); 69 69 + prompts.note(input, 'title', { 70 70 + input, 71 71 + output: Object.assign(output, { columns: 75 }), 72 72 + }); 73 73 + 74 74 + expect(output.buffer).toMatchSnapshot(); 75 75 + }); 76 76 + 77 77 + test('don\'t overflow with formatter', () => { 78 78 + const input = `${'test string '.repeat(32)}\n`.repeat(4).trim(); 79 79 + prompts.note(input, 'title', { 80 80 + format: (line) => colors.red(`* ${colors.cyan(line)} *`), 81 81 + input, 82 82 + output: Object.assign(output, { columns: 75 }), 83 83 + }); 84 84 + 85 85 + expect(output.buffer).toMatchSnapshot(); 86 86 + }); 66 87 });