@greenpandastudios/aug-cli 0.19.0

package/docs/examples/generic-di/main.md

@@ -0,0 +1,111 @@
+---
+title: "main.aug · Generic dependency injection"
+generated: true
+source: "examples/generic-di/main.aug"
+editLink: false
+prev: false
+next: false
+outline: [2, 3]
+pageClass: aug-example-page
+---
+
+# `main.aug`
+
+[Generic dependency injection](index.md) · Source and specification
+
+::: details Files in this project
+
+- [`main.aug`](main.md)
+- [`types.aug`](types.md)
+
+:::
+
+::::: example-compare
+
+:::: example-code
+
+## Code {#code}
+
+::: code-group
+
+```aug [Indentation]
+import Console and SystemConsole from august.io
+implement Console with SystemConsole
+import Repository from types
+import NumberRepository from types
+import Program from types
+implement Repository<int> with NumberRepository
+implement app with Program
+resolve app to program
+program.start()
+```
+
+```aug [Braces]
+import Console and SystemConsole from august.io
+implement Console with SystemConsole
+import Repository from types
+import NumberRepository from types
+import Program from types
+implement Repository<int> with NumberRepository
+implement app with Program
+resolve app to program
+program.start()
+```
+
+:::
+
+::::
+
+:::: example-spec
+
+## Compiled specification {#specification}
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+### In this file
+
+- Register 3 dependency providers before startup.
+- Run 2 other startup steps in source order.
+
+### Dependency providers
+
+Register these providers before startup. Their declaration order does not set initialization order; shared instances initialize in dependency order.
+
+- Provide [`SystemConsole`](dependencies/august/0.19.0/io/contracts.md#symbol-SystemConsole) when `Console` is requested. Reuse one instance.
+- Provide [`NumberRepository`](types.md#symbol-NumberRepository) when `Repository<int>` is requested. Reuse one instance.
+- Provide [`Program`](types.md#symbol-Program) when `app` is requested. Reuse one instance. Required dependencies: `Repository<int>`.
+
+### Startup, in source order
+
+- Set `program` to the instance provided for `app`.
+- Call [`Program.start`](types.md#symbol-Program.start) on `program`; inject `console` from `Console`.
+
+### Dependencies used by this file
+
+Only referenced types and operations appear here. Each name links to its complete specification.
+
+#### [`SystemConsole`](dependencies/august/0.19.0/io/contracts.md#symbol-SystemConsole)
+
+Class from `august.io`.
+
+Used as a type or provider.
+
+#### [`NumberRepository`](types.md#symbol-NumberRepository)
+
+Class from `types`.
+
+Used as a type or provider.
+
+#### [`Program`](types.md#symbol-Program)
+
+Class from `types`.
+
+- [`Program.start`](types.md#symbol-Program.start) (no caller inputs) → `void`; inject `console`: [`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console); uses [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
+
+### Shared language rules
+
+See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+
+::::
+
+:::::

package/docs/examples/generic-di/types.md

@@ -0,0 +1,180 @@
+---
+title: "types.aug · Generic dependency injection"
+generated: true
+source: "examples/generic-di/types.aug"
+editLink: false
+prev: false
+next: false
+outline: [2, 3]
+pageClass: aug-example-page
+---
+
+# `types.aug`
+
+[Generic dependency injection](index.md) · Source and specification
+
+::: details Files in this project
+
+- [`main.aug`](main.md)
+- [`types.aug`](types.md)
+
+:::
+
+::::: example-compare
+
+:::: example-code
+
+## Code {#code}
+
+::: code-group
+
+```aug [Indentation]
+import Console from august.io
+interface Repository<T>:
+    get() returns T
+NumberRepository() implements Repository<int>:
+    get() returns int:
+        return 7
+Program(resolve Repository<int> repository) implements IProgram:
+    start(resolve Console console) uses Console.write:
+        console.write(value=repository.get())
+interface IProgram:
+    start(resolve Console console) uses Console.write
+```
+
+```aug [Braces]
+import Console from august.io
+interface Repository<T> {
+    get() returns T
+}
+NumberRepository() implements Repository<int> {
+    get() returns int {
+        return 7
+    }
+}
+Program(resolve Repository<int> repository) implements IProgram {
+    start(resolve Console console) uses Console.write {
+        console.write(value=repository.get())
+    }
+}
+interface IProgram {
+    start(resolve Console console) uses Console.write
+}
+```
+
+:::
+
+::::
+
+:::: example-spec
+
+## Compiled specification {#specification}
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+### In this file
+
+- [`Repository`](types.md#symbol-Repository) is an interface.
+- [`NumberRepository`](types.md#symbol-NumberRepository) is a class implementing `Repository<int>`.
+- [`Program`](types.md#symbol-Program) is a class implementing `IProgram`.
+- [`IProgram`](types.md#symbol-IProgram) is an interface.
+
+### `Repository` {#symbol-Repository}
+
+[source](types.md#code)
+
+Interface.
+
+Type parameters: `T`.
+
+#### `Repository.get` {#symbol-Repository.get}
+
+[source](types.md#code)
+
+Returns: `T`.
+
+Interface contract. A selected implementation supplies the behavior.
+
+### `NumberRepository` {#symbol-NumberRepository}
+
+[source](types.md#code)
+
+Behavioral class.
+
+Satisfies [`Repository`](types.md#symbol-Repository).
+
+#### `NumberRepository.get` {#symbol-NumberRepository.get}
+
+[source](types.md#code)
+
+Returns: `int`.
+
+**What it does**
+
+- Return `7`.
+
+### `Program` {#symbol-Program}
+
+[source](types.md#code)
+
+Behavioral class.
+
+Satisfies [`IProgram`](types.md#symbol-IProgram).
+
+**Inputs**
+
+- `repository` ([`Repository<int>`](types.md#symbol-Repository)) — injected; callers omit it — stored as `repository` and read-only after initialization.
+
+#### `Program.start` {#symbol-Program.start}
+
+[source](types.md#code)
+
+**Inputs**
+
+- `console` ([`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console)) — injected; callers omit it.
+
+Returns: no value.
+
+Capabilities: [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
+
+**What it does**
+
+- Call [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write) on `console` with `value` = call [`Repository.get`](types.md#symbol-Repository.get) on `repository`.
+
+### `IProgram` {#symbol-IProgram}
+
+[source](types.md#code)
+
+Interface.
+
+#### `IProgram.start` {#symbol-IProgram.start}
+
+[source](types.md#code)
+
+**Inputs**
+
+- `console` ([`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console)) — injected; callers omit it.
+
+Returns: no value.
+
+Capabilities: [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
+
+Interface contract. A selected implementation supplies the behavior.
+
+### Dependencies used by this file
+
+Only referenced types and operations appear here. Each name links to its complete specification.
+
+#### [`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console)
+
+Capability interface from `august.io`.
+
+- [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write)<`T`> (`value`: `T`) → `void`.
+
+### Shared language rules
+
+See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+
+::::
+
+:::::

package/docs/examples/generics/index.md

@@ -0,0 +1,33 @@
+---
+title: "Generic contracts"
+generated: true
+source: "examples/generics"
+editLink: false
+prev: false
+next: false
+outline: [2, 3]
+---
+
+# Generic contracts
+
+Write reusable records, interfaces, classes, and functions with type parameters.
+
+Read a file below to see its highlighted source and the Markdown produced by `aug spec`. Choose **Indentation** or **Braces** above the code. Both views describe the same checked program; your choice is kept when you open another file.
+
+## Project files
+
+- [`main.aug`](main.md)
+- [`types.aug`](types.md)
+
+
+## Try this project
+
+From a repository checkout with August installed:
+
+```sh
+aug check examples/generics
+aug spec examples/generics
+aug run examples/generics
+```
+
+[Browse all examples](../index.md)

package/docs/examples/generics/main.md

@@ -0,0 +1,120 @@
+---
+title: "main.aug · Generic contracts"
+generated: true
+source: "examples/generics/main.aug"
+editLink: false
+prev: false
+next: false
+outline: [2, 3]
+pageClass: aug-example-page
+---
+
+# `main.aug`
+
+[Generic contracts](index.md) · Source and specification
+
+::: details Files in this project
+
+- [`main.aug`](main.md)
+- [`types.aug`](types.md)
+
+:::
+
+::::: example-compare
+
+:::: example-code
+
+## Code {#code}
+
+::: code-group
+
+```aug [Indentation]
+import Formatter from types
+import TextFormatter from types
+import Box from types
+implement Formatter with TextFormatter
+resolve Formatter to formatter
+print(value=formatter.title())
+print(value=formatter.format<int>(value=42))
+box = Box<string>(value="inside a generic box")
+print(value=box.get())
+```
+
+```aug [Braces]
+import Formatter from types
+import TextFormatter from types
+import Box from types
+implement Formatter with TextFormatter
+resolve Formatter to formatter
+print(value=formatter.title())
+print(value=formatter.format<int>(value=42))
+box = Box<string>(value="inside a generic box")
+print(value=box.get())
+```
+
+:::
+
+::::
+
+:::: example-spec
+
+## Compiled specification {#specification}
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+### In this file
+
+- Register 1 dependency provider before startup.
+- Run 5 other startup steps in source order.
+
+### Dependency providers
+
+Register these providers before startup. Their declaration order does not set initialization order; shared instances initialize in dependency order.
+
+- Provide [`TextFormatter`](types.md#symbol-TextFormatter) when `Formatter` is requested. Reuse one instance.
+
+### Startup, in source order
+
+- Set `formatter` to the instance provided for `Formatter`.
+- Call `print` with `value` = call [`Formatter.title`](types.md#symbol-Formatter.title) on `formatter`.
+- Call `print` with `value` = call [`Formatter.format`](types.md#symbol-Formatter.format) on `formatter` with type arguments `int` with `value` = `42`.
+- Set `box` to call [`Box`](types.md#symbol-Box) with type arguments `string` with `value` = `"inside a generic box"`.
+- Call `print` with `value` = call [`Box.get`](types.md#symbol-Box.get) on `box`.
+
+### Dependencies used by this file
+
+Only referenced types and operations appear here. Each name links to its complete specification.
+
+#### [`Box`](types.md#symbol-Box)
+
+Class from `types`.
+
+- Construct with `value`: `T` → [`Box`](types.md#symbol-Box).
+- [`Box.get`](types.md#symbol-Box.get) (no caller inputs) → `T`.
+
+#### [`Formatter`](types.md#symbol-Formatter)
+
+Interface from `types`.
+
+- [`Formatter.format`](types.md#symbol-Formatter.format)<`T`> (`value`: `T`) → `string`.
+- [`Formatter.title`](types.md#symbol-Formatter.title) (no caller inputs) → `string`.
+
+#### [`TextFormatter`](types.md#symbol-TextFormatter)
+
+Class from `types`.
+
+Used as a type or provider.
+
+### Built-in operations used by this file
+
+- `print` (`value`: `any`) → `void`: Composition and test output. Other callables receive Console and declare uses console.write.
+
+[Full built-in reference](https://greenpandastudios.github.io/augscript/language-constructs).
+
+### Shared language rules
+
+See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+
+::::
+
+:::::

package/docs/examples/generics/types.md

@@ -0,0 +1,189 @@
+---
+title: "types.aug · Generic contracts"
+generated: true
+source: "examples/generics/types.aug"
+editLink: false
+prev: false
+next: false
+outline: [2, 3]
+pageClass: aug-example-page
+---
+
+# `types.aug`
+
+[Generic contracts](index.md) · Source and specification
+
+::: details Files in this project
+
+- [`main.aug`](main.md)
+- [`types.aug`](types.md)
+
+:::
+
+::::: example-compare
+
+:::: example-code
+
+## Code {#code}
+
+::: code-group
+
+```aug [Indentation]
+interface Formatter:
+    format<T>(T value) returns string
+    title() returns string:
+        return "formatted"
+TextFormatter() implements Formatter:
+    format<T>(T value) returns string:
+        return "generic method called"
+Box<T>(T value) implements IBox<T>:
+    get() returns T:
+        return value
+interface IBox<T>:
+    get() returns T
+```
+
+```aug [Braces]
+interface Formatter {
+    format<T>(T value) returns string
+    title() returns string {
+        return "formatted"
+    }
+}
+TextFormatter() implements Formatter {
+    format<T>(T value) returns string {
+        return "generic method called"
+    }
+}
+Box<T>(T value) implements IBox<T> {
+    get() returns T {
+        return value
+    }
+}
+interface IBox<T> {
+    get() returns T
+}
+```
+
+:::
+
+::::
+
+:::: example-spec
+
+## Compiled specification {#specification}
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+### In this file
+
+- [`Formatter`](types.md#symbol-Formatter) is an interface.
+- [`TextFormatter`](types.md#symbol-TextFormatter) is a class implementing `Formatter`.
+- [`Box`](types.md#symbol-Box) is a class implementing `IBox<T>`.
+- [`IBox`](types.md#symbol-IBox) is an interface.
+
+### `Formatter` {#symbol-Formatter}
+
+[source](types.md#code)
+
+Interface.
+
+#### `Formatter.format` {#symbol-Formatter.format}
+
+[source](types.md#code)
+
+Type parameters: `T`.
+
+**Inputs**
+
+- `value` (`T`) — required labeled input.
+
+Returns: `string`.
+
+Interface contract. A selected implementation supplies the behavior.
+
+#### `Formatter.title` {#symbol-Formatter.title}
+
+[source](types.md#code)
+
+Returns: `string`.
+
+**What it does**
+
+- Return `"formatted"`.
+
+### `TextFormatter` {#symbol-TextFormatter}
+
+[source](types.md#code)
+
+Behavioral class.
+
+Satisfies [`Formatter`](types.md#symbol-Formatter).
+
+**Inherited default behavior**
+
+- [`Formatter.title`](types.md#symbol-Formatter.title).
+
+#### `TextFormatter.format` {#symbol-TextFormatter.format}
+
+[source](types.md#code)
+
+Type parameters: `T`.
+
+**Inputs**
+
+- `value` (`T`) — required labeled input.
+
+Returns: `string`.
+
+**What it does**
+
+- Return `"generic method called"`.
+
+### `Box` {#symbol-Box}
+
+[source](types.md#code)
+
+Behavioral class.
+
+Type parameters: `T`.
+
+Satisfies [`IBox`](types.md#symbol-IBox).
+
+**Inputs**
+
+- `value` (`T`) — required labeled input — stored as `value` and read-only after initialization.
+
+#### `Box.get` {#symbol-Box.get}
+
+[source](types.md#code)
+
+Returns: `T`.
+
+**What it does**
+
+- Return `value`.
+
+### `IBox` {#symbol-IBox}
+
+[source](types.md#code)
+
+Interface.
+
+Type parameters: `T`.
+
+#### `IBox.get` {#symbol-IBox.get}
+
+[source](types.md#code)
+
+Returns: `T`.
+
+Interface contract. A selected implementation supplies the behavior.
+
+### Shared language rules
+
+See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+
+::::
+
+:::::

package/docs/examples/hello/app/export.md

@@ -0,0 +1,67 @@
+---
+title: "app/export.aug · Hello world with dependencies"
+generated: true
+source: "examples/hello/app/export.aug"
+editLink: false
+prev: false
+next: false
+outline: [2, 3]
+pageClass: aug-example-page
+---
+
+# `app/export.aug`
+
+[Hello world with dependencies](../index.md) · Source and specification
+
+::: details Files in this project
+
+- [`main.aug`](../main.md)
+- [`app/export.aug`](export.md)
+- [`app/greeter.aug`](greeter.md)
+- [`logging/console.aug`](../logging/console.md)
+- [`logging/export.aug`](../logging/export.md)
+- [`logging/logger.aug`](../logging/logger.md)
+
+:::
+
+::::: example-compare
+
+:::: example-code
+
+## Code {#code}
+
+::: code-group
+
+```aug [Indentation]
+export Greeter from greeter
+```
+
+```aug [Braces]
+export Greeter from greeter
+```
+
+:::
+
+::::
+
+:::: example-spec
+
+## Compiled specification {#specification}
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+### In this file
+
+- Export `Greeter` from this folder.
+
+### Folder exports
+
+- Export the declaration `Greeter` from [`greeter.aug`](greeter.md#symbol-Greeter).
+
+### Shared language rules
+
+See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+
+::::
+
+:::::