@maizzle/framework 6.0.0-rc.0 → 6.0.0-rc.2

package/node_modules/@clack/prompts/CHANGELOG.md

@@ -1,15 +1,179 @@
 # @clack/prompts
 
-## 0.10.1
+## 1.2.0
+
+### Minor Changes
+
+- 9786226: Externalize `fast-string-width` and `fast-wrap-ansi` to avoid double dependencies
+- 090902c: Adds `date` prompt with `format` support (YMD, MDY, DMY)
 
 ### Patch Changes
 
-- 11a5dc1: Fixes multiselect only shows hints on the first item in the options list. Now correctly shows hints for all selected options with hint property.
-- 30aa7ed: 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.
-- Updated dependencies [30aa7ed]
-- Updated dependencies [5dfce8a]
-- Updated dependencies [f574297]
-  - @clack/core@0.4.2
+- 134a1a1: Fix the `path` prompt so `directory: true` correctly enforces directory-only selection while still allowing directory navigation, and add regression tests for both directory and default file selection behavior.
+- bdf89a5: Adds `placeholder` option to `autocomplete`. When the placeholder is set and the input is empty, pressing `tab` will set the value to `placeholder`.
+- 336495a: Apply guide to wrapped multi-line messages in confirm prompt.
+- 9fe8de6: Respect `withGuide: false` in autocomplete and multiselect prompts.
+- 29a50cb: Fix `path` directory mode so pressing Enter with an existing directory `initialValue` submits that current directory instead of the first child option, and add regression coverage for immediate submit and child-directory navigation.
+- Updated dependencies [9786226]
+- Updated dependencies [bdf89a5]
+- Updated dependencies [417b451]
+- Updated dependencies [090902c]
+  - @clack/core@1.2.0
+
+## 1.1.0
+
+### Minor Changes
+
+- e3333fb: Replaces `picocolors` with Node.js built-in `styleText`.
+
+### Patch Changes
+
+- c3666e2: destruct `limitOption` param for better code readability, tweak types definitions
+- ba3df8e: Fixes withGuide support in intro, outro, and cancel messages.
+- Updated dependencies [e3333fb]
+  - @clack/core@1.1.0
+
+## 1.0.1
+
+### Patch Changes
+
+- 6404dc1: Disallows selection of `disabled` options in autocomplete.
+- 86e36d8: Adds `withGuide` support to select prompt.
+- c697439: Fixes line wrapping behavior in autocomplete.
+- 0ded19c: Simplifies `withGuide` option checks.
+- 0e4ddc9: Fixes `withGuide` support in password and path prompts.
+- 76550d6: Adds `withGuide` support to selectKey prompt.
+- f9b9953: Adds `withGuide` support to password prompt.
+- 0e93ccb: Adds `vertical` arrangement option to `confirm` prompt.
+- 4e9ae13: Adds `withGuide` support to confirm prompt.
+- 0256238: Adds `withGuide` support to spinner prompt.
+- Updated dependencies [6404dc1]
+- Updated dependencies [2533180]
+  - @clack/core@1.0.1
+
+## 1.0.0
+
+### Major Changes
+
+- c713fd5: The package is now distributed as ESM-only. In `v0` releases, the package was dual-published as CJS and ESM.
+
+  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).
+
+### Minor Changes
+
+- 415410b: This adds a custom filter function to autocompleteMultiselect. It could be used, for example, to support fuzzy searching logic.
+- 7bc3301: Prompts now have a `userInput` stored separately from their `value`.
+- 8409f2c: feat: add styleFrame option for spinner
+- 2837845: Adds suggestion and path prompts
+- 99c3530: Adds `format` option to the note prompt to allow formatting of individual lines
+- 0aaee4c: Added new `taskLog` prompt for log output which is cleared on success
+- 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.
+
+  This update also improves the architecture by exposing the core settings to the prompts package, enabling more consistent default message handling across the codebase.
+
+  ```ts
+  // Per-instance customization
+  const spinner = prompts.spinner({
+    cancelMessage: "Operación cancelada", // "Operation cancelled" in Spanish
+    errorMessage: "Se produjo un error", // "An error occurred" in Spanish
+  });
+
+  // Global customization via updateSettings
+  prompts.updateSettings({
+    messages: {
+      cancel: "Operación cancelada", // "Operation cancelled" in Spanish
+      error: "Se produjo un error", // "An error occurred" in Spanish
+    },
+  });
+
+  // Settings can now be accessed directly
+  console.log(prompts.settings.messages.cancel); // "Operación cancelada"
+
+  // Direct options take priority over global settings
+  const spinner = prompts.spinner({
+    cancelMessage: "Cancelled", // This will be used instead of the global setting
+  });
+  ```
+
+- 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.
+- 55645c2: Support wrapping autocomplete and select prompts.
+- 9e5bc6c: Add support for signals in prompts, allowing them to be aborted.
+- f2c2b89: Adds `AutocompletePrompt` to core with comprehensive tests and implement both `autocomplete` and `autocomplete-multiselect` components in prompts package.
+- 38019c7: Updates the API for stopping spinners and progress bars to be clearer
+
+  Previously, both the spinner and progress bar components used a single `stop` method that accepted a code to indicate success, cancellation, or error. This update separates these into distinct methods: `stop()`, `cancel()`, and `error()`:
+
+  ```diff
+  const spinner = prompts.spinner();
+  spinner.start();
+
+  // Cancelling a spinner
+  - spinner.stop(undefined, 1);
+  + spinner.cancel();
+
+  // Stopping with an error
+  - spinner.stop(undefined, 2);
+  + spinner.error();
+  ```
+
+  As before, you can pass a message to each method to customize the output displayed:
+
+  ```js
+  spinner.cancel("Operation cancelled by user");
+  progressBar.error("An error occurred during processing");
+  ```
+
+- c45b9fb: Adds support for detecting spinner cancellation via CTRL+C. This allows for graceful handling of user interruptions during long-running operations.
+- f10071e: Using the `group` method, task logs can now have groups which themselves can have scrolling windows of logs.
+- df4eea1: Remove `suggestion` prompt and change `path` prompt to be an autocomplete prompt.
+- 76fd17f: Added new `box` prompt for rendering boxed text, similar a note.
+- 9a09318: Adds new `progress` prompt to display a progess-bar
+- 1604f97: Add `clearOnError` option to password prompt to automatically clear input when validation fails
+- 9bd8072: Add a `required` option to autocomplete multiselect.
+- 19558b9: Added support for custom frames in spinner prompt
+
+### Patch Changes
+
+- 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.
+- aea4573: Clamp scrolling windows to 5 rows.
+- bfe0dd3: Prevents placeholder from being used as input value in text prompts
+- 55eb280: Fix placeholder rendering when using autocomplete.
+- 4d1d83b: Fixes rendering of multi-line messages and options in select prompt.
+- 6176ced: Add withGuide support to note prompt
+- 7b009df: Fix spinner clearing too many lines upwards when non-wrapping.
+- 43aed55: Change styling of disabled multi-select options to have strikethrough.
+- 17342d2: Exposes a new `SpinnerResult` type to describe the return type of `spinner`
+- 282b39e: Wrap spinner output to allow for multi-line/wrapped messages.
+- 2feaebb: Fix duplicated logs when scrolling through options with multiline messages by calculating `rowPadding` dynamically based on actual rendered lines instead of using a hardcoded value.
+- 69681ea: Strip destructive ANSI codes from task log messages.
+- b0fa7d8: Add support for wrapped messages in multi line prompts
+- 9999adf: fix note component overflow bug
+- 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.
+- 7df841d: Removed all trailing space in prompt output and fixed various padding rendering bugs.
+- 2839c66: fix(note): hard wrap text to column limit
+- 7a556ad: Updates all prompts to accept a custom `output` and `input` stream
+- 17d3650: Use a default import for picocolors to avoid run time errors in some environments.
+- 7cc8a55: Messages passed to the `stop` method of a spinner no longer have dots stripped.
+- b103ad3: Allow disabled options in multi-select and select prompts.
+- 71b5029: Add missing nullish checks around values.
+- 1a45f93: Switched from wrap-ansi to fast-wrap-ansi
+- f952592: Fixes missing guide when rendering empty log lines.
+- 372b526: Add `clear` method to spinner for stopping and clearing.
+- d25f6d0: fix(note, box): handle CJK correctly
+- 94fee2a: Changes `placeholder` to be a visual hint rather than a tabbable value.
+- 7530af0: Fixes wrapping of cancelled and success messages of select prompt
+- 4c89dd7: chore: use more accurate type to replace any in group select
+- 0b852e1: Handle `stop` calls on spinners which have not yet been started.
+- 42adff8: fix: add missing guide line in autocomplete-multiselect
+- 8e2e30a: fix: fix autocomplete bar color when validate
+- 2048eb1: Fix spinner's dots behavior with custom frames
+- acc4c3a: Add a new `withGuide` option to all prompts to disable the default clack border
+- 9b92161: Show symbol when withGuide is true for log messages
+- 68dbf9b: select-key: Fixed wrapping and added new `caseSensitive` option
+- 09e596c: refactor(progress): remove unnecessary return statement in start function
+- 2310b43: Allow custom writables as output stream.
+- ae84dd0: Update key binding text to show tab/space when navigating, and tab otherwise.
+- Updated dependency on `@clack/core` to `1.0.0`
 
 ## 0.10.0
 

