@greenpandastudios/aug-cli 0.19.0 → 0.20.1

package/docs/examples/drop/resource.md

@@ -29,6 +29,7 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "resource.aug.md" explains this file. Read it before changes; refresh with aug spec.
 Resource() implements IResource:
     drop():
         pass
@@ -37,6 +38,7 @@ interface IResource:
 ```
 
 ```aug [Braces]
+// aug-spec: "resource.aug.md" explains this file. Read it before changes; refresh with aug spec.
 Resource() implements IResource {
     drop() {
         pass
@@ -55,40 +57,15 @@ interface IResource {
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### `Resource` · class · [source](resource.md#code) {#symbol-Resource}
 
-### In this file
+It implements [`IResource`](resource.md#symbol-IResource).
 
-- [`Resource`](resource.md#symbol-Resource) is a class implementing `IResource`.
-- [`IResource`](resource.md#symbol-IResource) is an interface.
+#### `Resource.drop` · [source](resource.md#code) {#symbol-Resource.drop}
 
-### `Resource` {#symbol-Resource}
+It continues without an operation.
 
-[source](resource.md#code)
-
-Behavioral class.
-
-Satisfies [`IResource`](resource.md#symbol-IResource).
-
-#### `Resource.drop` {#symbol-Resource.drop}
-
-[source](resource.md#code)
-
-Returns: no value.
-
-**What it does**
-
-- Continue without another operation.
-
-### `IResource` {#symbol-IResource}
-
-[source](resource.md#code)
-
-Interface.
-
-### Shared language rules
-
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+### `IResource` · interface · [source](resource.md#code) {#symbol-IResource}
 
 ::::
 

package/docs/examples/errors/errors.md

@@ -29,14 +29,16 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
-load(bool fail) returns string unless FileError:
+// aug-spec: "errors.aug.md" explains this file. Read it before changes; refresh with aug spec.
+load(bool fail):
     if fail:
         throw FileError()
     return "loaded"
 ```
 
 ```aug [Braces]
-load(bool fail) returns string unless FileError {
+// aug-spec: "errors.aug.md" explains this file. Read it before changes; refresh with aug spec.
+load(bool fail) {
     if fail {
         throw FileError()
     }
@@ -52,33 +54,11 @@ load(bool fail) returns string unless FileError {
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### `load` · [source](errors.md#code) {#symbol-load}
 
-### In this file
+It takes `fail` as a boolean. Failures can raise `FileError`.
 
-- [`load`](errors.md#symbol-load) is a function returning `string`.
-
-### `load` {#symbol-load}
-
-[source](errors.md#code)
-
-**Inputs**
-
-- `fail` (`bool`) — required labeled input.
-
-Returns: `string`.
-
-Can fail with `FileError`. Callers must catch or propagate these errors.
-
-**What it does**
-
-- If `fail` is true:
-  - Fail with call `FileError`. Transfer control to a matching catch or propagate the failure.
-- Return `"loaded"`.
-
-### Shared language rules
-
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+It checks that `fail` is false. It raises a `FileError` at the first failed check. It returns `"loaded"`.
 
 ::::
 

package/docs/examples/errors/index.md

@@ -12,7 +12,7 @@ outline: [2, 3]
 
 Declare errors with unless, catch them, and run cleanup.
 
-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.
+Open a file to read its source beside the explanation produced by `aug spec`. **Indentation** and **Braces** display the same checked program; your choice carries across file pages.
 
 ## Project files
 
@@ -22,12 +22,13 @@ Read a file below to see its highlighted source and the Markdown produced by `au
 
 ## Try this project
 
-From a repository checkout with August installed:
+[Download this project](/downloads/errors.zip), then extract the archive in an empty working folder. It contains the checked source, configuration, and generated specs. [Install August](../../getting-started.md) once, then run these commands. Native libraries are prepared automatically when needed:
 
 ```sh
-aug check examples/errors
-aug spec examples/errors
-aug run examples/errors
+cd errors
+aug check .
+aug spec .
+aug run .
 ```
 
 [Browse all examples](../index.md)

package/docs/examples/errors/main.md

@@ -29,6 +29,7 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import load from errors
 try:
     print(value=load(fail=true))
@@ -37,6 +38,7 @@ catch FileError error:
 ```
 
 ```aug [Braces]
+// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import load from errors
 try {
     print(value=load(fail=true))
@@ -54,38 +56,15 @@ catch FileError error {
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### Startup
 
-### In this file
+It prints [`load`](errors.md#symbol-load) with `fail` `true`. If this work raises `FileError`, it prints `"caught FileError"`.
 
-- Run startup operations with checked error recovery.
+### Dependencies
 
-### Startup, in source order
+It uses [`load`](errors.md#symbol-load) from `errors`.
 
-- Try these operations:
-  - Call `print` with `value` = call [`load`](errors.md#symbol-load) with `fail` = `true`.
-- If they fail with `FileError`, name the failure `error` and recover:
-  - Call `print` with `value` = `"caught FileError"`.
-
-### Dependencies used by this file
-
-Only referenced types and operations appear here. Each name links to its complete specification.
-
-#### [`load`](errors.md#symbol-load)
-
-Function from `errors`.
-
-- [`load`](errors.md#symbol-load) (`fail`: `bool`) → `string`; can fail with `FileError`.
-
-### 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.
+Built-in operations follow the [language reference](https://greenpandastudios.github.io/augscript/language-constructs).
 
 ::::
 

package/docs/examples/ffi/index.md

@@ -12,7 +12,7 @@ outline: [2, 3]
 
 Declare a C operation and call it inside an unsafe block.
 
-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.
+Open a file to read its source beside the explanation produced by `aug spec`. **Indentation** and **Braces** display the same checked program; your choice carries across file pages.
 
 ## Project files
 
@@ -22,12 +22,13 @@ Read a file below to see its highlighted source and the Markdown produced by `au
 
 ## Try this project
 
-From a repository checkout with August installed:
+[Download this project](/downloads/ffi.zip), then extract the archive in an empty working folder. It contains the checked source, configuration, and generated specs. [Install August](../../getting-started.md) once, then run these commands. Native libraries are prepared automatically when needed:
 
 ```sh
-aug check examples/ffi
-aug spec examples/ffi
-aug run examples/ffi
+cd ffi
+aug check .
+aug spec .
+aug run .
 ```
 
 [Browse all examples](../index.md)

package/docs/examples/ffi/main.md

@@ -29,11 +29,13 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import announce from native
 announce()
 ```
 
 ```aug [Braces]
+// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import announce from native
 announce()
 ```
@@ -46,29 +48,13 @@ announce()
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### Startup
 
-### In this file
+It calls [`announce`](native.md#symbol-announce).
 
-- Run 1 other startup step in source order.
+### Dependencies
 
-### Startup, in source order
-
-- Call [`announce`](native.md#symbol-announce).
-
-### Dependencies used by this file
-
-Only referenced types and operations appear here. Each name links to its complete specification.
-
-#### [`announce`](native.md#symbol-announce)
-
-Function from `native`.
-
-- [`announce`](native.md#symbol-announce) (no caller inputs) → `void`; uses `C.puts`.
-
-### Shared language rules
-
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+It uses [`announce`](native.md#symbol-announce) from `native`.
 
 ::::
 

package/docs/examples/ffi/native.md

@@ -29,15 +29,17 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "native.aug.md" explains this file. Read it before changes; refresh with aug spec.
 extern C puts(string message) returns c_int
-announce() uses C.puts:
+announce():
     unsafe:
         puts(message="hello from C FFI")
 ```
 
 ```aug [Braces]
+// aug-spec: "native.aug.md" explains this file. Read it before changes; refresh with aug spec.
 extern C puts(string message) returns c_int
-announce() uses C.puts {
+announce() {
     unsafe {
         puts(message="hello from C FFI")
     }
@@ -52,41 +54,13 @@ announce() uses C.puts {
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### `puts` · [source](native.md#code) {#symbol-puts}
 
-### In this file
+It takes `message` as a string. It returns `c_int`. Native C implementation; only its declared contract is visible here.
 
-- [`puts`](native.md#symbol-puts) is a function returning `c_int`.
-- [`announce`](native.md#symbol-announce) is a function.
+### `announce` · [source](native.md#code) {#symbol-announce}
 
-### `puts` {#symbol-puts}
-
-[source](native.md#code)
-
-**Inputs**
-
-- `message` (`string`) — required labeled input.
-
-Returns: `c_int`.
-
-Native C operation. Its declared inputs, result, effects, and errors are the visible contract. The C implementation is outside this specification.
-
-### `announce` {#symbol-announce}
-
-[source](native.md#code)
-
-Returns: no value.
-
-Capabilities: `C.puts`.
-
-**What it does**
-
-- Enter an unsafe boundary. Native calls use their declared contracts; their foreign implementation is outside this specification:
-  - Call [`puts`](native.md#symbol-puts) with `message` = `"hello from C FFI"`.
-
-### Shared language rules
-
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+Within an unsafe block, it calls [`puts`](native.md#symbol-puts) with `message` `"hello from C FFI"`. Native operations must satisfy their declared C contracts.
 
 ::::
 

package/docs/examples/generic-di/dependencies/august/0.20.1/io/contracts.md

@@ -0,0 +1,178 @@
+---
+title: "august/0.20.1/io/contracts.aug · Generic dependency injection"
+generated: true
+source: "examples/generic-di/.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`
+
+[Generic dependency injection](../../../../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/generic-di/index.md

@@ -12,7 +12,7 @@ outline: [2, 3]
 
 Bind a generic interface and resolve a class that uses it.
 
-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.
+Open a file to read its source beside the explanation produced by `aug spec`. **Indentation** and **Braces** display the same checked program; your choice carries across file pages.
 
 ## Project files
 
@@ -22,12 +22,13 @@ Read a file below to see its highlighted source and the Markdown produced by `au
 
 ## Try this project
 
-From a repository checkout with August installed:
+[Download this project](/downloads/generic-di.zip), then extract the archive in an empty working folder. It contains the checked source, configuration, and generated specs. [Install August](../../getting-started.md) once, then run these commands. Native libraries are prepared automatically when needed:
 
 ```sh
-aug check examples/generic-di
-aug spec examples/generic-di
-aug run examples/generic-di
+cd generic-di
+aug check .
+aug spec .
+aug run .
 ```
 
 [Browse all examples](../index.md)

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

@@ -29,6 +29,7 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console and SystemConsole from august.io
 implement Console with SystemConsole
 import Repository from types
@@ -41,6 +42,7 @@ program.start()
 ```
 
 ```aug [Braces]
+// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console and SystemConsole from august.io
 implement Console with SystemConsole
 import Repository from types
@@ -60,51 +62,19 @@ program.start()
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### Providers
 
-### In this file
+`Console` is provided by [`SystemConsole`](dependencies/august/0.20.1/io/contracts.md#symbol-SystemConsole). The same instance is shared. `Repository<int>` is provided by [`NumberRepository`](types.md#symbol-NumberRepository). The same instance is shared.
 
-- Register 3 dependency providers before startup.
-- Run 2 other startup steps in source order.
+`app` is provided by [`Program`](types.md#symbol-Program). The same instance is shared. It requires bindings for `Repository<int>`.
 
-### Dependency providers
+### Startup
 
-Register these providers before startup. Their declaration order does not set initialization order; shared instances initialize in dependency order.
+It sets `program` to the instance provided for `app`. It calls [`program.start`](types.md#symbol-Program.start) using injected `Console` for `console`.
 
-- 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>`.
+### Dependencies
 
-### 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.
+It uses [`SystemConsole`](dependencies/august/0.20.1/io/contracts.md#symbol-SystemConsole) from `august.io`. It uses [`NumberRepository`](types.md#symbol-NumberRepository) and [`Program`](types.md#symbol-Program) ([`start`](types.md#symbol-Program.start)) from `types`.
 
 ::::