From 258dd69add4efd8bbd86fa52079bc51ced6ce744 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 19 Dec 2024 14:27:41 -0600 Subject: [PATCH] [ci] release (#214) Co-authored-by: github-actions[bot] Co-authored-by: Nate Moore --- .changeset/kind-llamas-beam.md | 25 ---------- .changeset/lucky-maps-beam.md | 38 ---------------- .changeset/quiet-actors-wink.md | 14 ------ .changeset/swift-jars-destroy.md | 5 -- .changeset/thin-moose-tease.md | 5 -- packages/core/CHANGELOG.md | 42 +++++++++++++++++ packages/core/package.json | 7 ++- packages/prompts/CHANGELOG.md | 78 ++++++++++++++++++++++++++++++++ packages/prompts/package.json | 7 ++- 9 files changed, 130 insertions(+), 91 deletions(-) delete mode 100644 .changeset/kind-llamas-beam.md delete mode 100644 .changeset/lucky-maps-beam.md delete mode 100644 .changeset/quiet-actors-wink.md delete mode 100644 .changeset/swift-jars-destroy.md delete mode 100644 .changeset/thin-moose-tease.md diff --git a/.changeset/kind-llamas-beam.md b/.changeset/kind-llamas-beam.md deleted file mode 100644 index 7aad706b..00000000 --- a/.changeset/kind-llamas-beam.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -"@clack/prompts": minor -"@clack/core": minor ---- - -Adds a new `updateSettings()` function to support new global keybindings. - -`updateSettings()` accepts an `aliases` object that maps custom keys to an action (`up | down | left | right | space | enter | cancel`). - -```ts -import { updateSettings } from "@clack/prompts"; - -// Support custom keybindings -updateSettings({ - aliases: { - w: "up", - a: "left", - s: "down", - d: "right", - }, -}); -``` - -> [!WARNING] -> In order to enforce consistent, user-friendly defaults across the ecosystem, `updateSettings` does not support disabling Clack's default keybindings. diff --git a/.changeset/lucky-maps-beam.md b/.changeset/lucky-maps-beam.md deleted file mode 100644 index 2f50404f..00000000 --- a/.changeset/lucky-maps-beam.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -"@clack/core": minor -"@clack/prompts": minor ---- - -Adds a new `signal` option to support programmatic prompt cancellation with an [abort controller](https://kettanaito.com/blog/dont-sleep-on-abort-controller). - -One example use case is automatically cancelling a prompt after a timeout. - -```ts -const shouldContinue = await confirm({ - message: 'This message will self destruct in 5 seconds', - signal: AbortSignal.timeout(5000), -}); -``` - -Another use case is racing a long running task with a manual prompt. - -```ts -const abortController = new AbortController() - -const projectType = await Promise.race([ - detectProjectType({ - signal: abortController.signal - }), - select({ - message: 'Pick a project type.', - options: [ - { value: 'ts', label: 'TypeScript' }, - { value: 'js', label: 'JavaScript' }, - { value: 'coffee', label: 'CoffeeScript', hint: 'oh no'}, - ], - signal: abortController.signal, - }) -]) - -abortController.abort() -``` diff --git a/.changeset/quiet-actors-wink.md b/.changeset/quiet-actors-wink.md deleted file mode 100644 index 05bfe243..00000000 --- a/.changeset/quiet-actors-wink.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -"@clack/prompts": minor -"@clack/core": minor ---- - -Updates default keybindings to support Vim motion shortcuts and map the `escape` key to cancel (`ctrl+c`). - -| alias | action | -|------- |-------- | -| `k` | up | -| `l` | right | -| `j` | down | -| `h` | left | -| `esc` | cancel | diff --git a/.changeset/swift-jars-destroy.md b/.changeset/swift-jars-destroy.md deleted file mode 100644 index 0685d4d5..00000000 --- a/.changeset/swift-jars-destroy.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@clack/core': patch ---- - -Improves types for events and interaction states. diff --git a/.changeset/thin-moose-tease.md b/.changeset/thin-moose-tease.md deleted file mode 100644 index fd459928..00000000 --- a/.changeset/thin-moose-tease.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@clack/prompts': patch ---- - -Adapts `spinner` output for static CI environments diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md index bcfdbaf4..cdfbda02 100644 --- a/packages/core/CHANGELOG.md +++ b/packages/core/CHANGELOG.md @@ -1,5 +1,47 @@ # @clack/core +## 0.4.0 + +### Minor Changes + +- a83d2f8: Adds a new `updateSettings()` function to support new global keybindings. + + `updateSettings()` accepts an `aliases` object that maps custom keys to an action (`up | down | left | right | space | enter | cancel`). + + ```ts + import { updateSettings } from "@clack/core"; + + // Support custom keybindings + updateSettings({ + aliases: { + w: "up", + a: "left", + s: "down", + d: "right", + }, + }); + ``` + +> [!WARNING] +> In order to enforce consistent, user-friendly defaults across the ecosystem, `updateSettings` does not support disabling Clack's default keybindings. + +- 801246b: Adds a new `signal` option to support programmatic prompt cancellation with an [abort controller](https://kettanaito.com/blog/dont-sleep-on-abort-controller). + + +- a83d2f8: Updates default keybindings to support Vim motion shortcuts and map the `escape` key to cancel (`ctrl+c`). + + | alias | action | + | ----- | ------ | + | `k` | up | + | `l` | right | + | `j` | down | + | `h` | left | + | `esc` | cancel | + +### Patch Changes + +- 51e12bc: Improves types for events and interaction states. + ## 0.3.5 ### Patch Changes diff --git a/packages/core/package.json b/packages/core/package.json index 753e30ba..2df375fc 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@clack/core", - "version": "0.3.5", + "version": "0.4.0", "type": "module", "main": "./dist/index.cjs", "module": "./dist/index.mjs", @@ -22,7 +22,10 @@ "url": "https://github.com/natemoo-re/clack/issues" }, "homepage": "https://github.com/natemoo-re/clack/tree/main/packages/core#readme", - "files": ["dist", "CHANGELOG.md"], + "files": [ + "dist", + "CHANGELOG.md" + ], "keywords": [ "ask", "clack", diff --git a/packages/prompts/CHANGELOG.md b/packages/prompts/CHANGELOG.md index 85f93e1e..3c44bafe 100644 --- a/packages/prompts/CHANGELOG.md +++ b/packages/prompts/CHANGELOG.md @@ -1,5 +1,83 @@ # @clack/prompts +## 0.9.0 + +### Minor Changes + +- a83d2f8: Adds a new `updateSettings()` function to support new global keybindings. + + `updateSettings()` accepts an `aliases` object that maps custom keys to an action (`up | down | left | right | space | enter | cancel`). + + ```ts + import { updateSettings } from "@clack/prompts"; + + // Support custom keybindings + updateSettings({ + aliases: { + w: "up", + a: "left", + s: "down", + d: "right", + }, + }); + ``` + +> [!WARNING] +> In order to enforce consistent, user-friendly defaults across the ecosystem, `updateSettings` does not support disabling Clack's default keybindings. + +- 801246b: Adds a new `signal` option to support programmatic prompt cancellation with an [abort controller](https://kettanaito.com/blog/dont-sleep-on-abort-controller). + + One example use case is automatically cancelling a prompt after a timeout. + + ```ts + const shouldContinue = await confirm({ + message: "This message will self destruct in 5 seconds", + signal: AbortSignal.timeout(5000), + }); + ``` + + Another use case is racing a long running task with a manual prompt. + + ```ts + const abortController = new AbortController(); + + const projectType = await Promise.race([ + detectProjectType({ + signal: abortController.signal, + }), + select({ + message: "Pick a project type.", + options: [ + { value: "ts", label: "TypeScript" }, + { value: "js", label: "JavaScript" }, + { value: "coffee", label: "CoffeeScript", hint: "oh no" }, + ], + signal: abortController.signal, + }), + ]); + + abortController.abort(); + ``` + +- a83d2f8: Updates default keybindings to support Vim motion shortcuts and map the `escape` key to cancel (`ctrl+c`). + + | alias | action | + | ----- | ------ | + | `k` | up | + | `l` | right | + | `j` | down | + | `h` | left | + | `esc` | cancel | + +### Patch Changes + +- f9f139d: Adapts `spinner` output for static CI environments +- Updated dependencies [a83d2f8] +- Updated dependencies [801246b] +- Updated dependencies [a83d2f8] +- Updated dependencies [51e12bc] + - @clack/core@0.4.0 + ## 0.8.2 ### Patch Changes diff --git a/packages/prompts/package.json b/packages/prompts/package.json index 78bd1a0e..ce36b68a 100644 --- a/packages/prompts/package.json +++ b/packages/prompts/package.json @@ -1,6 +1,6 @@ { "name": "@clack/prompts", - "version": "0.8.2", + "version": "0.9.0", "type": "module", "main": "./dist/index.cjs", "module": "./dist/index.mjs", @@ -22,7 +22,10 @@ "url": "https://github.com/natemoo-re/clack/issues" }, "homepage": "https://github.com/natemoo-re/clack/tree/main/packages/prompts#readme", - "files": ["dist", "CHANGELOG.md"], + "files": [ + "dist", + "CHANGELOG.md" + ], "author": { "name": "Nate Moore", "email": "nate@natemoo.re",