package/node_modules/@clack/prompts/README.md

@@ -86,7 +86,7 @@ const projectType = await select({
   message: 'Pick a project type.',
   options: [
     { value: 'ts', label: 'TypeScript' },
-    { value: 'js', label: 'JavaScript' },
+    { value: 'js', label: 'JavaScript', disabled: true },
     { value: 'coffee', label: 'CoffeeScript', hint: 'oh no' },
   ],
 });
@@ -103,13 +103,35 @@ const additionalTools = await multiselect({
   message: 'Select additional tools.',
   options: [
     { value: 'eslint', label: 'ESLint', hint: 'recommended' },
-    { value: 'prettier', label: 'Prettier' },
+    { value: 'prettier', label: 'Prettier', disabled: true },
     { value: 'gh-action', label: 'GitHub Action' },
   ],
   required: false,
 });
 ```
 
+It is also possible to select multiple items arranged into hierarchy by using `groupMultiselect`:
+
+```js
+import { groupMultiselect } from '@clack/prompts';
+
+const basket = await groupMultiselect({
+  message: 'Select your favorite fruits and vegetables:',
+  options: {
+    fruits: [
+      { value: 'apple', label: 'apple' },
+      { value: 'banana', label: 'banana' },
+      { value: 'cherry', label: 'cherry' },
+    ],
+    vegetables: [
+      { value: 'carrot', label: 'carrot' },
+      { value: 'spinach', label: 'spinach' },
+      { value: 'potato', label: 'potato' },
+    ]
+  }
+});
+```
+
 ### Spinner
 
 The spinner component surfaces a pending action, such as a long-running download or dependency installation.
@@ -123,6 +145,23 @@ s.start('Installing via npm');
 s.stop('Installed via npm');
 ```
 
