@greenpandastudios/aug-cli 0.19.0 → 0.20.1

package/examples/new-syntax/.aug-spec/august/0.19.0/io/contracts.aug.md

@@ -1,316 +0,0 @@
-<!-- Generated by aug spec. Edit the August source, then regenerate. -->
-
-# `contracts.aug` specification
-
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
-
-## In this file
-
-- [`Console`](contracts.aug.md#symbol-Console) is a capability interface.
-- [`SystemConsole`](contracts.aug.md#symbol-SystemConsole) is a class implementing `Console`.
-- [`FileReader`](contracts.aug.md#symbol-FileReader) is a capability interface.
-- [`FileWriter`](contracts.aug.md#symbol-FileWriter) is a capability interface.
-- [`LocalFiles`](contracts.aug.md#symbol-LocalFiles) is a class implementing `FileReader`, `FileWriter`.
-- [`Arguments`](contracts.aug.md#symbol-Arguments) is a capability interface.
-- [`ProcessArguments`](contracts.aug.md#symbol-ProcessArguments) is a class implementing `Arguments`.
-
-<a id="symbol-Console"></a>
-
-## `Console`
-
-[source](contracts.aug#L3)
-
-Capability interface.
-
-**Author documentation**
-
-Permission to write to a console, provided by an explicitly selected adapter.
-
-<a id="symbol-Console.write"></a>
-
-### `Console.write`
-
-[source](contracts.aug#L5)
-
-Type parameters: `T`.
-
-**Inputs**
-
-- `value` (`T`) — required labeled input.
-
-Returns: no value.
-
-Capabilities: [`Console.write`](contracts.aug.md#symbol-Console.write).
-
-Interface contract. A selected implementation supplies the behavior.
-
-**Author documentation**
-
-Write one line of text.
-
-**Parameters**
-- `value`: Text to display.
-
-<a id="symbol-SystemConsole"></a>
-
-## `SystemConsole`
-
-[source](contracts.aug#L8)
-
-Behavioral class.
-
-Satisfies [`Console`](contracts.aug.md#symbol-Console).
-
-**Author documentation**
-
-The native standard-output adapter. Construction performs no output.
-
-<a id="symbol-SystemConsole.write"></a>
-
-### `SystemConsole.write`
-
-[source](contracts.aug#L9)
-
-Type parameters: `T`.
-
-**Inputs**
-
-- `value` (`T`) — required labeled input.
-
-Returns: no value.
-
-Capabilities: [`Console.write`](contracts.aug.md#symbol-Console.write).
-
-**What it does**
-
-- Call `print` with `value` = `value`.
-
-**Author documentation**
-
-Write one line of text.
-
-**Parameters**
-- `value`: Text to display.
-
-<a id="symbol-FileReader"></a>
-
-## `FileReader`
-
-[source](contracts.aug#L13)
-
-Capability interface.
-
-**Author documentation**
-
-Read UTF-8 text through an explicitly selected filesystem adapter.
-
-<a id="symbol-FileReader.read"></a>
-
-### `FileReader.read`
-
-[source](contracts.aug#L15)
-
-**Inputs**
-
-- `path` (`string`) — required labeled input.
-
-Returns: `string`.
-
-Capabilities: [`FileReader.read`](contracts.aug.md#symbol-FileReader.read).
-
-Can fail with `FileError`. Callers must catch or propagate these errors.
-
-Interface contract. A selected implementation supplies the behavior.
-
-**Author documentation**
-
-Read text.
-
-**Parameters**
-- `path`: File path.
-
-**Throws**
-- `FileError`: The file could not be read.
-
-<a id="symbol-FileWriter"></a>
-
-## `FileWriter`
-
-[source](contracts.aug#L18)
-
-Capability interface.
-
-**Author documentation**
-
-Write UTF-8 text through an explicitly selected filesystem adapter.
-
-<a id="symbol-FileWriter.write"></a>
-
-### `FileWriter.write`
-
-[source](contracts.aug#L20)
-
-**Inputs**
-
-- `path` (`string`) — required labeled input.
-- `content` (`string`) — required labeled input.
-
-Returns: no value.
-
-Capabilities: [`FileWriter.write`](contracts.aug.md#symbol-FileWriter.write).
-
-Can fail with `FileError`. Callers must catch or propagate these errors.
-
-Interface contract. A selected implementation supplies the behavior.
-
-**Author documentation**
-
-Write text.
-
-**Parameters**
-- `path`: File path.
-- `content`: Text.
-
-**Throws**
-- `FileError`: Writing failed.
-
-<a id="symbol-LocalFiles"></a>
-
-## `LocalFiles`
-
-[source](contracts.aug#L23)
-
-Behavioral class.
-
-Satisfies [`FileReader`](contracts.aug.md#symbol-FileReader), [`FileWriter`](contracts.aug.md#symbol-FileWriter).
-
-**Author documentation**
-
-Native files. Operations are explicit; construction opens no files.
-
-<a id="symbol-LocalFiles.read"></a>
-
-### `LocalFiles.read`
-
-[source](contracts.aug#L24)
-
-**Inputs**
-
-- `path` (`string`) — required labeled input.
-
-Returns: `string`.
-
-Capabilities: [`FileReader.read`](contracts.aug.md#symbol-FileReader.read).
-
-Can fail with `FileError`. Callers must catch or propagate these errors.
-
-**What it does**
-
-- Return call `read_file` with `path` = `path`.
-
-**Author documentation**
-
-Read text.
-
-**Parameters**
-- `path`: File path.
-
-**Throws**
-- `FileError`: The file could not be read.
-
-<a id="symbol-LocalFiles.write"></a>
-
-### `LocalFiles.write`
-
-[source](contracts.aug#L26)
-
-**Inputs**
-
-- `path` (`string`) — required labeled input.
-- `content` (`string`) — required labeled input.
-
-Returns: no value.
-
-Capabilities: [`FileWriter.write`](contracts.aug.md#symbol-FileWriter.write).
-
-Can fail with `FileError`. Callers must catch or propagate these errors.
-
-**What it does**
-
-- Call `write_file` with `path` = `path`; `content` = `content`.
-
-**Author documentation**
-
-Write text.
-
-**Parameters**
-- `path`: File path.
-- `content`: Text.
-
-**Throws**
-- `FileError`: Writing failed.
-
-<a id="symbol-Arguments"></a>
-
-## `Arguments`
-
-[source](contracts.aug#L30)
-
-Capability interface.
-
-**Author documentation**
-
-Read command-line input through an explicit dependency.
-
-<a id="symbol-Arguments.read"></a>
-
-### `Arguments.read`
-
-[source](contracts.aug#L31)
-
-Returns: `List<string>`.
-
-Capabilities: [`Arguments.read`](contracts.aug.md#symbol-Arguments.read).
-
-Interface contract. A selected implementation supplies the behavior.
-
-<a id="symbol-ProcessArguments"></a>
-
-## `ProcessArguments`
-
-[source](contracts.aug#L34)
-
-Behavioral class.
-
-Satisfies [`Arguments`](contracts.aug.md#symbol-Arguments).
-
-**Author documentation**
-
-Native command-line arguments.
-
-<a id="symbol-ProcessArguments.read"></a>
-
-### `ProcessArguments.read`
-
-[source](contracts.aug#L35)
-
-Returns: `List<string>`.
-
-Capabilities: [`Arguments.read`](contracts.aug.md#symbol-Arguments.read).
-
-**What it does**
-
-- Return call `arguments`.
-
-## Built-in operations used by this file
-
-- `arguments` (no inputs) → `List<string>`: Composition arguments. Other callables receive the Arguments capability.
-- `print` (`value`: `any`) → `void`: Composition and test output. Other callables receive Console and declare uses console.write.
-- `read_file` (`path`: `string`) → `string`: Root-only UTF-8 text input. Other callables receive FileReader. Invalid Unicode and NUL raise FileError. Can fail with `FileError`.
-- `write_file` (`path`: `string`, `content`: `string`) → `void`: Root-only UTF-8 text output. Other callables receive FileWriter. Can fail with `FileError`.
-
-[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.