update dependencies (#322)

Effect-TS · Sep 1, 2023 · 79befce · 79befce
1 parent 6a0fc8c
commit 79befce
Show file tree

Hide file tree

Showing 10 changed files with 927 additions and 815 deletions.
diff --git a/.changeset/fresh-foxes-raise.md b/.changeset/fresh-foxes-raise.md
@@ -0,0 +1,5 @@
+---
+"@effect/cli": minor
+---
+
+update dependencies
diff --git a/docs/modules/Args.ts.md b/docs/modules/Args.ts.md
@@ -44,6 +44,10 @@ Added in v1.0.0
 - [symbols](#symbols)
   - [ArgsTypeId](#argstypeid)
   - [ArgsTypeId (type alias)](#argstypeid-type-alias)
+- [utils](#utils)
+  - [Args (namespace)](#args-namespace)
+    - [ArgsConfig (interface)](#argsconfig-interface)
+    - [Variance (interface)](#variance-interface)
 - [validation](#validation)
   - [validate](#validate)
 - [zipping](#zipping)
@@ -331,7 +335,7 @@ Represents arguments that can be passed to a command-line application.
 **Signature**
 
 ```ts
-export interface Args<A> extends Args.Variance<A> {}
+export interface Args<A> extends Args.Variance<A>, Pipeable {}
 ```
 
 Added in v1.0.0
@@ -370,6 +374,38 @@ export type ArgsTypeId = typeof ArgsTypeId
 
 Added in v1.0.0
 
+# utils
+
+## Args (namespace)
+
+Added in v1.0.0
+
+### ArgsConfig (interface)
+
+**Signature**
+
+```ts
+export interface ArgsConfig {
+  readonly name?: string
+}
+```
+
+Added in v1.0.0
+
+### Variance (interface)
+
+**Signature**
+
+```ts
+export interface Variance<A> {
+  readonly [ArgsTypeId]: {
+    readonly _A: (_: never) => A
+  }
+}
+```
+
+Added in v1.0.0
+
 # validation
 
 ## validate

diff --git a/docs/modules/CliApp.ts.md b/docs/modules/CliApp.ts.md
@@ -18,6 +18,9 @@ Added in v1.0.0
   - [run](#run)
 - [models](#models)
   - [CliApp (interface)](#cliapp-interface)
+- [utils](#utils)
+  - [CliApp (namespace)](#cliapp-namespace)
+    - [Context (type alias)](#context-type-alias)
 
 ---
 
@@ -79,3 +82,19 @@ export interface CliApp<A> {
 ```
 
 Added in v1.0.0
+
+# utils
+
+## CliApp (namespace)
+
+Added in v1.0.0
+
+### Context (type alias)
+
+**Signature**
+
+```ts
+export type Context = Console
+```
+
+Added in v1.0.0
diff --git a/docs/modules/Command.ts.md b/docs/modules/Command.ts.md
@@ -34,6 +34,14 @@ Added in v1.0.0
 - [symbols](#symbols)
   - [CommandTypeId](#commandtypeid)
   - [CommandTypeId (type alias)](#commandtypeid-type-alias)
+- [utils](#utils)
+  - [Command (namespace)](#command-namespace)
+    - [ConstructorConfig (interface)](#constructorconfig-interface)
+    - [Variance (interface)](#variance-interface)
+    - [ComputeParsedType (type alias)](#computeparsedtype-type-alias)
+    - [GetParsedType (type alias)](#getparsedtype-type-alias)
+    - [Parsed (type alias)](#parsed-type-alias)
+    - [Subcommands (type alias)](#subcommands-type-alias)
 
 ---
 
@@ -198,7 +206,7 @@ commands.
 **Signature**
 
 ```ts
-export interface Command<A> extends Command.Variance<A> {}
+export interface Command<A> extends Command.Variance<A>, Pipeable {}
 ```
 
 Added in v1.0.0
@@ -245,3 +253,80 @@ export type CommandTypeId = typeof CommandTypeId
 ```
 
 Added in v1.0.0
+
+# utils
+
+## Command (namespace)
+
+Added in v1.0.0
+
+### ConstructorConfig (interface)
+
+**Signature**
+
+```ts
+export interface ConstructorConfig<OptionsType = void, ArgsType = void> {
+  readonly options?: Options<OptionsType>
+  readonly args?: Args<ArgsType>
+}
+```
+
+Added in v1.0.0
+
+### Variance (interface)
+
+**Signature**
+
+```ts
+export interface Variance<A> {
+  readonly [CommandTypeId]: {
+    readonly _A: (_: never) => A
+  }
+}
+```
+
+Added in v1.0.0
+
+### ComputeParsedType (type alias)
+
+**Signature**
+
+```ts
+export type ComputeParsedType<A> = { [K in keyof A]: A[K] } extends infer X ? X : never
+```
+
+Added in v1.0.0
+
+### GetParsedType (type alias)
+
+**Signature**
+
+```ts
+export type GetParsedType<C> = C extends Command<infer P> ? P : never
+```
+
+Added in v1.0.0
+
+### Parsed (type alias)
+
+**Signature**
+
+```ts
+export type Parsed<Name extends string, OptionsType, ArgsType> = Command.ComputeParsedType<{
+  readonly name: Name
+  readonly options: OptionsType
+  readonly args: ArgsType
+}>
+```
+
+Added in v1.0.0
+
+### Subcommands (type alias)
+
+**Signature**
+
+```ts
+export type Subcommands<A extends NonEmptyReadonlyArray<Command<any>>> = GetParsedType<A[number]>
+```
+
+Added in v1.0.0
diff --git a/docs/modules/Options.ts.md b/docs/modules/Options.ts.md
@@ -54,6 +54,10 @@ Added in v1.0.0
 - [symbols](#symbols)
   - [OptionsTypeId](#optionstypeid)
   - [OptionsTypeId (type alias)](#optionstypeid-type-alias)
+- [utils](#utils)
+  - [Options (namespace)](#options-namespace)
+    - [BooleanOptionConfig (interface)](#booleanoptionconfig-interface)
+    - [Variance (interface)](#variance-interface)
 - [validation](#validation)
   - [validate](#validate)
 - [zipping](#zipping)
@@ -467,7 +471,7 @@ Added in v1.0.0
 **Signature**
 
 ```ts
-export interface Options<A> extends Options.Variance<A> {}
+export interface Options<A> extends Options.Variance<A>, Pipeable {}
 ```
 
 Added in v1.0.0
@@ -521,6 +525,39 @@ export type OptionsTypeId = typeof OptionsTypeId
 
 Added in v1.0.0
 
+# utils
+
+## Options (namespace)
+
+Added in v1.0.0
+
+### BooleanOptionConfig (interface)
+
+**Signature**
+
+```ts
+export interface BooleanOptionConfig {
+  readonly ifPresent?: boolean
+  readonly negationNames?: NonEmptyReadonlyArray<string>
+}
+```
+
+Added in v1.0.0
+
+### Variance (interface)
+
+**Signature**
+
+```ts
+export interface Variance<A> {
+  readonly [OptionsTypeId]: {
+    _A: (_: never) => A
+  }
+}
+```
+
+Added in v1.0.0
+
 # validation
 
 ## validate

diff --git a/docs/modules/Primitive.ts.md b/docs/modules/Primitive.ts.md
@@ -36,6 +36,10 @@ Added in v1.0.0
 - [symbol](#symbol)
   - [PrimitiveTypeId](#primitivetypeid)
   - [PrimitiveTypeId (type alias)](#primitivetypeid-type-alias)
+- [utils](#utils)
+  - [Primitive (namespace)](#primitive-namespace)
+    - [Variance (interface)](#variance-interface)
+    - [ValueType (type alias)](#valuetype-type-alias)
 - [validation](#validation)
   - [validate](#validate)
 
@@ -280,6 +284,44 @@ export type PrimitiveTypeId = typeof PrimitiveTypeId
 
 Added in v1.0.0
 
+# utils
+
+## Primitive (namespace)
+
+Added in v1.0.0
+
+### Variance (interface)
+
+**Signature**
+
+```ts
+export interface Variance<A> extends Pipeable {
+  readonly [PrimitiveTypeId]: {
+    readonly _A: (_: never) => A
+  }
+}
+```
+
+Added in v1.0.0
+
+### ValueType (type alias)
+
+**Signature**
+
+```ts
+export type ValueType<P> = [P] extends [
+  {
+    readonly [PrimitiveTypeId]: {
+      readonly _A: (_: never) => infer A
+    }
+  }
+]
+  ? A
+  : never
+```
+
+Added in v1.0.0
+
 # validation
 
 ## validate

diff --git a/docs/modules/ValidationError.ts.md b/docs/modules/ValidationError.ts.md
@@ -34,6 +34,10 @@ Added in v1.0.0
 - [symbols](#symbols)
   - [ValidationErrorTypeId](#validationerrortypeid)
   - [ValidationErrorTypeId (type alias)](#validationerrortypeid-type-alias)
+- [utils](#utils)
+  - [ValidationError (namespace)](#validationerror-namespace)
+    - [Proto (interface)](#proto-interface)
+    - [Type (type alias)](#type-type-alias)
 
 ---
 
@@ -219,3 +223,37 @@ export type ValidationErrorTypeId = typeof ValidationErrorTypeId
 ```
 
 Added in v1.0.0
+
+# utils
+
+## ValidationError (namespace)
+
+Added in v1.0.0
+
+### Proto (interface)
+
+**Signature**
+
+```ts
+export interface Proto {
+  readonly [ValidationErrorTypeId]: ValidationErrorTypeId
+}
+```
+
+Added in v1.0.0
+
+### Type (type alias)
+
+**Signature**
+
+```ts
+export type Type =
+  | 'ExtraneousValue'
+  | 'InvalidValue'
+  | 'MissingValue'
+  | 'CommandMismatch'
+  | 'MissingSubCommand'
+  | 'InvalidArgument'
+```
+
+Added in v1.0.0