+### Progress
+
+The progress component extends the spinner component to add a progress bar to visualize the progression of an action.
+
+```js
+import { progress } from '@clack/prompts';
+
+const p = progress({ max: 10 });
+p.start('Downloading archive');
+// Do download here
+p.advance(3, 'Downloading (30%)');
+// ...
+p.advance(8, 'Downloading (80%)');
+// ...
+p.stop('Archive downloaded');
+```
+
 ## Utilities
 
 ### Grouping
@@ -164,7 +203,9 @@ console.log(group.name, group.age, group.color);
 Execute multiple tasks in spinners.
 
 ```js
-await p.tasks([
+import { tasks } from '@clack/prompts';
+
+await tasks([
   {
     title: 'Installing via npm',
     task: async (message) => {
@@ -205,3 +246,25 @@ stream.message((function *() { yield 'Hello'; yield ", World" })(), { symbol: co
 ```
 
 ![clack-log-prompts](https://github.com/bombshell-dev/clack/blob/main/.github/assets/clack-logs.png)
+
+### Task Log
+
+When executing a sub-process or a similar sub-task, `taskLog` can be used to render the output continuously and clear it at the end if it was successful.
+
+```js
+import { taskLog } from '@clack/prompts';
+
+const log = taskLog({
+	title: 'Running npm install'
+});
+
+for await (const line of npmInstall()) {
+	log.message(line);
+}
+
+if (success) {
+	log.success('Done!');
+} else {
+	log.error('Failed!');
+}
+```