@greenpandastudios/aug-cli 0.19.0

package/examples/ownership-transfer/resource.aug.md

@@ -0,0 +1,89 @@
+<!-- Generated by aug spec. Edit the August source, then regenerate. -->
+
+# `resource.aug` specification
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+## In this file
+
+- [`Resource`](resource.aug.md#symbol-Resource) is a class implementing `IResource`.
+- [`IResource`](resource.aug.md#symbol-IResource) is an interface.
+- [`make`](resource.aug.md#symbol-make) is a function returning `Resource`.
+- [`consume`](resource.aug.md#symbol-consume) is a function.
+
+<a id="symbol-Resource"></a>
+
+## `Resource`
+
+[source](resource.aug#L2)
+
+Behavioral class.
+
+Satisfies [`IResource`](resource.aug.md#symbol-IResource).
+
+<a id="symbol-Resource.drop"></a>
+
+### `Resource.drop`
+
+[source](resource.aug#L3)
+
+Returns: no value.
+
+**What it does**
+
+- Continue without another operation.
+
+<a id="symbol-IResource"></a>
+
+## `IResource`
+
+[source](resource.aug#L7)
+
+Interface.
+
+<a id="symbol-make"></a>
+
+## `make`
+
+[source](resource.aug#L10)
+
+Returns: ownership of [`Resource`](resource.aug.md#symbol-Resource).
+
+**What it does**
+
+- Set `value` of type [`Resource`](resource.aug.md#symbol-Resource) to call [`Resource`](resource.aug.md#symbol-Resource).
+- This variable owns the value.
+- Return `value`.
+
+<a id="symbol-consume"></a>
+
+## `consume`
+
+[source](resource.aug#L14)
+
+**Inputs**
+
+- `console` ([`Console`](.aug-spec/august/0.19.0/io/contracts.aug.md#symbol-Console)) — injected; callers omit it.
+- `value` ([`Resource`](resource.aug.md#symbol-Resource)) — required labeled input — transfers ownership.
+
+Returns: no value.
+
+Capabilities: [`Console.write`](.aug-spec/august/0.19.0/io/contracts.aug.md#symbol-Console.write).
+
+**What it does**
+
+- Call [`Console.write`](.aug-spec/august/0.19.0/io/contracts.aug.md#symbol-Console.write) on `console` with `value` = `"consumed"`.
+
+## Dependencies used by this file
+
+Only referenced types and operations appear here. Each name links to its complete specification.
+
+### [`Console`](.aug-spec/august/0.19.0/io/contracts.aug.md#symbol-Console)
+
+Capability interface from `august.io`.
+
+- [`Console.write`](.aug-spec/august/0.19.0/io/contracts.aug.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/examples/packages/README.md

@@ -0,0 +1,15 @@
+# Author and consume an August package
+
+From the repository root:
+
+```sh
+node bin/aug.mjs check examples/packages/math
+node bin/aug.mjs test examples/packages/math
+node bin/aug.mjs package pack examples/packages/math
+node bin/aug.mjs install examples/packages/app --offline
+node bin/aug.mjs run examples/packages/app
+```
+
+The application prints `42`. It imports the library through the `math` alias in `main.yaml` and sees only `math/src/export.aug`. Installation copies a snapshot into `.aug-packages`; reinstall after editing the local library. Commit the generated `app/aug.lock.json` when adopting this pattern in your own project; this teaching example intentionally creates its lock on your host.
+
+To create your own library, use `aug package init my-library --name @your-npm-name/my-library`. Test it and pack it, then publish the resulting `.tgz` with npm if you own that namespace. Consumers use an exact `npm:@your-npm-name/my-library@0.1.0` specification and keep the same August import spelling. See [the package guide](../../docs/packages.md).

package/examples/packages/app/.aug-spec/manifest.json

@@ -0,0 +1,9 @@
+{
+  "format": 1,
+  "files": [
+    ".aug-spec/packages/@example/aug-math/0.1.0/arithmetic.aug",
+    ".aug-spec/packages/@example/aug-math/0.1.0/arithmetic.aug.md",
+    "main.aug.md"
+  ],
+  "digest": "07fb73723b85a1925de6fcddbb4f26d2d0913f6f5a0d30c351b2c972e627c234"
+}

package/examples/packages/app/.aug-spec/packages/@example/aug-math/0.1.0/arithmetic.aug

@@ -0,0 +1,9 @@
+// Generated by aug spec. This is a copy of the installed dependency source.
+/** Add two integers. @param left First value. @param right Second value. @return Their sum. */
+add(int left, int right) returns int:
+    return left + right
+
+test add:
+    when addition:
+        it adds_two_integers:
+            assert(add(left=2, right=3) == 5)

package/examples/packages/app/.aug-spec/packages/@example/aug-math/0.1.0/arithmetic.aug.md

@@ -0,0 +1,63 @@
+<!-- Generated by aug spec. Edit the August source, then regenerate. -->
+
+# `arithmetic.aug` specification
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+## In this file
+
+- [`add`](arithmetic.aug.md#symbol-add) is a function returning `int`.
+- [`test add`](arithmetic.aug.md#symbol-test%20add) is a same-file test suite.
+
+<a id="symbol-add"></a>
+
+## `add`
+
+[source](arithmetic.aug#L3)
+
+**Inputs**
+
+- `left` (`int`) — required labeled input.
+- `right` (`int`) — required labeled input.
+
+Returns: `int`.
+
+**What it does**
+
+- Return `left` plus `right`.
+
+**Author documentation**
+
+Add two integers.
+
+**Returns** Their sum.
+
+**Parameters**
+- `left`: First value.
+- `right`: Second value.
+
+<a id="symbol-test add"></a>
+
+## `test add`
+
+[source](arithmetic.aug#L6)
+
+Same-file function tests for [`add`](arithmetic.aug.md#symbol-add). Each case gets isolated setup and dependency bindings.
+
+### Group `addition`
+
+#### `adds_two_integers`
+
+[source](arithmetic.aug#L8)
+
+- Call `assert` with (call [`add`](arithmetic.aug.md#symbol-add) with `left` = `2`; `right` = `3` equals `5`).
+
+## Built-in operations used by this file
+
+- `assert` (`condition`: `bool`) → `void`: Assert a bool in a test case or its setup. Catching an assertion failure cannot make the case pass; every case must execute an assertion.
+
+[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/examples/packages/app/main.aug

@@ -0,0 +1,2 @@
+import add from math
+print(value=add(left=20, right=22))

package/examples/packages/app/main.aug.md

@@ -0,0 +1,33 @@
+<!-- Generated by aug spec. Edit the August source, then regenerate. -->
+
+# `main.aug` specification
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+## In this file
+
+- Run 1 other startup step in source order.
+
+## Startup, in source order
+
+- Call `print` with `value` = call [`add`](.aug-spec/packages/%40example/aug-math/0.1.0/arithmetic.aug.md#symbol-add) with `left` = `20`; `right` = `22`.
+
+## Dependencies used by this file
+
+Only referenced types and operations appear here. Each name links to its complete specification.
+
+### [`add`](.aug-spec/packages/%40example/aug-math/0.1.0/arithmetic.aug.md#symbol-add)
+
+Function from `math`.
+
+- [`add`](.aug-spec/packages/%40example/aug-math/0.1.0/arithmetic.aug.md#symbol-add) (`left`: `int`, `right`: `int`) → `int`.
+
+## 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/examples/packages/app/main.yaml

@@ -0,0 +1,2 @@
+packages:
+  math: "../math"

package/examples/packages/math/.aug-spec/manifest.json

@@ -0,0 +1,8 @@
+{
+  "format": 1,
+  "files": [
+    "src/arithmetic.aug.md",
+    "src/export.aug.md"
+  ],
+  "digest": "2958866ecd2fe09820dc207135c3c8deae7bd2c9ab4c5999b496e34a97713b70"
+}

package/examples/packages/math/README.md

@@ -0,0 +1,3 @@
+# Math package
+
+A standalone source library. `src/export.aug` is the public surface; Javadoc and tests live beside `add`. This example is local and is not published to npm.

package/examples/packages/math/aug-package.json

@@ -0,0 +1,8 @@
+{
+  "format": 1,
+  "name": "@example/aug-math",
+  "version": "0.1.0",
+  "compiler": "0.19.0",
+  "source": "src",
+  "dependencies": {}
+}

package/examples/packages/math/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@example/aug-math",
+  "version": "0.1.0",
+  "description": "An August package authoring example",
+  "license": "MIT",
+  "files": ["src", "aug-package.json", "README.md"],
+  "exports": { "./aug-package.json": "./aug-package.json" },
+  "dependencies": {}
+}

package/examples/packages/math/src/arithmetic.aug

@@ -0,0 +1,8 @@
+/** Add two integers. @param left First value. @param right Second value. @return Their sum. */
+add(int left, int right) returns int:
+    return left + right
+
+test add:
+    when addition:
+        it adds_two_integers:
+            assert(add(left=2, right=3) == 5)

package/examples/packages/math/src/arithmetic.aug.md

@@ -0,0 +1,63 @@
+<!-- Generated by aug spec. Edit the August source, then regenerate. -->
+
+# `arithmetic.aug` specification
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+## In this file
+
+- [`add`](arithmetic.aug.md#symbol-add) is a function returning `int`.
+- [`test add`](arithmetic.aug.md#symbol-test%20add) is a same-file test suite.
+
+<a id="symbol-add"></a>
+
+## `add`
+
+[source](arithmetic.aug#L2)
+
+**Inputs**
+
+- `left` (`int`) — required labeled input.
+- `right` (`int`) — required labeled input.
+
+Returns: `int`.
+
+**What it does**
+
+- Return `left` plus `right`.
+
+**Author documentation**
+
+Add two integers.
+
+**Returns** Their sum.
+
+**Parameters**
+- `left`: First value.
+- `right`: Second value.
+
+<a id="symbol-test add"></a>
+
+## `test add`
+
+[source](arithmetic.aug#L5)
+
+Same-file function tests for [`add`](arithmetic.aug.md#symbol-add). Each case gets isolated setup and dependency bindings.
+
+### Group `addition`
+
+#### `adds_two_integers`
+
+[source](arithmetic.aug#L7)
+
+- Call `assert` with (call [`add`](arithmetic.aug.md#symbol-add) with `left` = `2`; `right` = `3` equals `5`).
+
+## Built-in operations used by this file
+
+- `assert` (`condition`: `bool`) → `void`: Assert a bool in a test case or its setup. Catching an assertion failure cannot make the case pass; every case must execute an assertion.
+
+[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/examples/packages/math/src/export.aug

@@ -0,0 +1 @@
+export add from arithmetic

package/examples/packages/math/src/export.aug.md

@@ -0,0 +1,17 @@
+<!-- Generated by aug spec. Edit the August source, then regenerate. -->
+
+# `export.aug` specification
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+## In this file
+
+- Export `add` from this folder.
+
+## Folder exports
+
+- Export the declaration `add` from [`arithmetic.aug`](arithmetic.aug.md#symbol-add).
+
+## Shared language rules
+
+See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.

package/examples/visibility/.aug-spec/manifest.json

@@ -0,0 +1,8 @@
+{
+  "format": 1,
+  "files": [
+    "counter.aug.md",
+    "main.aug.md"
+  ],
+  "digest": "e1db6169882af7977c15c64a4c1739515c33d6bc940bff9ed10e45895831eb50"
+}

package/examples/visibility/counter.aug

@@ -0,0 +1,14 @@
+interface ICounter {
+    label() returns string
+}
+Counter(mutable int value) implements ICounter {
+    _label() returns string {
+        return _prefix()
+    }
+    label() returns string {
+        return self._label()
+    }
+}
+_prefix() returns string {
+    return "count"
+}

package/examples/visibility/counter.aug.md

@@ -0,0 +1,87 @@
+<!-- Generated by aug spec. Edit the August source, then regenerate. -->
+
+# `counter.aug` specification
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+## In this file
+
+- [`ICounter`](counter.aug.md#symbol-ICounter) is an interface.
+- [`Counter`](counter.aug.md#symbol-Counter) is a class implementing `ICounter`.
+- [`_prefix`](counter.aug.md#symbol-_prefix) is a function returning `string`.
+
+<a id="symbol-ICounter"></a>
+
+## `ICounter`
+
+[source](counter.aug#L1)
+
+Interface.
+
+<a id="symbol-ICounter.label"></a>
+
+### `ICounter.label`
+
+[source](counter.aug#L2)
+
+Returns: `string`.
+
+Interface contract. A selected implementation supplies the behavior.
+
+<a id="symbol-Counter"></a>
+
+## `Counter`
+
+[source](counter.aug#L4)
+
+Behavioral class.
+
+Satisfies [`ICounter`](counter.aug.md#symbol-ICounter).
+
+**Inputs**
+
+- `value` (`int`) — required labeled input — stored as `value` and mutable.
+
+<a id="symbol-Counter._label"></a>
+
+### `Counter._label`
+
+[source](counter.aug#L5)
+
+Private to its defining scope.
+
+Returns: `string`.
+
+**What it does**
+
+- Return call [`_prefix`](counter.aug.md#symbol-_prefix).
+
+<a id="symbol-Counter.label"></a>
+
+### `Counter.label`
+
+[source](counter.aug#L8)
+
+Returns: `string`.
+
+**What it does**
+
+- Return call [`Counter._label`](counter.aug.md#symbol-Counter._label) on `self`.
+
+<a id="symbol-_prefix"></a>
+
+## `_prefix`
+
+[source](counter.aug#L12)
+
+Private to its defining scope.
+
+Returns: `string`.
+
+**What it does**
+
+- Return `"count"`.
+
+## Shared language rules
+
+See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.

package/examples/visibility/main.aug

@@ -0,0 +1,7 @@
+import Counter from counter
+counter = Counter(value=1)
+print(value=counter.label())
+borrow counter {
+    counter.value = 2
+}
+print(value=counter.value)

package/examples/visibility/main.aug.md

@@ -0,0 +1,39 @@
+<!-- Generated by aug spec. Edit the August source, then regenerate. -->
+
+# `main.aug` specification
+
+August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+
+## In this file
+
+- Run 4 other startup steps in source order.
+
+## Startup, in source order
+
+- Set `counter` to call [`Counter`](counter.aug.md#symbol-Counter) with `value` = `1`.
+- Call `print` with `value` = call [`Counter.label`](counter.aug.md#symbol-Counter.label) on `counter`.
+- Grant exclusive mutable access to `counter` for this block, then end the borrow:
+  - Set `value` of `counter` to `2`.
+- Call `print` with `value` = `value` of `counter`.
+
+## Dependencies used by this file
+
+Only referenced types and operations appear here. Each name links to its complete specification.
+
+### [`Counter`](counter.aug.md#symbol-Counter)
+
+Class from `counter`.
+
+- Construct with `value`: `int` → [`Counter`](counter.aug.md#symbol-Counter).
+- Read `value` (`int`); its owner can change it.
+- [`Counter.label`](counter.aug.md#symbol-Counter.label) (no caller inputs) → `string`.
+
+## 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/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@greenpandastudios/aug-cli",
+  "version": "0.19.0",
+  "description": "August compiler, native build CLI, tests and language server",
+  "type": "module",
+  "license": "MIT",
+  "engines": {
+    "node": ">=24"
+  },
+  "bin": {
+    "aug-cli": "bin/aug.mjs",
+    "aug": "bin/aug.mjs",
+    "aug-native": "scripts/bootstrap-native.mjs"
+  },
+  "files": [
+    "bin",
+    "src",
+    "runtime",
+    "scripts",
+    "docs",
+    "examples",
+    "LICENSE",
+    "THIRD_PARTY_NOTICES.md"
+  ],
+  "dependencies": {
+    "@greenpandastudios/aug-stdlib": "0.19.0",
+    "@greenpandastudios/aug-web": "0.19.0",
+    "@greenpandastudios/aug-crypto": "0.19.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "next"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/GreenPandaStudios/augscript.git",
+    "directory": "packages/cli"
+  },
+  "homepage": "https://GreenPandaStudios.github.io/augscript/",
+  "bugs": {
+    "url": "https://github.com/GreenPandaStudios/augscript/issues"
+  },
+  "keywords": [
+    "august",
+    "augscript",
+    "compiler",
+    "language",
+    "llm"
+  ]
+}