From 5c4165c30686d96b9806d5bb7aa4a05bbadd0c7b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 12 Nov 2023 20:14:28 -0500 Subject: [PATCH] Version Packages (#257) Co-authored-by: github-actions[bot] --- .changeset/old-books-pump.md | 6 -- .changeset/short-ants-share.md | 7 -- docs/platform-bun/Terminal.ts.md | 83 +++++++++++++++++ docs/platform-node/Terminal.ts.md | 83 +++++++++++++++++ docs/platform/Terminal.ts.md | 121 +++++++++++++++++++++++++ packages/platform-browser/CHANGELOG.md | 7 ++ packages/platform-browser/package.json | 2 +- packages/platform-bun/CHANGELOG.md | 12 +++ packages/platform-bun/package.json | 2 +- packages/platform-node/CHANGELOG.md | 11 +++ packages/platform-node/package.json | 2 +- packages/platform/CHANGELOG.md | 6 ++ packages/platform/package.json | 2 +- 13 files changed, 327 insertions(+), 17 deletions(-) delete mode 100644 .changeset/old-books-pump.md delete mode 100644 .changeset/short-ants-share.md create mode 100644 docs/platform-bun/Terminal.ts.md create mode 100644 docs/platform-node/Terminal.ts.md create mode 100644 docs/platform/Terminal.ts.md diff --git a/.changeset/old-books-pump.md b/.changeset/old-books-pump.md deleted file mode 100644 index 0ce1615c..00000000 --- a/.changeset/old-books-pump.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -"@effect/platform-node": patch -"@effect/platform-bun": patch ---- - -fix: added missing File type export diff --git a/.changeset/short-ants-share.md b/.changeset/short-ants-share.md deleted file mode 100644 index 5e1e047b..00000000 --- a/.changeset/short-ants-share.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -"@effect/platform-node": patch -"@effect/platform-bun": patch -"@effect/platform": patch ---- - -add basic Terminal interface for prompting user input diff --git a/docs/platform-bun/Terminal.ts.md b/docs/platform-bun/Terminal.ts.md new file mode 100644 index 00000000..cf9509c2 --- /dev/null +++ b/docs/platform-bun/Terminal.ts.md @@ -0,0 +1,83 @@ +--- +title: Terminal.ts +nav_order: 18 +parent: "@effect/platform-bun" +--- + +## Terminal overview + +Added in v1.0.0 + +--- + +

Table of contents

+ +- [constructors](#constructors) + - [make](#make) +- [layer](#layer) + - [layer](#layer-1) +- [model](#model) + - [Key](#key) + - [UserInput](#userinput) +- [tag](#tag) + - [Terminal](#terminal) + +--- + +# constructors + +## make + +**Signature** + +```ts +export declare const make: (shouldQuit?: ((input: UserInput) => boolean) | undefined) => Effect +``` + +Added in v1.0.0 + +# layer + +## layer + +**Signature** + +```ts +export declare const layer: Layer +``` + +Added in v1.0.0 + +# model + +## Key + +**Signature** + +```ts +export declare const Key: Key +``` + +Added in v1.0.0 + +## UserInput + +**Signature** + +```ts +export declare const UserInput: UserInput +``` + +Added in v1.0.0 + +# tag + +## Terminal + +**Signature** + +```ts +export declare const Terminal: Tag +``` + +Added in v1.0.0 diff --git a/docs/platform-node/Terminal.ts.md b/docs/platform-node/Terminal.ts.md new file mode 100644 index 00000000..72593662 --- /dev/null +++ b/docs/platform-node/Terminal.ts.md @@ -0,0 +1,83 @@ +--- +title: Terminal.ts +nav_order: 21 +parent: "@effect/platform-node" +--- + +## Terminal overview + +Added in v1.0.0 + +--- + +

Table of contents

+ +- [constructors](#constructors) + - [make](#make) +- [layer](#layer) + - [layer](#layer-1) +- [model](#model) + - [Key](#key) + - [UserInput](#userinput) +- [tag](#tag) + - [Terminal](#terminal) + +--- + +# constructors + +## make + +**Signature** + +```ts +export declare const make: (shouldQuit?: ((input: UserInput) => boolean) | undefined) => Effect +``` + +Added in v1.0.0 + +# layer + +## layer + +**Signature** + +```ts +export declare const layer: Layer +``` + +Added in v1.0.0 + +# model + +## Key + +**Signature** + +```ts +export declare const Key: Key +``` + +Added in v1.0.0 + +## UserInput + +**Signature** + +```ts +export declare const UserInput: UserInput +``` + +Added in v1.0.0 + +# tag + +## Terminal + +**Signature** + +```ts +export declare const Terminal: Tag +``` + +Added in v1.0.0 diff --git a/docs/platform/Terminal.ts.md b/docs/platform/Terminal.ts.md new file mode 100644 index 00000000..c92d3af1 --- /dev/null +++ b/docs/platform/Terminal.ts.md @@ -0,0 +1,121 @@ +--- +title: Terminal.ts +nav_order: 31 +parent: "@effect/platform" +--- + +## Terminal overview + +Added in v1.0.0 + +--- + +

Table of contents

+ +- [model](#model) + - [Key (interface)](#key-interface) + - [QuitException (class)](#quitexception-class) + - [UserInput (interface)](#userinput-interface) +- [models](#models) + - [Terminal (interface)](#terminal-interface) +- [tag](#tag) + - [Terminal](#terminal) + +--- + +# model + +## Key (interface) + +**Signature** + +```ts +export interface Key { + /** + * The name of the key being pressed. + */ + readonly name: string + /** + * If set to `true`, then the user is also holding down the `Ctrl` key. + */ + readonly ctrl: boolean + /** + * If set to `true`, then the user is also holding down the `Meta` key. + */ + readonly meta: boolean + /** + * If set to `true`, then the user is also holding down the `Shift` key. + */ + readonly shift: boolean +} +``` + +Added in v1.0.0 + +## QuitException (class) + +A `QuitException` represents an exception that occurs when a user attempts to +quit out of a `Terminal` prompt for input (usually by entering `ctrl`+`c`). + +**Signature** + +```ts +export declare class QuitException +``` + +Added in v1.0.0 + +## UserInput (interface) + +**Signature** + +```ts +export interface UserInput { + /** + * The character read from the user (if any). + */ + readonly input: Option + /** + * The key that the user pressed. + */ + readonly key: Key +} +``` + +Added in v1.0.0 + +# models + +## Terminal (interface) + +A `Terminal` represents a command-line interface which can read input from a +user and display messages to a user. + +**Signature** + +```ts +export interface Terminal { + /** + * Reads a single input event from the default standard input. + */ + readonly readInput: Effect + /** + * Displays text to the the default standard output. + */ + readonly display: (text: string) => Effect +} +``` + +Added in v1.0.0 + +# tag + +## Terminal + +**Signature** + +```ts +export declare const Terminal: Tag +``` + +Added in v1.0.0 diff --git a/packages/platform-browser/CHANGELOG.md b/packages/platform-browser/CHANGELOG.md index a5327a7a..0742cc0b 100644 --- a/packages/platform-browser/CHANGELOG.md +++ b/packages/platform-browser/CHANGELOG.md @@ -1,5 +1,12 @@ # @effect/platform-browser +## 0.16.2 + +### Patch Changes + +- Updated dependencies [[`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc)]: + - @effect/platform@0.28.2 + ## 0.16.1 ### Patch Changes diff --git a/packages/platform-browser/package.json b/packages/platform-browser/package.json index cd876d63..f6d5d639 100644 --- a/packages/platform-browser/package.json +++ b/packages/platform-browser/package.json @@ -1,7 +1,7 @@ { "name": "@effect/platform-browser", "type": "module", - "version": "0.16.1", + "version": "0.16.2", "description": "Unified interfaces for common platform-specific services", "publishConfig": { "access": "public", diff --git a/packages/platform-bun/CHANGELOG.md b/packages/platform-bun/CHANGELOG.md index 9ce06a4c..8411c388 100644 --- a/packages/platform-bun/CHANGELOG.md +++ b/packages/platform-bun/CHANGELOG.md @@ -1,5 +1,17 @@ # @effect/platform-bun +## 0.17.2 + +### Patch Changes + +- [#256](https://github.com/Effect-TS/platform/pull/256) [`62cbddb`](https://github.com/Effect-TS/platform/commit/62cbddb530371291123dea220bfebcc0521b54df) Thanks [@jessekelly881](https://github.com/jessekelly881)! - fix: added missing File type export + +- [#255](https://github.com/Effect-TS/platform/pull/255) [`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc) Thanks [@IMax153](https://github.com/IMax153)! - add basic Terminal interface for prompting user input + +- Updated dependencies [[`62cbddb`](https://github.com/Effect-TS/platform/commit/62cbddb530371291123dea220bfebcc0521b54df), [`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc)]: + - @effect/platform-node@0.29.2 + - @effect/platform@0.28.2 + ## 0.17.1 ### Patch Changes diff --git a/packages/platform-bun/package.json b/packages/platform-bun/package.json index 64313e02..329843de 100644 --- a/packages/platform-bun/package.json +++ b/packages/platform-bun/package.json @@ -1,7 +1,7 @@ { "name": "@effect/platform-bun", "type": "module", - "version": "0.17.1", + "version": "0.17.2", "description": "Unified interfaces for common platform-specific services", "publishConfig": { "access": "public", diff --git a/packages/platform-node/CHANGELOG.md b/packages/platform-node/CHANGELOG.md index 2a18de55..f6f79c8b 100644 --- a/packages/platform-node/CHANGELOG.md +++ b/packages/platform-node/CHANGELOG.md @@ -1,5 +1,16 @@ # @effect/platform-node +## 0.29.2 + +### Patch Changes + +- [#256](https://github.com/Effect-TS/platform/pull/256) [`62cbddb`](https://github.com/Effect-TS/platform/commit/62cbddb530371291123dea220bfebcc0521b54df) Thanks [@jessekelly881](https://github.com/jessekelly881)! - fix: added missing File type export + +- [#255](https://github.com/Effect-TS/platform/pull/255) [`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc) Thanks [@IMax153](https://github.com/IMax153)! - add basic Terminal interface for prompting user input + +- Updated dependencies [[`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc)]: + - @effect/platform@0.28.2 + ## 0.29.1 ### Patch Changes diff --git a/packages/platform-node/package.json b/packages/platform-node/package.json index ccb9d924..86fd4096 100644 --- a/packages/platform-node/package.json +++ b/packages/platform-node/package.json @@ -1,7 +1,7 @@ { "name": "@effect/platform-node", "type": "module", - "version": "0.29.1", + "version": "0.29.2", "description": "Unified interfaces for common platform-specific services", "publishConfig": { "access": "public", diff --git a/packages/platform/CHANGELOG.md b/packages/platform/CHANGELOG.md index 1b1b1301..6b7c1d41 100644 --- a/packages/platform/CHANGELOG.md +++ b/packages/platform/CHANGELOG.md @@ -1,5 +1,11 @@ # @effect/platform +## 0.28.2 + +### Patch Changes + +- [#255](https://github.com/Effect-TS/platform/pull/255) [`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc) Thanks [@IMax153](https://github.com/IMax153)! - add basic Terminal interface for prompting user input + ## 0.28.1 ### Patch Changes diff --git a/packages/platform/package.json b/packages/platform/package.json index 434e938c..eaad545f 100644 --- a/packages/platform/package.json +++ b/packages/platform/package.json @@ -1,7 +1,7 @@ { "name": "@effect/platform", "type": "module", - "version": "0.28.1", + "version": "0.28.2", "description": "Unified interfaces for common platform-specific services", "publishConfig": { "access": "public",