diff --git a/.changeset/better-hats-start.md b/.changeset/better-hats-start.md new file mode 100644 index 00000000..94a741ee --- /dev/null +++ b/.changeset/better-hats-start.md @@ -0,0 +1,18 @@ +--- +"@clack/prompts": minor +--- + +Updates default formatter of `note()` to note dim lines anymore + +If you want the old behavior, provide a `format()` function: + +```diff +import { note } from '@clack/prompts'; ++import { styleText } from 'node:util'; + +note( + 'You can edit the file src/index.jsx', + 'Next steps.' ++ { format: (text) => styleText('dim', text) } +); +``` diff --git a/packages/prompts/src/note.ts b/packages/prompts/src/note.ts index aa68d2b7..72f94e77 100644 --- a/packages/prompts/src/note.ts +++ b/packages/prompts/src/note.ts @@ -20,7 +20,7 @@ export interface NoteOptions extends CommonOptions { format?: FormatFn; } -const defaultNoteFormatter = (line: string): string => styleText('dim', line); +const defaultNoteFormatter = (line: string): string => line; const wrapWithFormat = (message: string, width: number, format: FormatFn): string => { const opts: WrapAnsiOptions = { diff --git a/packages/prompts/test/__snapshots__/note.test.ts.snap b/packages/prompts/test/__snapshots__/note.test.ts.snap index 032d05c1..bdc86646 100644 --- a/packages/prompts/test/__snapshots__/note.test.ts.snap +++ b/packages/prompts/test/__snapshots__/note.test.ts.snap @@ -5,30 +5,30 @@ exports[`note (isCI = false) > don't overflow 1`] = ` "โ”‚ โ—‡ title โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ", @@ -107,16 +107,16 @@ exports[`note (isCI = false) > handle wide characters 1`] = ` "โ”‚ โ—‡ ่ฟ™ๆ˜ฏๆ ‡้ข˜ โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ ์ด๊ฒŒ โ”‚ -โ”‚  ์ฒซ  โ”‚ -โ”‚ ๋ฒˆ์งธ โ”‚ -โ”‚   โ”‚ -โ”‚ ์ค„์ด โ”‚ -โ”‚ ์—์š” โ”‚ -โ”‚ ใ“ใ‚Œ โ”‚ -โ”‚ ใฏๆฌก โ”‚ -โ”‚ ใฎ่กŒ โ”‚ -โ”‚ ใงใ™ โ”‚ +โ”‚ ์ด๊ฒŒ โ”‚ +โ”‚ ์ฒซ โ”‚ +โ”‚ ๋ฒˆ์งธ โ”‚ +โ”‚ โ”‚ +โ”‚ ์ค„์ด โ”‚ +โ”‚ ์—์š” โ”‚ +โ”‚ ใ“ใ‚Œ โ”‚ +โ”‚ ใฏๆฌก โ”‚ +โ”‚ ใฎ่กŒ โ”‚ +โ”‚ ใงใ™ โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ", @@ -161,8 +161,8 @@ exports[`note (isCI = false) > renders as wide as longest line 1`] = ` "โ”‚ โ—‡ title โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ short โ”‚ -โ”‚ somewhat questionably long line โ”‚ +โ”‚ short โ”‚ +โ”‚ somewhat questionably long line โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ", @@ -174,7 +174,7 @@ exports[`note (isCI = false) > renders message with title 1`] = ` "โ”‚ โ—‡ title โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ message โ”‚ +โ”‚ message โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ", @@ -185,7 +185,7 @@ exports[`note (isCI = false) > without guide 1`] = ` [ "โ—‡ title โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ message โ”‚ +โ”‚ message โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ", @@ -197,30 +197,30 @@ exports[`note (isCI = true) > don't overflow 1`] = ` "โ”‚ โ—‡ title โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string test string  โ”‚ -โ”‚ test string test string test string test string test string test  โ”‚ -โ”‚ string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string test string โ”‚ +โ”‚ test string test string test string test string test string test โ”‚ +โ”‚ string test string test string test string test string โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ", @@ -299,16 +299,16 @@ exports[`note (isCI = true) > handle wide characters 1`] = ` "โ”‚ โ—‡ ่ฟ™ๆ˜ฏๆ ‡้ข˜ โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ ์ด๊ฒŒ โ”‚ -โ”‚  ์ฒซ  โ”‚ -โ”‚ ๋ฒˆ์งธ โ”‚ -โ”‚   โ”‚ -โ”‚ ์ค„์ด โ”‚ -โ”‚ ์—์š” โ”‚ -โ”‚ ใ“ใ‚Œ โ”‚ -โ”‚ ใฏๆฌก โ”‚ -โ”‚ ใฎ่กŒ โ”‚ -โ”‚ ใงใ™ โ”‚ +โ”‚ ์ด๊ฒŒ โ”‚ +โ”‚ ์ฒซ โ”‚ +โ”‚ ๋ฒˆ์งธ โ”‚ +โ”‚ โ”‚ +โ”‚ ์ค„์ด โ”‚ +โ”‚ ์—์š” โ”‚ +โ”‚ ใ“ใ‚Œ โ”‚ +โ”‚ ใฏๆฌก โ”‚ +โ”‚ ใฎ่กŒ โ”‚ +โ”‚ ใงใ™ โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ", @@ -353,8 +353,8 @@ exports[`note (isCI = true) > renders as wide as longest line 1`] = ` "โ”‚ โ—‡ title โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ short โ”‚ -โ”‚ somewhat questionably long line โ”‚ +โ”‚ short โ”‚ +โ”‚ somewhat questionably long line โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ", @@ -366,7 +366,7 @@ exports[`note (isCI = true) > renders message with title 1`] = ` "โ”‚ โ—‡ title โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ message โ”‚ +โ”‚ message โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ", @@ -377,7 +377,7 @@ exports[`note (isCI = true) > without guide 1`] = ` [ "โ—‡ title โ”€โ”€โ”€โ•ฎ โ”‚ โ”‚ -โ”‚ message โ”‚ +โ”‚ message โ”‚ โ”‚ โ”‚ โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ ",