aboutsummaryrefslogtreecommitdiff
path: root/docs/design/test-coverage.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/design/test-coverage.md')
-rw-r--r--docs/design/test-coverage.md82
1 files changed, 41 insertions, 41 deletions
diff --git a/docs/design/test-coverage.md b/docs/design/test-coverage.md
index fae9356..e916df4 100644
--- a/docs/design/test-coverage.md
+++ b/docs/design/test-coverage.md
@@ -35,7 +35,7 @@ the `qualifiers` group in `toolchain_lsp_contract_test.js` checks both qualifier
## public standard-library documentation
-`src/lib/std.zc` documents public operations for output capture, numeric helpers, packed byte strings, host access, arenas, growable byte buffers, and array algorithms, including parameter and return behavior. the array algorithms document their callback roles, result types, traversal order, and reference sharing. `src/tools/embed.sh all --check` verifies that the compiler's embedded source matches the module. `hover_surface_test.js` and `hover_features_test.js` check selected embedded library documentation; they do not assert that every public function has a description. edge-case behavior for the broader standard-library API still needs dedicated acceptance tests.
+`src/lib/std.zc` documents public operations for output capture, numeric helpers, packed byte strings, host access, arenas, growable byte buffers, and array algorithms, including parameter and return behavior. the array algorithms document their callback roles, result types, traversal order, and reference sharing. the compiler carries the module through an `embed` declaration, so its embedded text is the module file as of the build. `hover_surface_test.js` and `hover_features_test.js` check selected embedded library documentation; they do not assert that every public function has a description. edge-case behavior for the broader standard-library API still needs dedicated acceptance tests.
## unused-argument hints
@@ -69,53 +69,53 @@ the formatter indents case labels one level inside their switch by default (`Cas
## focused commands
-run from the repository root. native binaries and the language server must already be built; the wasm command needs a built `src/web/zc.wasm`.
+run from the repository root. native binaries and the language server must already be built; the wasm command needs a built `build/web/zc.wasm` (`make web`).
```sh
-python3 tests/drivers/fuzz_compiler.py bin/zy bin/zym --js
-python3 tests/drivers/fuzz_malformed.py bin/zy bin/zym
-node tests/drivers/fuzz_wasm.js src/web/zc.wasm
-python3 tests/drivers/image_growth_test.py bin/zy
-python3 tests/drivers/code_emission_growth_test.py bin/zy
-python3 tests/drivers/code_address_growth_test.py bin/zy
+python3 tests/drivers/fuzz_compiler.py build/bin/zy build/bin/zym --js
+python3 tests/drivers/fuzz_malformed.py build/bin/zy build/bin/zym
+node tests/drivers/fuzz_wasm.js build/web/zc.wasm
+python3 tests/drivers/image_growth_test.py build/bin/zy
+python3 tests/drivers/code_emission_growth_test.py build/bin/zy
+python3 tests/drivers/code_address_growth_test.py build/bin/zy
python3 tests/drivers/seed_growth_test.py
python3 tests/drivers/memory_limits_test.py
-python3 tests/drivers/stack_growth_test.py bin/zy
+python3 tests/drivers/stack_growth_test.py build/bin/zy
python3 tests/drivers/layout_config_test.py
-python3 tests/drivers/compiler_growth_test.py bin/zy
-python3 tests/drivers/parser_growth_test.py bin/zy
-node tests/drivers/fuzz_lsp.js bin/zclsp
-node tests/drivers/lsp_growth_test.js bin/zclsp
-node tests/drivers/protocol_growth_test.js bin/zclsp
-node tests/drivers/core_lsp_test.js bin/zclsp
-node tests/drivers/hover_values_test.js bin/zclsp
-node tests/drivers/hover_features_test.js bin/zclsp
-node tests/drivers/hover_surface_test.js bin/zclsp
-CONTRACT_GROUP=inference node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
-CONTRACT_GROUP=qualifiers node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
-python3 tests/drivers/compiler_contract_test.py bin/zy --group qualifiers
-python3 tests/drivers/compiler_contract_test.py bin/zym --group qualifiers
-python3 tests/drivers/inference_growth_test.py bin/zclsp
-node tests/drivers/storage_analysis_test.js bin/zclsp
-node tests/drivers/hints_test.js bin/zclsp
-node tests/drivers/include_test.js bin/zclsp
-CONTRACT_GROUP=quickfix node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
-CONTRACT_GROUP=modulehover node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
-CONTRACT_GROUP=namespacecompletion node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
-CONTRACT_GROUP=navigation node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
+python3 tests/drivers/compiler_growth_test.py build/bin/zy
+python3 tests/drivers/parser_growth_test.py build/bin/zy
+node tests/drivers/fuzz_lsp.js build/bin/zclsp
+node tests/drivers/lsp_growth_test.js build/bin/zclsp
+node tests/drivers/protocol_growth_test.js build/bin/zclsp
+node tests/drivers/core_lsp_test.js build/bin/zclsp
+node tests/drivers/hover_values_test.js build/bin/zclsp
+node tests/drivers/hover_features_test.js build/bin/zclsp
+node tests/drivers/hover_surface_test.js build/bin/zclsp
+CONTRACT_GROUP=inference node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
+CONTRACT_GROUP=qualifiers node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
+python3 tests/drivers/compiler_contract_test.py build/bin/zy --group qualifiers
+python3 tests/drivers/compiler_contract_test.py build/bin/zym --group qualifiers
+python3 tests/drivers/inference_growth_test.py build/bin/zclsp
+node tests/drivers/storage_analysis_test.js build/bin/zclsp
+node tests/drivers/hints_test.js build/bin/zclsp
+node tests/drivers/include_test.js build/bin/zclsp
+CONTRACT_GROUP=quickfix node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
+CONTRACT_GROUP=modulehover node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
+CONTRACT_GROUP=namespacecompletion node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
+CONTRACT_GROUP=navigation node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
node tests/drivers/codeactions_client_test.js
node tests/drivers/ext_cache_test.js
-python3 tests/drivers/array_methods_test.py bin/zy
-python3 tests/drivers/array_methods_test.py bin/zy --case map
-python3 tests/drivers/array_methods_test.py bin/zy --case filter
-python3 tests/drivers/array_methods_test.py bin/zy --case search
-python3 tests/drivers/array_methods_test.py bin/zy --case reduce
+python3 tests/drivers/array_methods_test.py build/bin/zy
+python3 tests/drivers/array_methods_test.py build/bin/zy --case map
+python3 tests/drivers/array_methods_test.py build/bin/zy --case filter
+python3 tests/drivers/array_methods_test.py build/bin/zy --case search
+python3 tests/drivers/array_methods_test.py build/bin/zy --case reduce
python3 tests/drivers/cli_help_test.py
python3 tests/drivers/runtime_image_test.py
-CONTRACT_GROUP=magic node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
-CONTRACT_GROUP=strings node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
-CONTRACT_GROUP=arguments node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
-CONTRACT_GROUP=modules node tests/drivers/toolchain_lsp_contract_test.js bin/zclsp
-node tests/drivers/nav_test.js bin/zclsp
-tests/runerr.sh bin/zy tests/errors
+CONTRACT_GROUP=magic node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
+CONTRACT_GROUP=strings node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
+CONTRACT_GROUP=arguments node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
+CONTRACT_GROUP=modules node tests/drivers/toolchain_lsp_contract_test.js build/bin/zclsp
+node tests/drivers/nav_test.js build/bin/zclsp
+tests/runerr.sh build/bin/zy tests/errors
```