|
1 | 1 | # @clack/prompts
|
2 | 2 |
|
| 3 | +## 1.0.0-alpha.0 |
| 4 | + |
| 5 | +### Major Changes |
| 6 | + |
| 7 | +- c713fd5: The package is now distributed as ESM-only. In `v0` releases, the package was dual-published as CJS and ESM. |
| 8 | + |
| 9 | + For existing CJS projects using Node v20+, please see Node's guide on [Loading ECMAScript modules using `require()`](https://nodejs.org/docs/latest-v20.x/api/modules.html#loading-ecmascript-modules-using-require). |
| 10 | + |
| 11 | +### Minor Changes |
| 12 | + |
| 13 | +- 99c3530: Adds `format` option to the note prompt to allow formatting of individual lines |
| 14 | +- 0aaee4c: Added new `taskLog` prompt for log output which is cleared on success |
| 15 | +- 729bbb6: Add support for customizable spinner cancel and error messages. Users can now customize these messages either per spinner instance or globally via the `updateSettings` function to support multilingual CLIs. |
| 16 | + |
| 17 | + This update also improves the architecture by exposing the core settings to the prompts package, enabling more consistent default message handling across the codebase. |
| 18 | + |
| 19 | + ```ts |
| 20 | + // Per-instance customization |
| 21 | + const spinner = prompts.spinner({ |
| 22 | + cancelMessage: "Operación cancelada", // "Operation cancelled" in Spanish |
| 23 | + errorMessage: "Se produjo un error", // "An error occurred" in Spanish |
| 24 | + }); |
| 25 | + |
| 26 | + // Global customization via updateSettings |
| 27 | + prompts.updateSettings({ |
| 28 | + messages: { |
| 29 | + cancel: "Operación cancelada", // "Operation cancelled" in Spanish |
| 30 | + error: "Se produjo un error", // "An error occurred" in Spanish |
| 31 | + }, |
| 32 | + }); |
| 33 | + |
| 34 | + // Settings can now be accessed directly |
| 35 | + console.log(prompts.settings.messages.cancel); // "Operación cancelada" |
| 36 | + |
| 37 | + // Direct options take priority over global settings |
| 38 | + const spinner = prompts.spinner({ |
| 39 | + cancelMessage: "Cancelled", // This will be used instead of the global setting |
| 40 | + }); |
| 41 | + ``` |
| 42 | + |
| 43 | +- 44df9af: Adds a new `groupSpacing` option to grouped multi-select prompts. If set to an integer greater than 0, it will add that number of new lines between each group. |
| 44 | +- f2c2b89: Adds `AutocompletePrompt` to core with comprehensive tests and implement both `autocomplete` and `autocomplete-multiselect` components in prompts package. |
| 45 | +- c45b9fb: Adds support for detecting spinner cancellation via CTRL+C. This allows for graceful handling of user interruptions during long-running operations. |
| 46 | +- 9a09318: Adds new `progress` prompt to display a progess-bar |
| 47 | +- 19558b9: Added support for custom frames in spinner prompt |
| 48 | + |
| 49 | +### Patch Changes |
| 50 | + |
| 51 | +- 46dc0a4: Fixes multiselect only shows hints on the first item in the options list. Now correctly shows hints for all selected options with hint property. |
| 52 | +- 17342d2: Exposes a new `SpinnerResult` type to describe the return type of `spinner` |
| 53 | +- 6868c1c: Adds a new `selectableGroups` boolean to the group multi-select prompt. Using `selectableGroups: false` will disable the ability to select a top-level group, but still allow every child to be selected individually. |
| 54 | +- 7a556ad: Updates all prompts to accept a custom `output` and `input` stream |
| 55 | +- 7cc8a55: Messages passed to the `stop` method of a spinner no longer have dots stripped. |
| 56 | +- 2048eb1: Fix spinner's dots behavior with custom frames |
| 57 | +- Updated dependencies [729bbb6] |
| 58 | +- Updated dependencies [6868c1c] |
| 59 | +- Updated dependencies [a4f5034] |
| 60 | +- Updated dependencies [c713fd5] |
| 61 | +- Updated dependencies [a36292b] |
| 62 | +- Updated dependencies [f2c2b89] |
| 63 | + - @clack/core@1.0.0-alpha.0 |
| 64 | + |
3 | 65 | ## 0.10.0
|
4 | 66 |
|
5 | 67 | ### Minor Changes
|
|
0 commit comments