@greenpandastudios/aug-cli 0.19.0 → 0.20.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -6
- package/THIRD_PARTY_NOTICES.md +4 -0
- package/bin/aug.mjs +12 -2
- package/docs/about.md +27 -0
- package/docs/api/crypto.md +103 -69
- package/docs/api/io.md +35 -33
- package/docs/api/json.md +3 -3
- package/docs/api/memory.md +23 -19
- package/docs/api/time.md +10 -9
- package/docs/api/web.md +33 -38
- package/docs/compatibility.md +3 -3
- package/docs/contributing-benchmarks.md +38 -0
- package/docs/dev-containers.md +95 -0
- package/docs/diagnostics.md +15 -5
- package/docs/docker.md +174 -12
- package/docs/editor.md +35 -0
- package/docs/example-projects.json +206 -24
- package/docs/examples/approved-design/counters.md +34 -126
- package/docs/examples/approved-design/dependencies/august/0.20.1/io/contracts.md +178 -0
- package/docs/examples/approved-design/domain/app.md +13 -77
- package/docs/examples/approved-design/domain/export.md +5 -19
- package/docs/examples/approved-design/domain/models.md +4 -23
- package/docs/examples/approved-design/domain/numbers.md +24 -114
- package/docs/examples/approved-design/index.md +16 -7
- package/docs/examples/approved-design/main.md +19 -96
- package/docs/examples/benchmark/index.md +6 -5
- package/docs/examples/benchmark/main.md +7 -35
- package/docs/examples/cli-args/index.md +6 -5
- package/docs/examples/cli-args/main.md +6 -31
- package/docs/examples/collections/index.md +6 -5
- package/docs/examples/collections/main.md +7 -35
- package/docs/examples/collections-benchmark/index.md +6 -5
- package/docs/examples/collections-benchmark/main.md +7 -35
- package/docs/examples/cpu-benchmark/index.md +6 -5
- package/docs/examples/cpu-benchmark/main.md +5 -24
- package/docs/examples/developer-workflow/calculator.md +39 -186
- package/docs/examples/developer-workflow/dependencies/august/0.20.1/io/contracts.md +178 -0
- package/docs/examples/developer-workflow/index.md +16 -7
- package/docs/examples/developer-workflow/logging/console.md +10 -56
- package/docs/examples/developer-workflow/logging/export.md +4 -14
- package/docs/examples/developer-workflow/logging/logger.md +7 -43
- package/docs/examples/developer-workflow/main.md +17 -69
- package/docs/examples/drop/index.md +6 -5
- package/docs/examples/drop/main.md +7 -27
- package/docs/examples/drop/resource.md +7 -30
- package/docs/examples/errors/errors.md +7 -27
- package/docs/examples/errors/index.md +6 -5
- package/docs/examples/errors/main.md +7 -28
- package/docs/examples/ffi/index.md +6 -5
- package/docs/examples/ffi/main.md +6 -20
- package/docs/examples/ffi/native.md +8 -34
- package/docs/examples/generic-di/dependencies/august/0.20.1/io/contracts.md +178 -0
- package/docs/examples/generic-di/index.md +6 -5
- package/docs/examples/generic-di/main.md +9 -39
- package/docs/examples/generic-di/types.md +23 -92
- package/docs/examples/generics/index.md +6 -5
- package/docs/examples/generics/main.md +10 -47
- package/docs/examples/generics/types.md +25 -100
- package/docs/examples/hello/app/export.md +4 -12
- package/docs/examples/hello/app/greeter.md +13 -91
- package/docs/examples/hello/dependencies/august/0.20.1/io/contracts.md +178 -0
- package/docs/examples/hello/index.md +17 -6
- package/docs/examples/hello/logging/console.md +10 -54
- package/docs/examples/hello/logging/export.md +4 -14
- package/docs/examples/hello/logging/logger.md +7 -45
- package/docs/examples/hello/main.md +9 -39
- package/docs/examples/http-benchmark/index.md +6 -5
- package/docs/examples/http-benchmark/main.md +6 -20
- package/docs/examples/http-benchmark/routes.md +9 -31
- package/docs/examples/index.md +46 -29
- package/docs/examples/interceptors/app.md +20 -139
- package/docs/examples/interceptors/dependencies/august/0.20.1/io/contracts.md +178 -0
- package/docs/examples/interceptors/index.md +6 -5
- package/docs/examples/interceptors/interceptors.md +24 -148
- package/docs/examples/interceptors/logging.md +13 -76
- package/docs/examples/interceptors/main.md +10 -65
- package/docs/examples/json-benchmark/data.md +4 -20
- package/docs/examples/json-benchmark/dependencies/packages/@git/url_2d3c37c690c0fa115be1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.md +67 -0
- package/docs/examples/json-benchmark/index.md +7 -5
- package/docs/examples/json-benchmark/main-yaml.md +20 -0
- package/docs/examples/json-benchmark/main.md +10 -49
- package/docs/examples/new-syntax/console.md +10 -52
- package/docs/examples/new-syntax/dependencies/august/0.20.1/io/contracts.md +178 -0
- package/docs/examples/new-syntax/greeter.md +13 -71
- package/docs/examples/new-syntax/index.md +6 -5
- package/docs/examples/new-syntax/logger.md +7 -43
- package/docs/examples/new-syntax/main.md +10 -53
- package/docs/examples/new-syntax/math.md +6 -24
- package/docs/examples/oidc-login/client/contracts.md +10 -61
- package/docs/examples/oidc-login/client/endpoints.md +32 -154
- package/docs/examples/oidc-login/client/export.md +5 -23
- package/docs/examples/oidc-login/client/login.md +234 -344
- package/docs/examples/oidc-login/client/logout.md +38 -143
- package/docs/examples/oidc-login/client/protocol.md +183 -304
- package/docs/examples/oidc-login/client/session.md +41 -149
- package/docs/examples/oidc-login/client/views.md +13 -58
- package/docs/examples/oidc-login/common/export.md +6 -26
- package/docs/examples/oidc-login/common/headers.md +42 -72
- package/docs/examples/oidc-login/common/keys.md +40 -164
- package/docs/examples/oidc-login/common/settings.md +24 -40
- package/docs/examples/oidc-login/common/views.md +7 -28
- package/docs/examples/oidc-login/dependencies/packages/@git/url_0eb7c89453c87681ed15/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/store.md +205 -0
- package/docs/examples/oidc-login/dependencies/packages/@git/url_2d3c37c690c0fa115be1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.md +67 -0
- package/docs/examples/oidc-login/dependencies/packages/@git/url_897efafd565158fc4908/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.md +267 -0
- package/docs/examples/oidc-login/dependencies/packages/@git/url_9ef654c66d34ab8f5527/0.0.0-git.b14a0f9aa41f1ce58bd51133bcdc424033e40d40/contracts.md +415 -0
- package/docs/examples/oidc-login/dependencies/packages/@git/url_9ef654c66d34ab8f5527/0.0.0-git.b14a0f9aa41f1ce58bd51133bcdc424033e40d40/jose.md +271 -0
- package/docs/examples/oidc-login/dependencies/packages/@git/url_c092cd151499c4e1d8a1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.md +89 -0
- package/docs/examples/oidc-login/index.md +8 -7
- package/docs/examples/oidc-login/main-yaml.md +7 -0
- package/docs/examples/oidc-login/main.md +26 -153
- package/docs/examples/oidc-login/provider/authorization.md +232 -275
- package/docs/examples/oidc-login/provider/contracts.md +24 -146
- package/docs/examples/oidc-login/provider/credentials.md +24 -57
- package/docs/examples/oidc-login/provider/discovery.md +48 -122
- package/docs/examples/oidc-login/provider/export.md +11 -37
- package/docs/examples/oidc-login/provider/token.md +159 -237
- package/docs/examples/oidc-login/provider/userinfo.md +47 -102
- package/docs/examples/oidc-login/provider/views.md +13 -53
- package/docs/examples/ownership/counter.md +17 -63
- package/docs/examples/ownership/index.md +6 -5
- package/docs/examples/ownership/main.md +7 -30
- package/docs/examples/ownership-transfer/dependencies/august/0.20.1/io/contracts.md +178 -0
- package/docs/examples/ownership-transfer/index.md +6 -5
- package/docs/examples/ownership-transfer/main.md +10 -52
- package/docs/examples/ownership-transfer/resource.md +15 -67
- package/docs/examples/packages-app/dependencies/packages/@example/aug-math/0.1.0/arithmetic.md +12 -50
- package/docs/examples/packages-app/index.md +7 -6
- package/docs/examples/packages-app/main.md +7 -25
- package/docs/examples/packages-math/aug-package-json.md +1 -1
- package/docs/examples/packages-math/index.md +7 -6
- package/docs/examples/packages-math/src/arithmetic.md +12 -50
- package/docs/examples/packages-math/src/export.md +4 -12
- package/docs/examples/startup-benchmark/index.md +6 -5
- package/docs/examples/startup-benchmark/main.md +5 -17
- package/docs/examples/visibility/counter.md +19 -67
- package/docs/examples/visibility/index.md +6 -5
- package/docs/examples/visibility/main.md +7 -31
- package/docs/examples/weather-api/forecasts.md +168 -0
- package/docs/examples/weather-api/index.md +42 -0
- package/docs/examples/weather-api/main-yaml.md +21 -0
- package/docs/examples/weather-api/main.md +65 -0
- package/docs/examples.json +10 -0
- package/docs/getting-started.md +105 -2
- package/docs/grammar.md +6 -4
- package/docs/guides/change-a-module.md +64 -0
- package/docs/guides/index.md +27 -0
- package/docs/index.md +51 -29
- package/docs/language-conformance.md +1 -1
- package/docs/language-constructs.md +22 -22
- package/docs/language-design-audit.md +1 -1
- package/docs/learn/data-and-errors.md +77 -0
- package/docs/learn/index.md +30 -0
- package/docs/learn/modules-and-dependencies.md +73 -0
- package/docs/learn/state-and-tests.md +71 -0
- package/docs/learn/values-and-functions.md +62 -0
- package/docs/lesson-failures.json +8 -0
- package/docs/maintaining-docs.md +16 -4
- package/docs/packages.md +72 -126
- package/docs/performance.md +13 -41
- package/docs/production-readiness.md +5 -4
- package/docs/public/downloads/approved-design.zip +0 -0
- package/docs/public/downloads/benchmark.zip +0 -0
- package/docs/public/downloads/cli-args.zip +0 -0
- package/docs/public/downloads/collections-benchmark.zip +0 -0
- package/docs/public/downloads/collections.zip +0 -0
- package/docs/public/downloads/cpu-benchmark.zip +0 -0
- package/docs/public/downloads/developer-workflow.zip +0 -0
- package/docs/public/downloads/drop.zip +0 -0
- package/docs/public/downloads/errors.zip +0 -0
- package/docs/public/downloads/ffi.zip +0 -0
- package/docs/public/downloads/generic-di.zip +0 -0
- package/docs/public/downloads/generics.zip +0 -0
- package/docs/public/downloads/hello.zip +0 -0
- package/docs/public/downloads/http-benchmark.zip +0 -0
- package/docs/public/downloads/interceptors.zip +0 -0
- package/docs/public/downloads/json-benchmark.zip +0 -0
- package/docs/public/downloads/new-syntax.zip +0 -0
- package/docs/public/downloads/oidc-login.zip +0 -0
- package/docs/public/downloads/ownership-transfer.zip +0 -0
- package/docs/public/downloads/ownership.zip +0 -0
- package/docs/public/downloads/packages-app.zip +0 -0
- package/docs/public/downloads/packages-math.zip +0 -0
- package/docs/public/downloads/startup-benchmark.zip +0 -0
- package/docs/public/downloads/visibility.zip +0 -0
- package/docs/public/downloads/weather-api.zip +0 -0
- package/docs/reference.md +23 -17
- package/docs/releasing.md +29 -15
- package/docs/research/code-to-natural-language.md +108 -0
- package/docs/research/ecosystem-workflow.md +41 -0
- package/docs/research/wiki-editorial-design.md +71 -0
- package/docs/roadmap.md +1 -1
- package/docs/specifications.md +27 -11
- package/docs/testing.md +19 -5
- package/docs/tooling.md +25 -12
- package/docs/weather-api.md +65 -0
- package/docs/web.md +50 -18
- package/docs/writing-docs.md +49 -0
- package/examples/{hello/.aug-spec/august/0.19.0 → approved-design/.aug-spec/august/0.20.1}/io/contracts.aug +4 -3
- package/examples/approved-design/.aug-spec/august/0.20.1/io/contracts.aug.md +82 -0
- package/examples/approved-design/.aug-spec/manifest.json +3 -3
- package/examples/approved-design/counters.aug +5 -4
- package/examples/approved-design/counters.aug.md +25 -132
- package/examples/approved-design/domain/app.aug +2 -1
- package/examples/approved-design/domain/app.aug.md +10 -80
- package/examples/approved-design/domain/export.aug +1 -0
- package/examples/approved-design/domain/export.aug.md +4 -20
- package/examples/approved-design/domain/models.aug +1 -0
- package/examples/approved-design/domain/models.aug.md +3 -25
- package/examples/approved-design/domain/numbers.aug +3 -2
- package/examples/approved-design/domain/numbers.aug.md +19 -116
- package/examples/approved-design/main.aug +1 -0
- package/examples/approved-design/main.aug.md +12 -95
- package/examples/benchmark/.aug-spec/manifest.json +1 -1
- package/examples/benchmark/main.aug +1 -0
- package/examples/benchmark/main.aug.md +6 -36
- package/examples/cli-args/.aug-spec/manifest.json +1 -1
- package/examples/cli-args/main.aug +1 -0
- package/examples/cli-args/main.aug.md +5 -32
- package/examples/collections/.aug-spec/manifest.json +1 -1
- package/examples/collections/main.aug +1 -0
- package/examples/collections/main.aug.md +6 -36
- package/examples/{generic-di/.aug-spec/august/0.19.0 → developer-workflow/.aug-spec/august/0.20.1}/io/contracts.aug +4 -3
- package/examples/developer-workflow/.aug-spec/august/0.20.1/io/contracts.aug.md +82 -0
- package/examples/developer-workflow/.aug-spec/manifest.json +3 -3
- package/examples/developer-workflow/calculator.aug +3 -2
- package/examples/developer-workflow/calculator.aug.md +28 -189
- package/examples/developer-workflow/logging/console.aug +2 -1
- package/examples/developer-workflow/logging/console.aug.md +7 -57
- package/examples/developer-workflow/logging/export.aug +1 -0
- package/examples/developer-workflow/logging/export.aug.md +3 -15
- package/examples/developer-workflow/logging/logger.aug +1 -0
- package/examples/developer-workflow/logging/logger.aug.md +6 -46
- package/examples/developer-workflow/main.aug +1 -0
- package/examples/developer-workflow/main.aug.md +10 -68
- package/examples/drop/.aug-spec/manifest.json +1 -1
- package/examples/drop/main.aug +1 -0
- package/examples/drop/main.aug.md +6 -28
- package/examples/drop/resource.aug +1 -0
- package/examples/drop/resource.aug.md +6 -34
- package/examples/errors/.aug-spec/manifest.json +1 -1
- package/examples/errors/errors.aug +2 -1
- package/examples/errors/errors.aug.md +4 -27
- package/examples/errors/main.aug +1 -0
- package/examples/errors/main.aug.md +6 -29
- package/examples/ffi/.aug-spec/manifest.json +1 -1
- package/examples/ffi/main.aug +1 -0
- package/examples/ffi/main.aug.md +5 -21
- package/examples/ffi/native.aug +2 -1
- package/examples/ffi/native.aug.md +5 -35
- package/examples/{approved-design/.aug-spec/august/0.19.0 → generic-di/.aug-spec/august/0.20.1}/io/contracts.aug +4 -3
- package/examples/generic-di/.aug-spec/august/0.20.1/io/contracts.aug.md +82 -0
- package/examples/generic-di/.aug-spec/manifest.json +3 -3
- package/examples/generic-di/main.aug +1 -0
- package/examples/generic-di/main.aug.md +8 -40
- package/examples/generic-di/types.aug +3 -2
- package/examples/generic-di/types.aug.md +18 -97
- package/examples/generics/.aug-spec/manifest.json +1 -1
- package/examples/generics/main.aug +1 -0
- package/examples/generics/main.aug.md +9 -48
- package/examples/generics/types.aug +4 -3
- package/examples/generics/types.aug.md +18 -104
- package/examples/{developer-workflow/.aug-spec/august/0.19.0 → hello/.aug-spec/august/0.20.1}/io/contracts.aug +4 -3
- package/examples/hello/.aug-spec/august/0.20.1/io/contracts.aug.md +82 -0
- package/examples/hello/.aug-spec/manifest.json +3 -3
- package/examples/hello/app/export.aug +1 -0
- package/examples/hello/app/export.aug.md +3 -13
- package/examples/hello/app/greeter.aug +2 -1
- package/examples/hello/app/greeter.aug.md +10 -94
- package/examples/hello/logging/console.aug +2 -1
- package/examples/hello/logging/console.aug.md +7 -55
- package/examples/hello/logging/export.aug +1 -0
- package/examples/hello/logging/export.aug.md +3 -15
- package/examples/hello/logging/logger.aug +1 -0
- package/examples/hello/logging/logger.aug.md +6 -48
- package/examples/hello/main.aug +1 -0
- package/examples/hello/main.aug.md +8 -40
- package/examples/interceptors/.aug-spec/august/0.20.1/io/contracts.aug +37 -0
- package/examples/interceptors/.aug-spec/august/0.20.1/io/contracts.aug.md +82 -0
- package/examples/interceptors/.aug-spec/manifest.json +3 -3
- package/examples/interceptors/app.aug +3 -2
- package/examples/interceptors/app.aug.md +15 -141
- package/examples/interceptors/interceptors.aug +3 -2
- package/examples/interceptors/interceptors.aug.md +19 -152
- package/examples/interceptors/logging.aug +2 -1
- package/examples/interceptors/logging.aug.md +10 -79
- package/examples/interceptors/main.aug +1 -0
- package/examples/interceptors/main.aug.md +9 -66
- package/examples/new-syntax/.aug-spec/august/0.20.1/io/contracts.aug +37 -0
- package/examples/new-syntax/.aug-spec/august/0.20.1/io/contracts.aug.md +82 -0
- package/examples/new-syntax/.aug-spec/manifest.json +3 -3
- package/examples/new-syntax/console.aug +2 -1
- package/examples/new-syntax/console.aug.md +7 -53
- package/examples/new-syntax/greeter.aug +2 -1
- package/examples/new-syntax/greeter.aug.md +10 -74
- package/examples/new-syntax/logger.aug +1 -0
- package/examples/new-syntax/logger.aug.md +6 -46
- package/examples/new-syntax/main.aug +1 -0
- package/examples/new-syntax/main.aug.md +9 -54
- package/examples/new-syntax/math.aug +2 -1
- package/examples/new-syntax/math.aug.md +3 -24
- package/examples/oidc-login/.aug-spec/manifest.json +13 -13
- package/examples/oidc-login/.aug-spec/packages/@git/url_0eb7c89453c87681ed15/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/store.aug.md +71 -0
- package/examples/oidc-login/.aug-spec/packages/@git/url_2d3c37c690c0fa115be1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.aug.md +17 -0
- package/examples/oidc-login/.aug-spec/packages/@git/url_897efafd565158fc4908/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.aug.md +125 -0
- package/examples/oidc-login/.aug-spec/{august/0.19.0/crypto → packages/@git/url_9ef654c66d34ab8f5527/0.0.0-git.b14a0f9aa41f1ce58bd51133bcdc424033e40d40}/contracts.aug +12 -11
- package/examples/oidc-login/.aug-spec/packages/@git/url_9ef654c66d34ab8f5527/0.0.0-git.b14a0f9aa41f1ce58bd51133bcdc424033e40d40/contracts.aug.md +244 -0
- package/examples/oidc-login/.aug-spec/{august/0.19.0/crypto → packages/@git/url_9ef654c66d34ab8f5527/0.0.0-git.b14a0f9aa41f1ce58bd51133bcdc424033e40d40}/jose.aug +6 -5
- package/examples/oidc-login/.aug-spec/packages/@git/url_9ef654c66d34ab8f5527/0.0.0-git.b14a0f9aa41f1ce58bd51133bcdc424033e40d40/jose.aug.md +71 -0
- package/examples/oidc-login/.aug-spec/packages/@git/url_c092cd151499c4e1d8a1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.aug.md +30 -0
- package/examples/oidc-login/aug.lock.json +100 -0
- package/examples/oidc-login/client/contracts.aug +1 -0
- package/examples/oidc-login/client/contracts.aug.md +9 -66
- package/examples/oidc-login/client/endpoints.aug +6 -5
- package/examples/oidc-login/client/endpoints.aug.md +13 -145
- package/examples/oidc-login/client/export.aug +1 -0
- package/examples/oidc-login/client/export.aug.md +4 -24
- package/examples/oidc-login/client/login.aug +7 -6
- package/examples/oidc-login/client/login.aug.md +25 -303
- package/examples/oidc-login/client/logout.aug +5 -4
- package/examples/oidc-login/client/logout.aug.md +13 -135
- package/examples/oidc-login/client/protocol.aug +7 -6
- package/examples/oidc-login/client/protocol.aug.md +36 -283
- package/examples/oidc-login/client/session.aug +5 -4
- package/examples/oidc-login/client/session.aug.md +12 -139
- package/examples/oidc-login/client/views.aug +3 -2
- package/examples/oidc-login/client/views.aug.md +8 -57
- package/examples/oidc-login/common/export.aug +1 -0
- package/examples/oidc-login/common/export.aug.md +5 -27
- package/examples/oidc-login/common/headers.aug +4 -3
- package/examples/oidc-login/common/headers.aug.md +9 -67
- package/examples/oidc-login/common/keys.aug +6 -5
- package/examples/oidc-login/common/keys.aug.md +29 -165
- package/examples/oidc-login/common/settings.aug +2 -1
- package/examples/oidc-login/common/settings.aug.md +5 -39
- package/examples/oidc-login/common/views.aug +2 -1
- package/examples/oidc-login/common/views.aug.md +4 -28
- package/examples/oidc-login/main.aug +6 -16
- package/examples/oidc-login/main.aug.md +17 -146
- package/examples/oidc-login/main.yaml +7 -0
- package/examples/oidc-login/provider/authorization.aug +7 -6
- package/examples/oidc-login/provider/authorization.aug.md +23 -238
- package/examples/oidc-login/provider/contracts.aug +1 -0
- package/examples/oidc-login/provider/contracts.aug.md +23 -158
- package/examples/oidc-login/provider/credentials.aug +3 -2
- package/examples/oidc-login/provider/credentials.aug.md +9 -53
- package/examples/oidc-login/provider/discovery.aug +4 -3
- package/examples/oidc-login/provider/discovery.aug.md +11 -118
- package/examples/oidc-login/provider/export.aug +1 -0
- package/examples/oidc-login/provider/export.aug.md +6 -34
- package/examples/oidc-login/provider/token.aug +6 -5
- package/examples/oidc-login/provider/token.aug.md +16 -204
- package/examples/oidc-login/provider/userinfo.aug +4 -3
- package/examples/oidc-login/provider/userinfo.aug.md +10 -92
- package/examples/oidc-login/provider/views.aug +3 -2
- package/examples/oidc-login/provider/views.aug.md +8 -52
- package/examples/ownership/.aug-spec/manifest.json +1 -1
- package/examples/ownership/counter.aug +3 -2
- package/examples/ownership/counter.aug.md +12 -66
- package/examples/ownership/main.aug +1 -0
- package/examples/ownership/main.aug.md +6 -31
- package/examples/ownership-transfer/.aug-spec/august/0.20.1/io/contracts.aug +37 -0
- package/examples/ownership-transfer/.aug-spec/august/0.20.1/io/contracts.aug.md +82 -0
- package/examples/ownership-transfer/.aug-spec/manifest.json +3 -3
- package/examples/ownership-transfer/main.aug +1 -0
- package/examples/ownership-transfer/main.aug.md +9 -53
- package/examples/ownership-transfer/resource.aug +2 -1
- package/examples/ownership-transfer/resource.aug.md +12 -71
- package/examples/packages/app/.aug-spec/manifest.json +1 -1
- package/examples/packages/app/.aug-spec/packages/@example/aug-math/0.1.0/arithmetic.aug +2 -1
- package/examples/packages/app/.aug-spec/packages/@example/aug-math/0.1.0/arithmetic.aug.md +9 -51
- package/examples/packages/app/main.aug +1 -0
- package/examples/packages/app/main.aug.md +6 -26
- package/examples/packages/math/.aug-spec/manifest.json +1 -1
- package/examples/packages/math/aug-package.json +1 -1
- package/examples/packages/math/src/arithmetic.aug +2 -1
- package/examples/packages/math/src/arithmetic.aug.md +9 -51
- package/examples/packages/math/src/export.aug +1 -0
- package/examples/packages/math/src/export.aug.md +3 -13
- package/examples/visibility/.aug-spec/manifest.json +1 -1
- package/examples/visibility/counter.aug +4 -3
- package/examples/visibility/counter.aug.md +12 -68
- package/examples/visibility/main.aug +1 -0
- package/examples/visibility/main.aug.md +6 -32
- package/examples/weather-api/.aug-spec/manifest.json +8 -0
- package/examples/weather-api/AGENTS.md +17 -0
- package/examples/weather-api/README.md +19 -0
- package/examples/weather-api/forecasts.aug +47 -0
- package/examples/weather-api/forecasts.aug.md +32 -0
- package/examples/weather-api/main.aug +4 -0
- package/examples/weather-api/main.aug.md +15 -0
- package/examples/weather-api/main.yaml +5 -0
- package/examples/weather-api/weather.http +5 -0
- package/package.json +3 -4
- package/scripts/bootstrap-native.mjs +181 -106
- package/scripts/native-setup.mjs +98 -0
- package/scripts/native-toolchain.mjs +28 -0
- package/src/builtins.js +1 -1
- package/src/checker.js +259 -72
- package/src/cli.js +114 -20
- package/src/codegen.js +1 -1
- package/src/config.js +1 -1
- package/src/contracts.js +10 -0
- package/src/editor.js +71 -16
- package/src/fixes.js +90 -2
- package/src/formatter.js +19 -8
- package/src/git-packages.js +110 -0
- package/src/help.js +24 -23
- package/src/http-contracts.js +14 -0
- package/src/http-policies.js +5 -5
- package/src/libraries.js +1 -1
- package/src/lsp.js +14 -5
- package/src/native.js +19 -13
- package/src/navigation.js +4 -2
- package/src/openapi.js +5 -4
- package/src/package-locking.js +45 -0
- package/src/package-manager.js +251 -67
- package/src/parser.js +13 -5
- package/src/policies.js +3 -3
- package/src/project-init.js +78 -4
- package/src/project.js +9 -7
- package/src/semantic.js +46 -2
- package/src/snippets.js +59 -0
- package/src/spec-hints.js +56 -0
- package/src/spec-tree.js +241 -0
- package/src/spec.js +626 -303
- package/docs/examples/approved-design/dependencies/august/0.19.0/io/contracts.md +0 -395
- package/docs/examples/developer-workflow/dependencies/august/0.19.0/io/contracts.md +0 -395
- package/docs/examples/generic-di/dependencies/august/0.19.0/io/contracts.md +0 -395
- package/docs/examples/hello/dependencies/august/0.19.0/io/contracts.md +0 -395
- package/docs/examples/interceptors/dependencies/august/0.19.0/io/contracts.md +0 -395
- package/docs/examples/json-benchmark/dependencies/august/0.19.0/json/contracts.md +0 -103
- package/docs/examples/new-syntax/dependencies/august/0.19.0/io/contracts.md +0 -395
- package/docs/examples/oidc-login/dependencies/august/0.19.0/crypto/contracts.md +0 -925
- package/docs/examples/oidc-login/dependencies/august/0.19.0/crypto/jose.md +0 -434
- package/docs/examples/oidc-login/dependencies/august/0.19.0/json/contracts.md +0 -103
- package/docs/examples/oidc-login/dependencies/august/0.19.0/memory/store.md +0 -374
- package/docs/examples/oidc-login/dependencies/august/0.19.0/time/contracts.md +0 -150
- package/docs/examples/oidc-login/dependencies/august/0.19.0/web/contracts.md +0 -532
- package/docs/examples/ownership-transfer/dependencies/august/0.19.0/io/contracts.md +0 -395
- package/examples/approved-design/.aug-spec/august/0.19.0/io/contracts.aug.md +0 -316
- package/examples/developer-workflow/.aug-spec/august/0.19.0/io/contracts.aug.md +0 -316
- package/examples/generic-di/.aug-spec/august/0.19.0/io/contracts.aug.md +0 -316
- package/examples/hello/.aug-spec/august/0.19.0/io/contracts.aug.md +0 -316
- package/examples/interceptors/.aug-spec/august/0.19.0/io/contracts.aug +0 -36
- package/examples/interceptors/.aug-spec/august/0.19.0/io/contracts.aug.md +0 -316
- package/examples/new-syntax/.aug-spec/august/0.19.0/io/contracts.aug +0 -36
- package/examples/new-syntax/.aug-spec/august/0.19.0/io/contracts.aug.md +0 -316
- package/examples/oidc-login/.aug-spec/august/0.19.0/crypto/contracts.aug.md +0 -791
- package/examples/oidc-login/.aug-spec/august/0.19.0/crypto/jose.aug.md +0 -266
- package/examples/oidc-login/.aug-spec/august/0.19.0/json/contracts.aug.md +0 -55
- package/examples/oidc-login/.aug-spec/august/0.19.0/memory/store.aug.md +0 -250
- package/examples/oidc-login/.aug-spec/august/0.19.0/time/contracts.aug.md +0 -96
- package/examples/oidc-login/.aug-spec/august/0.19.0/web/contracts.aug.md +0 -420
- package/examples/ownership-transfer/.aug-spec/august/0.19.0/io/contracts.aug +0 -36
- package/examples/ownership-transfer/.aug-spec/august/0.19.0/io/contracts.aug.md +0 -316
- /package/examples/oidc-login/.aug-spec/{august/0.19.0/memory → packages/@git/url_0eb7c89453c87681ed15/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301}/store.aug +0 -0
- /package/examples/oidc-login/.aug-spec/{august/0.19.0/json → packages/@git/url_2d3c37c690c0fa115be1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301}/contracts.aug +0 -0
- /package/examples/oidc-login/.aug-spec/{august/0.19.0/web → packages/@git/url_897efafd565158fc4908/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301}/contracts.aug +0 -0
- /package/examples/oidc-login/.aug-spec/{august/0.19.0/time → packages/@git/url_c092cd151499c4e1d8a1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301}/contracts.aug +0 -0
|
@@ -33,12 +33,13 @@ pageClass: aug-example-page
|
|
|
33
33
|
::: code-group
|
|
34
34
|
|
|
35
35
|
```aug [Indentation]
|
|
36
|
+
// aug-spec: "numbers.aug.md" explains this file. Read it before changes; refresh with aug spec.
|
|
36
37
|
/** Raised when an input is outside the operation's domain. */
|
|
37
38
|
RangeError(int value) implements Error:
|
|
38
39
|
pass
|
|
39
40
|
/** A pure validation layer, shared by any compatible callable. */
|
|
40
41
|
interceptor Positive<T>():
|
|
41
|
-
around(int amount) returns T
|
|
42
|
+
around(int amount) returns T:
|
|
42
43
|
if amount < 0:
|
|
43
44
|
throw RangeError(value=amount)
|
|
44
45
|
return next()
|
|
@@ -49,7 +50,7 @@ interceptor Positive<T>():
|
|
|
49
50
|
* @throws RangeError A validation layer rejected a negative input.
|
|
50
51
|
*/
|
|
51
52
|
[Positive]
|
|
52
|
-
double(int amount)
|
|
53
|
+
double(int amount):
|
|
53
54
|
return amount * 2
|
|
54
55
|
test double:
|
|
55
56
|
when "positive":
|
|
@@ -65,13 +66,14 @@ test double:
|
|
|
65
66
|
```
|
|
66
67
|
|
|
67
68
|
```aug [Braces]
|
|
69
|
+
// aug-spec: "numbers.aug.md" explains this file. Read it before changes; refresh with aug spec.
|
|
68
70
|
/** Raised when an input is outside the operation's domain. */
|
|
69
71
|
RangeError(int value) implements Error {
|
|
70
72
|
pass
|
|
71
73
|
}
|
|
72
74
|
/** A pure validation layer, shared by any compatible callable. */
|
|
73
75
|
interceptor Positive<T>() {
|
|
74
|
-
around(int amount) returns T
|
|
76
|
+
around(int amount) returns T {
|
|
75
77
|
if amount < 0 {
|
|
76
78
|
throw RangeError(value=amount)
|
|
77
79
|
}
|
|
@@ -85,7 +87,7 @@ interceptor Positive<T>() {
|
|
|
85
87
|
* @throws RangeError A validation layer rejected a negative input.
|
|
86
88
|
*/
|
|
87
89
|
[Positive]
|
|
88
|
-
double(int amount)
|
|
90
|
+
double(int amount) {
|
|
89
91
|
return amount * 2
|
|
90
92
|
}
|
|
91
93
|
test double {
|
|
@@ -115,133 +117,41 @@ test double {
|
|
|
115
117
|
|
|
116
118
|
## Compiled specification {#specification}
|
|
117
119
|
|
|
118
|
-
|
|
120
|
+
### `RangeError` · class · [source](numbers.md#code) {#symbol-RangeError}
|
|
119
121
|
|
|
120
|
-
|
|
122
|
+
Raised when an input is outside the operation's domain. It implements `Error`. It takes `value` as an integer, kept read-only.
|
|
121
123
|
|
|
122
|
-
|
|
123
|
-
- [`Positive`](numbers.md#symbol-Positive) is an interceptor.
|
|
124
|
-
- [`double`](numbers.md#symbol-double) is a function returning `int`.
|
|
125
|
-
- [`test double`](numbers.md#symbol-test-20-double) is a same-file test suite.
|
|
124
|
+
### `Positive` · interceptor · [source](numbers.md#code) {#symbol-Positive}
|
|
126
125
|
|
|
127
|
-
|
|
126
|
+
A pure validation layer, shared by any compatible callable. The type parameters are `T`. Creates one interceptor per invocation. Its around operation may delegate once or finish early.
|
|
128
127
|
|
|
129
|
-
[source](numbers.md#code)
|
|
128
|
+
#### `Positive.around` · [source](numbers.md#code) {#symbol-Positive.around}
|
|
130
129
|
|
|
131
|
-
|
|
130
|
+
It takes `amount` as an integer. Failures can raise [`RangeError`](numbers.md#symbol-RangeError). If `amount` is negative, it raises a [`RangeError`](numbers.md#symbol-RangeError) with `value` from `amount`. It returns `next`.
|
|
132
131
|
|
|
133
|
-
|
|
132
|
+
### `double` · [source](numbers.md#code) {#symbol-double}
|
|
134
133
|
|
|
135
|
-
|
|
134
|
+
Double a nonnegative amount. It takes `amount` as an integer (Integer to double). It returns `int` — Twice the amount, with defined integer wrapping. Failures can raise [`RangeError`](numbers.md#symbol-RangeError) (A validation layer rejected a negative input).
|
|
136
135
|
|
|
137
|
-
|
|
136
|
+
Layers run in the declared order. Call [`Positive.around`](numbers.md#symbol-Positive.around). It returns `amount` times `2`.
|
|
138
137
|
|
|
139
|
-
|
|
138
|
+
### `test double` · [source](numbers.md#code) {#symbol-test-20-double}
|
|
140
139
|
|
|
141
|
-
|
|
140
|
+
Tests [`double`](numbers.md#symbol-double). Each case gets fresh setup and dependencies.
|
|
142
141
|
|
|
143
|
-
|
|
142
|
+
#### `positive`
|
|
144
143
|
|
|
145
|
-
[source](numbers.md#code)
|
|
144
|
+
##### `doubles` · [source](numbers.md#code)
|
|
146
145
|
|
|
147
|
-
|
|
146
|
+
Run once for each row of a tuple containing `0`, `0`; a tuple containing `3`, `6`; a tuple containing `7`, `14`. Bind row positions to `input`, `expected`. The test requires [`double`](numbers.md#symbol-double) with `amount` from `input` equals `expected`.
|
|
148
147
|
|
|
149
|
-
|
|
148
|
+
##### `rejects_negative` · [source](numbers.md#code)
|
|
150
149
|
|
|
151
|
-
|
|
150
|
+
It sets `rejected` to `false`.
|
|
152
151
|
|
|
153
|
-
|
|
152
|
+
It tries to call [`double`](numbers.md#symbol-double) with `amount` `-1`. If this work raises [`RangeError`](numbers.md#symbol-RangeError) as `error`, it sets `rejected` to `error.value` equals `-1`. The test requires `rejected` is true.
|
|
154
153
|
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
#### `Positive.around` {#symbol-Positive.around}
|
|
158
|
-
|
|
159
|
-
[source](numbers.md#code)
|
|
160
|
-
|
|
161
|
-
**Inputs**
|
|
162
|
-
|
|
163
|
-
- `amount` (`int`) — required labeled input.
|
|
164
|
-
|
|
165
|
-
Returns: `T`.
|
|
166
|
-
|
|
167
|
-
Can fail with `RangeError`. Callers must catch or propagate these errors.
|
|
168
|
-
|
|
169
|
-
**What it does**
|
|
170
|
-
|
|
171
|
-
- If `amount` is less than `0`:
|
|
172
|
-
- Fail with call [`RangeError`](numbers.md#symbol-RangeError) with `value` = `amount`. Transfer control to a matching catch or propagate the failure.
|
|
173
|
-
- Return call `next`.
|
|
174
|
-
|
|
175
|
-
### `double` {#symbol-double}
|
|
176
|
-
|
|
177
|
-
[source](numbers.md#code)
|
|
178
|
-
|
|
179
|
-
**Inputs**
|
|
180
|
-
|
|
181
|
-
- `amount` (`int`) — required labeled input.
|
|
182
|
-
|
|
183
|
-
Returns: `int`.
|
|
184
|
-
|
|
185
|
-
Can fail with `RangeError`. Callers must catch or propagate these errors.
|
|
186
|
-
|
|
187
|
-
**Interceptors, in execution order**
|
|
188
|
-
|
|
189
|
-
1. Call [`Positive.around`](numbers.md#symbol-Positive.around). It can call the next layer or finish with its own result or failure. Unselected inputs pass through.
|
|
190
|
-
|
|
191
|
-
The first layer wraps the remaining layers. HTTP policies run before wire decoding; custom interceptors run after decoding. Follow linked behavior to see its conditions, input changes, and calls to the next layer.
|
|
192
|
-
|
|
193
|
-
**What it does**
|
|
194
|
-
|
|
195
|
-
- Return `amount` times `2`.
|
|
196
|
-
|
|
197
|
-
**Author documentation**
|
|
198
|
-
|
|
199
|
-
Double a nonnegative amount.
|
|
200
|
-
|
|
201
|
-
**Returns** Twice the amount, with defined integer wrapping.
|
|
202
|
-
|
|
203
|
-
**Parameters**
|
|
204
|
-
- `amount`: Integer to double.
|
|
205
|
-
|
|
206
|
-
**Throws**
|
|
207
|
-
- `RangeError`: A validation layer rejected a negative input.
|
|
208
|
-
|
|
209
|
-
### `test double` {#symbol-test-20-double}
|
|
210
|
-
|
|
211
|
-
[source](numbers.md#code)
|
|
212
|
-
|
|
213
|
-
Same-file function tests for [`double`](numbers.md#symbol-double). Each case gets isolated setup and dependency bindings.
|
|
214
|
-
|
|
215
|
-
#### Group `positive`
|
|
216
|
-
|
|
217
|
-
##### `doubles`
|
|
218
|
-
|
|
219
|
-
[source](numbers.md#code)
|
|
220
|
-
|
|
221
|
-
Run once for each row of a tuple containing `0`, `0`; a tuple containing `3`, `6`; a tuple containing `7`, `14`. Bind row positions to `input`, `expected`.
|
|
222
|
-
|
|
223
|
-
- Call `assert` with (call [`double`](numbers.md#symbol-double) with `amount` = `input` equals `expected`).
|
|
224
|
-
|
|
225
|
-
##### `rejects_negative`
|
|
226
|
-
|
|
227
|
-
[source](numbers.md#code)
|
|
228
|
-
|
|
229
|
-
- Set `rejected` of type `bool` to `false`.
|
|
230
|
-
- Try these operations:
|
|
231
|
-
- Call [`double`](numbers.md#symbol-double) with `amount` = `-1`.
|
|
232
|
-
- If they fail with [`RangeError`](numbers.md#symbol-RangeError), name the failure `error` and recover:
|
|
233
|
-
- Set `rejected` to `value` of `error` equals `-1`.
|
|
234
|
-
- Call `assert` with `rejected` = `rejected`.
|
|
235
|
-
|
|
236
|
-
### Built-in operations used by this file
|
|
237
|
-
|
|
238
|
-
- `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.
|
|
239
|
-
|
|
240
|
-
[Full built-in reference](https://greenpandastudios.github.io/augscript/language-constructs).
|
|
241
|
-
|
|
242
|
-
### Shared language rules
|
|
243
|
-
|
|
244
|
-
See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
|
|
154
|
+
Built-in operations follow the [language reference](https://greenpandastudios.github.io/augscript/language-constructs).
|
|
245
155
|
|
|
246
156
|
::::
|
|
247
157
|
|
|
@@ -10,9 +10,17 @@ outline: [2, 3]
|
|
|
10
10
|
|
|
11
11
|
# Modules and composition
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
Startup combines narrow domain exports with a scoped counter provider. Records and validation keep data and checked failures visible.
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
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.
|
|
16
|
+
|
|
17
|
+
## Follow the program
|
|
18
|
+
|
|
19
|
+
Read [`main.aug`](main.md). Follow the domain imports, provider choices, explicit scope, and checked failure before opening the implementation files.
|
|
20
|
+
|
|
21
|
+
Read [`domain/export.aug`](domain/export.md). The export file gives callers the folder's deliberate public API.
|
|
22
|
+
|
|
23
|
+
Read [`domain/numbers.aug`](domain/numbers.md). The validation interceptor rejects a negative input. Tests cover successful doubling and recovery from that failure.
|
|
16
24
|
|
|
17
25
|
## Project files
|
|
18
26
|
|
|
@@ -27,13 +35,14 @@ Read a file below to see its highlighted source and the Markdown produced by `au
|
|
|
27
35
|
|
|
28
36
|
## Try this project
|
|
29
37
|
|
|
30
|
-
|
|
38
|
+
[Download this project](/downloads/approved-design.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:
|
|
31
39
|
|
|
32
40
|
```sh
|
|
33
|
-
|
|
34
|
-
aug
|
|
35
|
-
aug
|
|
36
|
-
aug
|
|
41
|
+
cd approved-design
|
|
42
|
+
aug check .
|
|
43
|
+
aug spec .
|
|
44
|
+
aug test .
|
|
45
|
+
aug run .
|
|
37
46
|
```
|
|
38
47
|
|
|
39
48
|
[Browse all examples](../index.md)
|
|
@@ -33,6 +33,7 @@ pageClass: aug-example-page
|
|
|
33
33
|
::: code-group
|
|
34
34
|
|
|
35
35
|
```aug [Indentation]
|
|
36
|
+
// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
|
|
36
37
|
import Console and SystemConsole from august.io
|
|
37
38
|
import Application and ApplicationImpl and Fruit and double and RangeError from domain
|
|
38
39
|
import Counter and Counters from counters
|
|
@@ -48,7 +49,9 @@ match names.get(key=2):
|
|
|
48
49
|
when some name:
|
|
49
50
|
print(value=name)
|
|
50
51
|
(code, label) to (3, "plum")
|
|
51
|
-
print(
|
|
52
|
+
print(
|
|
53
|
+
value={Fruit(code=code, name=label), Fruit(name=label, code=code)}.length()
|
|
54
|
+
)
|
|
52
55
|
scope:
|
|
53
56
|
resolve Counter to counter
|
|
54
57
|
borrow counter:
|
|
@@ -62,6 +65,7 @@ catch RangeError error:
|
|
|
62
65
|
```
|
|
63
66
|
|
|
64
67
|
```aug [Braces]
|
|
68
|
+
// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
|
|
65
69
|
import Console and SystemConsole from august.io
|
|
66
70
|
import Application and ApplicationImpl and Fruit and double and RangeError from domain
|
|
67
71
|
import Counter and Counters from counters
|
|
@@ -80,7 +84,9 @@ match names.get(key=2) {
|
|
|
80
84
|
}
|
|
81
85
|
}
|
|
82
86
|
(code, label) to (3, "plum")
|
|
83
|
-
print(
|
|
87
|
+
print(
|
|
88
|
+
value={Fruit(code=code, name=label), Fruit(name=label, code=code)}.length()
|
|
89
|
+
)
|
|
84
90
|
scope {
|
|
85
91
|
resolve Counter to counter
|
|
86
92
|
borrow counter {
|
|
@@ -105,110 +111,27 @@ catch RangeError error {
|
|
|
105
111
|
|
|
106
112
|
## Compiled specification {#specification}
|
|
107
113
|
|
|
108
|
-
|
|
114
|
+
### Providers
|
|
109
115
|
|
|
110
|
-
|
|
116
|
+
`Console` is provided by [`SystemConsole`](dependencies/august/0.20.1/io/contracts.md#symbol-SystemConsole). The same instance is shared.
|
|
111
117
|
|
|
112
|
-
- Include providers from `Counters
|
|
113
|
-
- Register 2 dependency providers before startup.
|
|
114
|
-
- Run startup operations with checked error recovery.
|
|
115
|
-
- Run 7 other startup steps in source order.
|
|
118
|
+
`Application` is provided by [`ApplicationImpl`](domain/app.md#symbol-ApplicationImpl). The same instance is shared. It requires bindings for `Console`. Include providers from [`Counters`](counters.md#symbol-Counters).
|
|
116
119
|
|
|
117
|
-
###
|
|
120
|
+
### Startup
|
|
118
121
|
|
|
119
|
-
|
|
122
|
+
It sets `app` to the instance provided for `Application`. It calls [`app.start`](domain/app.md#symbol-Application.start). It sets `names` to a map with `1` mapped to `"apple"`; `2` mapped to `"pear"`. If the value under `2` in `names` is null, it prints `"missing fruit"`.
|
|
120
123
|
|
|
121
|
-
|
|
122
|
-
- Provide [`ApplicationImpl`](domain/app.md#symbol-ApplicationImpl) when `Application` is requested. Reuse one instance. Required dependencies: `Console`.
|
|
123
|
-
- Include the providers from [`Counters`](counters.md#symbol-Counters) before execution.
|
|
124
|
+
If the value under `2` in `names` is not null, using `name` for it prints `name`. It splits a tuple containing `3`, `"plum"` into `code` and `label` in order. It prints the number of elements in a set containing a [`Fruit`](domain/models.md#symbol-Fruit) with `code` and `name` from `label`, a [`Fruit`](domain/models.md#symbol-Fruit) with `name` from `label` and `code`. Within a task and ownership scope, it sets `counter` to the instance provided for `Counter`.
|
|
124
125
|
|
|
125
|
-
|
|
126
|
+
With temporary permission to change `counter`, it calls [`counter.increment`](counters.md#symbol-Counter.increment). It prints [`counter.value`](counters.md#symbol-Counter.value). On leaving this scope, join its child tasks and release its local values. It prints [`double`](domain/numbers.md#symbol-double) with `amount` `7`.
|
|
126
127
|
|
|
127
|
-
-
|
|
128
|
-
- Call [`Application.start`](domain/app.md#symbol-Application.start) on `app`.
|
|
129
|
-
- Set `names` to a map with `1` mapped to `"apple"`; `2` mapped to `"pear"`.
|
|
130
|
-
- Select the matching case for call `get` on `names` with `key` = `2`:
|
|
131
|
-
- A null value, including omitted optional input:
|
|
132
|
-
- Call `print` with `value` = `"missing fruit"`.
|
|
133
|
-
- A present, non-null value, named `name`:
|
|
134
|
-
- Call `print` with `value` = `name`.
|
|
135
|
-
- Split a tuple containing `3`, `"plum"` into `code`, `label`, in that order.
|
|
136
|
-
- Call `print` with `value` = call `length` on a set containing call [`Fruit`](domain/models.md#symbol-Fruit) with `code` = `code`; `name` = `label`, call [`Fruit`](domain/models.md#symbol-Fruit) with `name` = `label`; `code` = `code`.
|
|
137
|
-
- Create a dependency and task scope. Join its child tasks and release scoped values before leaving:
|
|
138
|
-
- Set `counter` to the instance provided for `Counter`.
|
|
139
|
-
- Grant exclusive mutable access to `counter` for this block, then end the borrow:
|
|
140
|
-
- Call [`Counter.increment`](counters.md#symbol-Counter.increment) on `counter`.
|
|
141
|
-
- Call `print` with `value` = call [`Counter.value`](counters.md#symbol-Counter.value) on `counter`.
|
|
142
|
-
- Try these operations:
|
|
143
|
-
- Call `print` with `value` = call [`double`](domain/numbers.md#symbol-double) with `amount` = `7`.
|
|
144
|
-
- Call [`double`](domain/numbers.md#symbol-double) with `amount` = `-1`.
|
|
145
|
-
- If they fail with [`RangeError`](domain/numbers.md#symbol-RangeError), name the failure `error` and recover:
|
|
146
|
-
- Call `print` with `value` = `"negative amount rejected"`.
|
|
128
|
+
It calls [`double`](domain/numbers.md#symbol-double) with `amount` `-1`. If this work raises [`RangeError`](domain/numbers.md#symbol-RangeError), it prints `"negative amount rejected"`.
|
|
147
129
|
|
|
148
|
-
### Dependencies
|
|
130
|
+
### Dependencies
|
|
149
131
|
|
|
150
|
-
|
|
132
|
+
It uses [`SystemConsole`](dependencies/august/0.20.1/io/contracts.md#symbol-SystemConsole) from `august.io`. It uses [`Counter`](counters.md#symbol-Counter) ([`increment`](counters.md#symbol-Counter.increment) and [`value`](counters.md#symbol-Counter.value)) and [`Counters`](counters.md#symbol-Counters) from `counters`. It uses [`Application`](domain/app.md#symbol-Application) ([`start`](domain/app.md#symbol-Application.start)), [`ApplicationImpl`](domain/app.md#symbol-ApplicationImpl), [`Fruit`](domain/models.md#symbol-Fruit), [`RangeError`](domain/numbers.md#symbol-RangeError), and [`double`](domain/numbers.md#symbol-double) from `domain`.
|
|
151
133
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
Class from `august.io`.
|
|
155
|
-
|
|
156
|
-
Used as a type or provider.
|
|
157
|
-
|
|
158
|
-
#### [`Counter`](counters.md#symbol-Counter)
|
|
159
|
-
|
|
160
|
-
Interface from `counters`.
|
|
161
|
-
|
|
162
|
-
- [`Counter.increment`](counters.md#symbol-Counter.increment) (no caller inputs) → `void`; changes `self`.
|
|
163
|
-
- [`Counter.value`](counters.md#symbol-Counter.value) (no caller inputs) → `int`.
|
|
164
|
-
|
|
165
|
-
#### [`Counters`](counters.md#symbol-Counters)
|
|
166
|
-
|
|
167
|
-
Composition from `counters`.
|
|
168
|
-
|
|
169
|
-
Used as a type or provider.
|
|
170
|
-
|
|
171
|
-
#### [`Application`](domain/app.md#symbol-Application)
|
|
172
|
-
|
|
173
|
-
Interface from `domain`.
|
|
174
|
-
|
|
175
|
-
- [`Application.start`](domain/app.md#symbol-Application.start) (no caller inputs) → `void`; uses [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
|
|
176
|
-
|
|
177
|
-
#### [`ApplicationImpl`](domain/app.md#symbol-ApplicationImpl)
|
|
178
|
-
|
|
179
|
-
Class from `domain`.
|
|
180
|
-
|
|
181
|
-
Used as a type or provider.
|
|
182
|
-
|
|
183
|
-
#### [`Fruit`](domain/models.md#symbol-Fruit)
|
|
184
|
-
|
|
185
|
-
Record from `domain`.
|
|
186
|
-
|
|
187
|
-
- Construct with `code`: `int`, `name`: `string` → [`Fruit`](domain/models.md#symbol-Fruit).
|
|
188
|
-
|
|
189
|
-
#### [`RangeError`](domain/numbers.md#symbol-RangeError)
|
|
190
|
-
|
|
191
|
-
Class from `domain`.
|
|
192
|
-
|
|
193
|
-
Used as a type or provider.
|
|
194
|
-
|
|
195
|
-
#### [`double`](domain/numbers.md#symbol-double)
|
|
196
|
-
|
|
197
|
-
Function from `domain`.
|
|
198
|
-
|
|
199
|
-
- [`double`](domain/numbers.md#symbol-double) (`amount`: `int`) → `int`; can fail with `RangeError`.
|
|
200
|
-
|
|
201
|
-
### Built-in operations used by this file
|
|
202
|
-
|
|
203
|
-
- `Map<int, string>.get` (`key`: `int`) → `optional string`: Read a value by key; an absent key returns null. contains distinguishes an absent key from a stored null.
|
|
204
|
-
- `Set<Fruit>.length` (no inputs) → `int`: Read the number of elements.
|
|
205
|
-
- `print` (`value`: `any`) → `void`: Composition and test output. Other callables receive Console and declare uses console.write.
|
|
206
|
-
|
|
207
|
-
[Full built-in reference](https://greenpandastudios.github.io/augscript/language-constructs).
|
|
208
|
-
|
|
209
|
-
### Shared language rules
|
|
210
|
-
|
|
211
|
-
See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
|
|
134
|
+
Built-in operations follow the [language reference](https://greenpandastudios.github.io/augscript/language-constructs).
|
|
212
135
|
|
|
213
136
|
::::
|
|
214
137
|
|
|
@@ -12,7 +12,7 @@ outline: [2, 3]
|
|
|
12
12
|
|
|
13
13
|
Measure a deterministic arithmetic workload with aug bench.
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
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.
|
|
16
16
|
|
|
17
17
|
## Project files
|
|
18
18
|
|
|
@@ -22,12 +22,13 @@ Read a file below to see its highlighted source and the Markdown produced by `au
|
|
|
22
22
|
|
|
23
23
|
## Try this project
|
|
24
24
|
|
|
25
|
-
|
|
25
|
+
[Download this project](/downloads/benchmark.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:
|
|
26
26
|
|
|
27
27
|
```sh
|
|
28
|
-
|
|
29
|
-
aug
|
|
30
|
-
aug
|
|
28
|
+
cd benchmark
|
|
29
|
+
aug check .
|
|
30
|
+
aug spec .
|
|
31
|
+
aug run .
|
|
31
32
|
```
|
|
32
33
|
|
|
33
34
|
[Browse all examples](../index.md)
|
|
@@ -28,6 +28,7 @@ pageClass: aug-example-page
|
|
|
28
28
|
::: code-group
|
|
29
29
|
|
|
30
30
|
```aug [Indentation]
|
|
31
|
+
// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
|
|
31
32
|
// A deterministic native workload: arithmetic and 20,000 hash entries.
|
|
32
33
|
own Map<int,int> values = {}
|
|
33
34
|
own Set<int> unique = {}
|
|
@@ -45,6 +46,7 @@ print(value=values.length() == unique.length())
|
|
|
45
46
|
```
|
|
46
47
|
|
|
47
48
|
```aug [Braces]
|
|
49
|
+
// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
|
|
48
50
|
// A deterministic native workload: arithmetic and 20,000 hash entries.
|
|
49
51
|
own Map<int,int> values = {}
|
|
50
52
|
own Set<int> unique = {}
|
|
@@ -72,45 +74,15 @@ print(value=values.length() == unique.length())
|
|
|
72
74
|
|
|
73
75
|
## Compiled specification {#specification}
|
|
74
76
|
|
|
75
|
-
|
|
77
|
+
### Startup
|
|
76
78
|
|
|
77
|
-
|
|
79
|
+
It sets `values` of type `Map<int,int>` to a context-typed empty collection with no items. `values` of type `Map<int,int>` owns this value. It sets `unique` of type `Set<int>` to a context-typed empty collection with no items. `unique` of type `Set<int>` owns this value.
|
|
78
80
|
|
|
79
|
-
|
|
81
|
+
It sets `index` to `0`. While `index` is less than `20000`, it stores `index` times `3` in `values` under `index`; then it adds `index` to `unique`; then it increases `index` by `1`. After the loop, it sets `checksum` to `0`. For each `key` and `value` in a snapshot of `values`, if whether `unique` contains `key` returns true, it increases `checksum` by `value`.
|
|
80
82
|
|
|
81
|
-
|
|
83
|
+
After the loop, it prints `checksum`. It prints the number of elements in `values` equals the number of elements in `unique`.
|
|
82
84
|
|
|
83
|
-
-
|
|
84
|
-
- This variable owns the value.
|
|
85
|
-
- Set `unique` of type `Set<int>` to a context-typed empty collection with no items.
|
|
86
|
-
- This variable owns the value.
|
|
87
|
-
- Set `index` of type `int` to `0`.
|
|
88
|
-
- While `index` is less than `20000`, repeat:
|
|
89
|
-
- Call `set` on `values` with `key` = `index`; `value` = (`index` times `3`).
|
|
90
|
-
- Call `add` on `unique` with `value` = `index`.
|
|
91
|
-
- Set `index` to `index` plus `1`.
|
|
92
|
-
- Check the condition again before the next iteration.
|
|
93
|
-
- Set `checksum` of type `int` to `0`.
|
|
94
|
-
- For each `key` and `value` in a snapshot of `values`, in iteration order:
|
|
95
|
-
- If call `contains` on `unique` with `value` = `key` is true:
|
|
96
|
-
- Set `checksum` to `checksum` plus `value`.
|
|
97
|
-
- Call `print` with `value` = `checksum`.
|
|
98
|
-
- Call `print` with `value` = (call `length` on `values` equals call `length` on `unique`).
|
|
99
|
-
|
|
100
|
-
### Built-in operations used by this file
|
|
101
|
-
|
|
102
|
-
- `Map<int, int>.length` (no inputs) → `int`: Read the number of elements.
|
|
103
|
-
- `Map<int, int>.set` (`key`: `int`, `value`: `int`) → `void`: Insert or replace an entry with exclusive mutable access. Changes the receiver.
|
|
104
|
-
- `Set<int>.add` (`value`: `int`) → `void`: Insert a unique element with exclusive mutable access. Changes the receiver.
|
|
105
|
-
- `Set<int>.contains` (`value`: `int`) → `bool`: Test structural or identity equality with a stored element.
|
|
106
|
-
- `Set<int>.length` (no inputs) → `int`: Read the number of elements.
|
|
107
|
-
- `print` (`value`: `any`) → `void`: Composition and test output. Other callables receive Console and declare uses console.write.
|
|
108
|
-
|
|
109
|
-
[Full built-in reference](https://greenpandastudios.github.io/augscript/language-constructs).
|
|
110
|
-
|
|
111
|
-
### Shared language rules
|
|
112
|
-
|
|
113
|
-
See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
|
|
85
|
+
Built-in operations follow the [language reference](https://greenpandastudios.github.io/augscript/language-constructs).
|
|
114
86
|
|
|
115
87
|
::::
|
|
116
88
|
|
|
@@ -12,7 +12,7 @@ outline: [2, 3]
|
|
|
12
12
|
|
|
13
13
|
Read arguments, inspect collections, and return a process exit status.
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
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.
|
|
16
16
|
|
|
17
17
|
## Project files
|
|
18
18
|
|
|
@@ -21,12 +21,13 @@ Read a file below to see its highlighted source and the Markdown produced by `au
|
|
|
21
21
|
|
|
22
22
|
## Try this project
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
[Download this project](/downloads/cli-args.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:
|
|
25
25
|
|
|
26
26
|
```sh
|
|
27
|
-
|
|
28
|
-
aug
|
|
29
|
-
aug
|
|
27
|
+
cd cli-args
|
|
28
|
+
aug check .
|
|
29
|
+
aug spec .
|
|
30
|
+
aug run .
|
|
30
31
|
```
|
|
31
32
|
|
|
32
33
|
[Browse all examples](../index.md)
|
|
@@ -28,6 +28,7 @@ pageClass: aug-example-page
|
|
|
28
28
|
::: code-group
|
|
29
29
|
|
|
30
30
|
```aug [Indentation]
|
|
31
|
+
// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
|
|
31
32
|
try:
|
|
32
33
|
args = arguments()
|
|
33
34
|
print(value=args.length())
|
|
@@ -42,6 +43,7 @@ catch IndexError error:
|
|
|
42
43
|
```
|
|
43
44
|
|
|
44
45
|
```aug [Braces]
|
|
46
|
+
// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
|
|
45
47
|
try {
|
|
46
48
|
args = arguments()
|
|
47
49
|
print(value=args.length())
|
|
@@ -67,40 +69,13 @@ catch IndexError error {
|
|
|
67
69
|
|
|
68
70
|
## Compiled specification {#specification}
|
|
69
71
|
|
|
70
|
-
|
|
72
|
+
### Startup
|
|
71
73
|
|
|
72
|
-
|
|
74
|
+
It sets `args` to `arguments`. It prints the number of elements in `args`. If the number of elements in `args` is positive, it prints the item at index `0` in `args`. It sets `numbers` to a list of `int` containing `1`, `2`.
|
|
73
75
|
|
|
74
|
-
|
|
76
|
+
With temporary permission to change `numbers`, it appends `3` to `numbers`. It prints the item at index `2` in `numbers`. If this work raises `IndexError`, it prints `"unexpected index failure"`.
|
|
75
77
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
- Try these operations:
|
|
79
|
-
- Set `args` to call `arguments`.
|
|
80
|
-
- Call `print` with `value` = call `length` on `args`.
|
|
81
|
-
- If call `length` on `args` is greater than `0`:
|
|
82
|
-
- Call `print` with `value` = call `get` on `args` with `index` = `0`.
|
|
83
|
-
- Set `numbers` to a list of `int` containing `1`, `2`.
|
|
84
|
-
- Grant exclusive mutable access to `numbers` for this block, then end the borrow:
|
|
85
|
-
- Call `append` on `numbers` with `value` = `3`.
|
|
86
|
-
- Call `print` with `value` = call `get` on `numbers` with `index` = `2`.
|
|
87
|
-
- If they fail with `IndexError`, name the failure `error` and recover:
|
|
88
|
-
- Call `print` with `value` = `"unexpected index failure"`.
|
|
89
|
-
|
|
90
|
-
### Built-in operations used by this file
|
|
91
|
-
|
|
92
|
-
- `List<int>.append` (`value`: `int`) → `void`: Append an element with exclusive mutable access. Read-only and owned aliases cannot be stored here. Changes the receiver.
|
|
93
|
-
- `List<int>.get` (`index`: `int`) → `int`: Read a zero-based position. An invalid index raises checked IndexError. Reference results grant reading. Can fail with `IndexError`.
|
|
94
|
-
- `List<string>.get` (`index`: `int`) → `string`: Read a zero-based position. An invalid index raises checked IndexError. Reference results grant reading. Can fail with `IndexError`.
|
|
95
|
-
- `List<string>.length` (no inputs) → `int`: Read the number of elements.
|
|
96
|
-
- `arguments` (no inputs) → `List<string>`: Composition arguments. Other callables receive the Arguments capability.
|
|
97
|
-
- `print` (`value`: `any`) → `void`: Composition and test output. Other callables receive Console and declare uses console.write.
|
|
98
|
-
|
|
99
|
-
[Full built-in reference](https://greenpandastudios.github.io/augscript/language-constructs).
|
|
100
|
-
|
|
101
|
-
### Shared language rules
|
|
102
|
-
|
|
103
|
-
See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
|
|
78
|
+
Built-in operations follow the [language reference](https://greenpandastudios.github.io/augscript/language-constructs).
|
|
104
79
|
|
|
105
80
|
::::
|
|
106
81
|
|
|
@@ -12,7 +12,7 @@ outline: [2, 3]
|
|
|
12
12
|
|
|
13
13
|
Create typed collections and update them through checked mutable access.
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
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.
|
|
16
16
|
|
|
17
17
|
## Project files
|
|
18
18
|
|
|
@@ -21,12 +21,13 @@ Read a file below to see its highlighted source and the Markdown produced by `au
|
|
|
21
21
|
|
|
22
22
|
## Try this project
|
|
23
23
|
|
|
24
|
-
|
|
24
|
+
[Download this project](/downloads/collections.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:
|
|
25
25
|
|
|
26
26
|
```sh
|
|
27
|
-
|
|
28
|
-
aug
|
|
29
|
-
aug
|
|
27
|
+
cd collections
|
|
28
|
+
aug check .
|
|
29
|
+
aug spec .
|
|
30
|
+
aug run .
|
|
30
31
|
```
|
|
31
32
|
|
|
32
33
|
[Browse all examples](../index.md)
|