Skip to content

fix(prompts): do not dim note contents #568

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

Merged
43081j merged 3 commits into from
Jun 17, 2026
+95 −77
Merged

fix(prompts): do not dim note contents #568

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f44003d
fix(prompts): do not dim note contents
florian-lefebvre Jun 16, 2026
048e7e3
Update better-hats-start.md
florian-lefebvre Jun 17, 2026
993e5c4
Merge branch 'main' into fix/note-dont-dim
florian-lefebvre Jun 17, 2026
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
18 changes: 18 additions & 0 deletions .changeset/better-hats-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
"@clack/prompts": minor
---

Updates default formatter of `note()` to note dim lines anymore

Comment thread
florian-lefebvre marked this conversation as resolved.
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) }
);
```
2 changes: 1 addition & 1 deletion packages/prompts/src/note.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down
152 changes: 76 additions & 76 deletions packages/prompts/test/__snapshots__/note.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 │
│ │
├───────────────────────────────────────────────────────────────────────╯
",
Expand Down Expand Up @@ -107,16 +107,16 @@ exports[`note (isCI = false) > handle wide characters 1`] = `
"│
◇ 这是标题 ─╮
│ │
│ 이게 │
│  첫  │
│ 번째 │
│   │
│ 줄이 │
│ 에요 │
│ これ │
│ は次 │
│ の行 │
│ です │
│ 이게 │
│ 첫 │
│ 번째 │
│ │
│ 줄이 │
│ 에요 │
│ これ │
│ は次 │
│ の行 │
│ です │
│ │
├────────────╯
",
Expand Down Expand Up @@ -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 │
│ │
├───────────────────────────────────╯
",
Expand All @@ -174,7 +174,7 @@ exports[`note (isCI = false) > renders message with title 1`] = `
"│
◇ title ───╮
│ │
│ message │
│ message │
│ │
├───────────╯
",
Expand All @@ -185,7 +185,7 @@ exports[`note (isCI = false) > without guide 1`] = `
[
"◇ title ───╮
│ │
│ message │
│ message │
│ │
╰───────────╯
",
Expand All @@ -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 │
│ │
├───────────────────────────────────────────────────────────────────────╯
",
Expand Down Expand Up @@ -299,16 +299,16 @@ exports[`note (isCI = true) > handle wide characters 1`] = `
"│
◇ 这是标题 ─╮
│ │
│ 이게 │
│  첫  │
│ 번째 │
│   │
│ 줄이 │
│ 에요 │
│ これ │
│ は次 │
│ の行 │
│ です │
│ 이게 │
│ 첫 │
│ 번째 │
│ │
│ 줄이 │
│ 에요 │
│ これ │
│ は次 │
│ の行 │
│ です │
│ │
├────────────╯
",
Expand Down Expand Up @@ -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 │
│ │
├───────────────────────────────────╯
",
Expand All @@ -366,7 +366,7 @@ exports[`note (isCI = true) > renders message with title 1`] = `
"│
◇ title ───╮
│ │
│ message │
│ message │
│ │
├───────────╯
",
Expand All @@ -377,7 +377,7 @@ exports[`note (isCI = true) > without guide 1`] = `
[
"◇ title ───╮
│ │
│ message │
│ message │
│ │
╰───────────╯
",
Expand Down
Loading