@greenpandastudios/aug-cli 0.19.0 → 0.20.1

package/docs/examples/approved-design/counters.md

@@ -33,23 +33,24 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "counters.aug.md" explains this file. Read it before changes; refresh with aug spec.
 /** Reading state has no mutation effect. */
 interface State:
     read() returns int
 _Initial() implements State:
-    read() returns int:
+    read():
         return 0
 _Updated(int count) implements State:
-    read() returns int:
+    read():
         return count
 /** A mutable counter with an explicit transition contract. */
 interface Counter:
     increment() changes self
     value() returns int
 _Counter(resolve mutable State initial to _state) implements Counter:
-    increment() changes self:
+    increment():
         _state to _Updated(count=_state.read() + 1)
-    value() returns int:
+    value():
         return _state.read()
 /** The complete counter composition; its mutable state belongs to each scope. */
 composition Counters:
@@ -58,17 +59,18 @@ composition Counters:
 ```
 
 ```aug [Braces]
+// aug-spec: "counters.aug.md" explains this file. Read it before changes; refresh with aug spec.
 /** Reading state has no mutation effect. */
 interface State {
     read() returns int
 }
 _Initial() implements State {
-    read() returns int {
+    read() {
         return 0
     }
 }
 _Updated(int count) implements State {
-    read() returns int {
+    read() {
         return count
     }
 }
@@ -78,10 +80,10 @@ interface Counter {
     value() returns int
 }
 _Counter(resolve mutable State initial to _state) implements Counter {
-    increment() changes self {
+    increment() {
         _state to _Updated(count=_state.read() + 1)
     }
-    value() returns int {
+    value() {
         return _state.read()
     }
 }
@@ -100,153 +102,59 @@ composition Counters {
 
 ## 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
-
-- [`State`](counters.md#symbol-State) is an interface.
-- [`_Initial`](counters.md#symbol-_Initial) is a class implementing `State`.
-- [`_Updated`](counters.md#symbol-_Updated) is a class implementing `State`.
-- [`Counter`](counters.md#symbol-Counter) is an interface.
-- [`_Counter`](counters.md#symbol-_Counter) is a class implementing `Counter`.
-- [`Counters`](counters.md#symbol-Counters) declares 2 providers.
-
-### `State` {#symbol-State}
-
-[source](counters.md#code)
-
-Interface.
-
-**Author documentation**
+### `State` · interface · [source](counters.md#code) {#symbol-State}
 
 Reading state has no mutation effect.
 
-#### `State.read` {#symbol-State.read}
-
-[source](counters.md#code)
-
-Returns: `int`.
-
-Interface contract. A selected implementation supplies the behavior.
-
-### `Counter` {#symbol-Counter}
-
-[source](counters.md#code)
+#### `State.read` · [source](counters.md#code) {#symbol-State.read}
 
-Interface.
+It returns `int`.
 
-**Author documentation**
+### `Counter` · interface · [source](counters.md#code) {#symbol-Counter}
 
 A mutable counter with an explicit transition contract.
 
-#### `Counter.increment` {#symbol-Counter.increment}
+#### `Counter.increment` · [source](counters.md#code) {#symbol-Counter.increment}
 
-[source](counters.md#code)
+It may change `self`.
 
-Returns: no value.
+#### `Counter.value` · [source](counters.md#code) {#symbol-Counter.value}
 
-May change: `self`.
+It returns `int`.
 
-Interface contract. A selected implementation supplies the behavior.
-
-#### `Counter.value` {#symbol-Counter.value}
-
-[source](counters.md#code)
-
-Returns: `int`.
-
-Interface contract. A selected implementation supplies the behavior.
-
-### `Counters` {#symbol-Counters}
-
-[source](counters.md#code)
-
-**Author documentation**
+### `Counters` · [source](counters.md#code) {#symbol-Counters}
 
 The complete counter composition; its mutable state belongs to each scope.
 
-This composition declares these providers before startup:
-
-- Provide [`_Initial`](counters.md#symbol-_Initial) when `State` is requested. Reuse one instance.
-- Provide [`_Counter`](counters.md#symbol-_Counter) when `Counter` is requested. Reuse one instance per explicit scope. Permit explicit shared mutation. Required dependencies: `State`.
-
-### `_Initial` {#symbol-_Initial}
-
-[source](counters.md#code)
-
-Behavioral class, private to this file.
-
-Satisfies [`State`](counters.md#symbol-State).
-
-#### `_Initial.read` {#symbol-_Initial.read}
-
-[source](counters.md#code)
-
-Returns: `int`.
-
-**What it does**
-
-- Return `0`.
-
-### `_Updated` {#symbol-_Updated}
-
-[source](counters.md#code)
-
-Behavioral class, private to this file.
-
-Satisfies [`State`](counters.md#symbol-State).
-
-**Inputs**
-
-- `count` (`int`) — required labeled input — stored as `count` and read-only after initialization.
-
-#### `_Updated.read` {#symbol-_Updated.read}
-
-[source](counters.md#code)
-
-Returns: `int`.
-
-**What it does**
-
-- Return `count`.
-
-### `_Counter` {#symbol-_Counter}
-
-[source](counters.md#code)
-
-Behavioral class, private to this file.
-
-Satisfies [`Counter`](counters.md#symbol-Counter).
-
-**Inputs**
+These providers are registered before startup. `State` is provided by [`_Initial`](counters.md#symbol-_Initial). The same instance is shared. `Counter` is provided by [`_Counter`](counters.md#symbol-_Counter). Each scope shares one instance. Shared mutation is allowed. It requires bindings for `State`.
 
-- `initial` ([`State`](counters.md#symbol-State)) — injected; callers omit it — stored as `_state` (private) and mutable.
+### `_Initial` · class · [source](counters.md#code) {#symbol-_Initial}
 
-#### `_Counter.increment` {#symbol-_Counter.increment}
+It implements [`State`](counters.md#symbol-State). It is private to this file.
 
-[source](counters.md#code)
+#### `_Initial.read` · [source](counters.md#code) {#symbol-_Initial.read}
 
-Returns: no value.
+It returns `0`.
 
-May change: `self`.
+### `_Updated` · class · [source](counters.md#code) {#symbol-_Updated}
 
-**What it does**
+It implements [`State`](counters.md#symbol-State). It is private to this file. It takes `count` as an integer, kept read-only.
 
-- Set `_state` to call [`_Updated`](counters.md#symbol-_Updated) with `count` = (call [`State.read`](counters.md#symbol-State.read) on `_state` plus `1`).
+#### `_Updated.read` · [source](counters.md#code) {#symbol-_Updated.read}
 
-#### `_Counter.value` {#symbol-_Counter.value}
+It returns `count`.
 
-[source](counters.md#code)
+### `_Counter` · class · [source](counters.md#code) {#symbol-_Counter}
 
-Returns: `int`.
+It implements [`Counter`](counters.md#symbol-Counter). It is private to this file. The `_state` dependency is injected as [`State`](counters.md#symbol-State) and stored mutably and privately.
 
-**What it does**
+#### `_Counter.increment` · [source](counters.md#code) {#symbol-_Counter.increment}
 
-- Return call [`State.read`](counters.md#symbol-State.read) on `_state`.
+It may change `self`. It sets `_state` to a [`_Updated`](counters.md#symbol-_Updated) with `count` from [`_state.read`](counters.md#symbol-State.read) plus `1`.
 
-### Shared language rules
+#### `_Counter.value` · [source](counters.md#code) {#symbol-_Counter.value}
 
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+It returns [`_state.read`](counters.md#symbol-State.read).
 
 ::::
 

package/docs/examples/approved-design/dependencies/august/0.20.1/io/contracts.md

@@ -0,0 +1,178 @@
+---
+title: "august/0.20.1/io/contracts.aug · Modules and composition"
+generated: true
+source: "examples/approved-design/.aug-spec/august/0.20.1/io/contracts.aug"
+editLink: false
+prev: false
+next: false
+outline: [2, 3]
+search: false
+pageClass: aug-example-page
+---
+
+# `august/0.20.1/io/contracts.aug`
+
+[Modules and composition](../../../../index.md) · Dependency source and specification
+
+This is the exact dependency version used by this example.
+
+::::: example-compare
+
+:::: example-code
+
+## Code {#code}
+
+::: code-group
+
+```aug [Indentation]
+// aug-spec: "contracts.aug.md" explains this file. Read it before changes; refresh with aug spec.
+/** Permission to write to a console, provided by an explicitly selected adapter. */
+capability Console:
+    /** Write one line of text. @param value Text to display. */
+    write<T>(T value) uses Console.write
+/** The native standard-output adapter. Construction performs no output. */
+SystemConsole() implements Console:
+    write<T>(T value):
+        print(value=value)
+/** Read UTF-8 text through an explicitly selected filesystem adapter. */
+capability FileReader:
+    /** Read text. @param path File path. @throws FileError The file could not be read. */
+    read(string path) returns string uses FileReader.read unless FileError
+/** Write UTF-8 text through an explicitly selected filesystem adapter. */
+capability FileWriter:
+    /** Write text. @param path File path. @param content Text. @throws FileError Writing failed. */
+    write(string path, string content) uses FileWriter.write unless FileError
+/** Native files. Operations are explicit; construction opens no files. */
+LocalFiles() implements FileReader, FileWriter:
+    read(string path):
+        return read_file(path=path)
+    write(string path, string content):
+        write_file(path=path, content=content)
+/** Read command-line input through an explicit dependency. */
+capability Arguments:
+    read() returns List<string> uses Arguments.read
+/** Native command-line arguments. */
+ProcessArguments() implements Arguments:
+    read():
+        return arguments()
+```
+
+```aug [Braces]
+// aug-spec: "contracts.aug.md" explains this file. Read it before changes; refresh with aug spec.
+/** Permission to write to a console, provided by an explicitly selected adapter. */
+capability Console {
+    /** Write one line of text. @param value Text to display. */
+    write<T>(T value) uses Console.write
+}
+/** The native standard-output adapter. Construction performs no output. */
+SystemConsole() implements Console {
+    write<T>(T value) {
+        print(value=value)
+    }
+}
+/** Read UTF-8 text through an explicitly selected filesystem adapter. */
+capability FileReader {
+    /** Read text. @param path File path. @throws FileError The file could not be read. */
+    read(string path) returns string uses FileReader.read unless FileError
+}
+/** Write UTF-8 text through an explicitly selected filesystem adapter. */
+capability FileWriter {
+    /** Write text. @param path File path. @param content Text. @throws FileError Writing failed. */
+    write(string path, string content) uses FileWriter.write unless FileError
+}
+/** Native files. Operations are explicit; construction opens no files. */
+LocalFiles() implements FileReader, FileWriter {
+    read(string path) {
+        return read_file(path=path)
+    }
+    write(string path, string content) {
+        write_file(path=path, content=content)
+    }
+}
+/** Read command-line input through an explicit dependency. */
+capability Arguments {
+    read() returns List<string> uses Arguments.read
+}
+/** Native command-line arguments. */
+ProcessArguments() implements Arguments {
+    read() {
+        return arguments()
+    }
+}
+```
+
+:::
+
+::::
+
+:::: example-spec
+
+## Compiled specification {#specification}
+
+### `Console` · capability interface · [source](contracts.md#code) {#symbol-Console}
+
+Permission to write to a console, provided by an explicitly selected adapter.
+
+#### `Console.write` · [source](contracts.md#code) {#symbol-Console.write}
+
+Write one line of text. The type parameters are `T`. It takes `value` as `T` (Text to display). It can call [`Console.write`](contracts.md#symbol-Console.write).
+
+### `SystemConsole` · class · [source](contracts.md#code) {#symbol-SystemConsole}
+
+The native standard-output adapter. Construction performs no output. It implements [`Console`](contracts.md#symbol-Console).
+
+#### `SystemConsole.write` · [source](contracts.md#code) {#symbol-SystemConsole.write}
+
+Write one line of text. The type parameters are `T`. It takes `value` as `T` (Text to display). It prints `value`.
+
+### `FileReader` · capability interface · [source](contracts.md#code) {#symbol-FileReader}
+
+Read UTF-8 text through an explicitly selected filesystem adapter.
+
+#### `FileReader.read` · [source](contracts.md#code) {#symbol-FileReader.read}
+
+Read text. It takes `path` as a string (File path).
+
+It returns `string`. It can call [`FileReader.read`](contracts.md#symbol-FileReader.read). Failures can raise `FileError` (The file could not be read).
+
+### `FileWriter` · capability interface · [source](contracts.md#code) {#symbol-FileWriter}
+
+Write UTF-8 text through an explicitly selected filesystem adapter.
+
+#### `FileWriter.write` · [source](contracts.md#code) {#symbol-FileWriter.write}
+
+Write text. It takes `path` as a string (File path) and `content` as a string (Text). It can call [`FileWriter.write`](contracts.md#symbol-FileWriter.write). Failures can raise `FileError` (Writing failed).
+
+### `LocalFiles` · class · [source](contracts.md#code) {#symbol-LocalFiles}
+
+Native files. Operations are explicit; construction opens no files. It implements [`FileReader`](contracts.md#symbol-FileReader) and [`FileWriter`](contracts.md#symbol-FileWriter).
+
+#### `LocalFiles.read` · [source](contracts.md#code) {#symbol-LocalFiles.read}
+
+Read text. It takes `path` as a string (File path). Failures can raise `FileError` (The file could not be read). It returns `read_file` with `path`.
+
+#### `LocalFiles.write` · [source](contracts.md#code) {#symbol-LocalFiles.write}
+
+Write text. It takes `path` as a string (File path) and `content` as a string (Text). Failures can raise `FileError` (Writing failed). It calls `write_file` with `path` and `content`.
+
+### `Arguments` · capability interface · [source](contracts.md#code) {#symbol-Arguments}
+
+Read command-line input through an explicit dependency.
+
+#### `Arguments.read` · [source](contracts.md#code) {#symbol-Arguments.read}
+
+It returns `List<string>`. It can call [`Arguments.read`](contracts.md#symbol-Arguments.read).
+
+### `ProcessArguments` · class · [source](contracts.md#code) {#symbol-ProcessArguments}
+
+Native command-line arguments. It implements [`Arguments`](contracts.md#symbol-Arguments).
+
+#### `ProcessArguments.read` · [source](contracts.md#code) {#symbol-ProcessArguments.read}
+
+It returns `arguments`.
+
+Built-in operations follow the [language reference](https://greenpandastudios.github.io/augscript/language-constructs).
+
+::::
+
+:::::

package/docs/examples/approved-design/domain/app.md

@@ -33,6 +33,7 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "app.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console from august.io
 import Fruit from models
 /** The application's explicit startup operation. */
@@ -41,13 +42,14 @@ interface Application:
     start() uses Console.write
 /** Construction stores dependencies; start performs the visible external work. */
 ApplicationImpl(resolve Console console) implements Application:
-    start() uses console.write:
+    start():
         fruit to [Fruit(code=1, name="apple"), Fruit(name="pear", code=2)]
         for item in fruit:
             console.write(value=item.name)
 ```
 
 ```aug [Braces]
+// aug-spec: "app.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console from august.io
 import Fruit from models
 /** The application's explicit startup operation. */
@@ -57,7 +59,7 @@ interface Application {
 }
 /** Construction stores dependencies; start performs the visible external work. */
 ApplicationImpl(resolve Console console) implements Application {
-    start() uses console.write {
+    start() {
         fruit to [Fruit(code=1, name="apple"), Fruit(name="pear", code=2)]
         for item in fruit {
             console.write(value=item.name)
@@ -74,91 +76,25 @@ ApplicationImpl(resolve Console console) implements Application {
 
 ## 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
-
-- [`Application`](app.md#symbol-Application) is an interface.
-- [`ApplicationImpl`](app.md#symbol-ApplicationImpl) is a class implementing `Application`.
-
-### `Application` {#symbol-Application}
-
-[source](app.md#code)
-
-Interface.
-
-**Author documentation**
+### `Application` · interface · [source](app.md#code) {#symbol-Application}
 
 The application's explicit startup operation.
 
-#### `Application.start` {#symbol-Application.start}
-
-[source](app.md#code)
-
-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.
-
-**Author documentation**
-
-Writes the fruit names through the selected console.
-
-### `ApplicationImpl` {#symbol-ApplicationImpl}
-
-[source](app.md#code)
-
-Behavioral class.
-
-Satisfies [`Application`](app.md#symbol-Application).
-
-**Author documentation**
-
-Construction stores dependencies; start performs the visible external work.
-
-**Inputs**
-
-- `console` ([`Console`](../dependencies/august/0.19.0/io/contracts.md#symbol-Console)) — injected; callers omit it — stored as `console` and read-only after initialization.
-
-#### `ApplicationImpl.start` {#symbol-ApplicationImpl.start}
-
-[source](app.md#code)
-
-Returns: no value.
-
-Capabilities: [`console.write`](../dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
-
-**What it does**
-
-- Set `fruit` to a list containing call [`Fruit`](models.md#symbol-Fruit) with `code` = `1`; `name` = `"apple"`, call [`Fruit`](models.md#symbol-Fruit) with `name` = `"pear"`; `code` = `2`.
-- For each `item` in a snapshot of `fruit`, in iteration order:
-  - Call [`Console.write`](../dependencies/august/0.19.0/io/contracts.md#symbol-Console.write) on `console` with `value` = `name` of `item`.
-
-**Author documentation**
-
-Writes the fruit names through the selected console.
-
-### 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)
+#### `Application.start` · [source](app.md#code) {#symbol-Application.start}
 
-Capability interface from `august.io`.
+Writes the fruit names through the selected console. It can call [`Console.write`](../dependencies/august/0.20.1/io/contracts.md#symbol-Console.write).
 
-- [`Console.write`](../dependencies/august/0.19.0/io/contracts.md#symbol-Console.write)<`T`> (`value`: `T`) → `void`.
+### `ApplicationImpl` · class · [source](app.md#code) {#symbol-ApplicationImpl}
 
-#### [`Fruit`](models.md#symbol-Fruit)
+Construction stores dependencies; start performs the visible external work. It implements [`Application`](app.md#symbol-Application). The `console` dependency is injected as [`Console`](../dependencies/august/0.20.1/io/contracts.md#symbol-Console) and stored read-only.
 
-Record from `models`.
+#### `ApplicationImpl.start` · [source](app.md#code) {#symbol-ApplicationImpl.start}
 
-- Construct with `code`: `int`, `name`: `string` → [`Fruit`](models.md#symbol-Fruit).
-- Read `name` (`string`).
+Writes the fruit names through the selected console. It sets `fruit` to a list containing a [`Fruit`](models.md#symbol-Fruit) with `code` `1` and `name` `"apple"`, a [`Fruit`](models.md#symbol-Fruit) with `name` `"pear"` and `code` `2`. For each `item` in a snapshot of `fruit`, it passes `item.name` to [`console.write`](../dependencies/august/0.20.1/io/contracts.md#symbol-Console.write).
 
-### Shared language rules
+### Dependencies
 
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+It uses [`Console`](../dependencies/august/0.20.1/io/contracts.md#symbol-Console) ([`write`](../dependencies/august/0.20.1/io/contracts.md#symbol-Console.write)) from `august.io`. It uses [`Fruit`](models.md#symbol-Fruit) (`name`) from `models`.
 
 ::::
 

package/docs/examples/approved-design/domain/export.md

@@ -33,6 +33,7 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "export.aug.md" explains this file. Read it before changes; refresh with aug spec.
 export Application from app
 export ApplicationImpl from app
 export Fruit from models
@@ -41,6 +42,7 @@ export RangeError from numbers
 ```
 
 ```aug [Braces]
+// aug-spec: "export.aug.md" explains this file. Read it before changes; refresh with aug spec.
 export Application from app
 export ApplicationImpl from app
 export Fruit from models
@@ -56,27 +58,11 @@ export RangeError from numbers
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### Exports
 
-### In this file
+Export the declaration `Application` from [`app.aug`](app.md#symbol-Application). Export the declaration `ApplicationImpl` from [`app.aug`](app.md#symbol-ApplicationImpl). Export the declaration `Fruit` from [`models.aug`](models.md#symbol-Fruit). Export the declaration `double` from [`numbers.aug`](numbers.md#symbol-double).
 
-- Export `Application` from this folder.
-- Export `ApplicationImpl` from this folder.
-- Export `Fruit` from this folder.
-- Export `double` from this folder.
-- Export `RangeError` from this folder.
-
-### Folder exports
-
-- Export the declaration `Application` from [`app.aug`](app.md#symbol-Application).
-- Export the declaration `ApplicationImpl` from [`app.aug`](app.md#symbol-ApplicationImpl).
-- Export the declaration `Fruit` from [`models.aug`](models.md#symbol-Fruit).
-- Export the declaration `double` from [`numbers.aug`](numbers.md#symbol-double).
-- Export the declaration `RangeError` from [`numbers.aug`](numbers.md#symbol-RangeError).
-
-### Shared language rules
-
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+Export the declaration `RangeError` from [`numbers.aug`](numbers.md#symbol-RangeError).
 
 ::::
 

package/docs/examples/approved-design/domain/models.md

@@ -33,11 +33,13 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "models.aug.md" explains this file. Read it before changes; refresh with aug spec.
 /** Immutable fruit data, with public construction labels and structural equality. */
 record Fruit(int code, string name)
 ```
 
 ```aug [Braces]
+// aug-spec: "models.aug.md" explains this file. Read it before changes; refresh with aug spec.
 /** Immutable fruit data, with public construction labels and structural equality. */
 record Fruit(int code, string name)
 ```
@@ -50,30 +52,9 @@ record Fruit(int code, string name)
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### `Fruit` · immutable record · [source](models.md#code) {#symbol-Fruit}
 
-### In this file
-
-- [`Fruit`](models.md#symbol-Fruit) is an immutable record.
-
-### `Fruit` {#symbol-Fruit}
-
-[source](models.md#code)
-
-Immutable record.
-
-**Author documentation**
-
-Immutable fruit data, with public construction labels and structural equality.
-
-**Inputs**
-
-- `code` (`int`) — required labeled input — stored as `code` and read-only after initialization.
-- `name` (`string`) — required labeled input — stored as `name` and read-only after initialization.
-
-### Shared language rules
-
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+Immutable fruit data, with public construction labels and structural equality. It takes `code` as an integer, kept read-only and `name` as a string, kept read-only.
 
 ::::