Tools usage pages by pataei · Pull Request #245 · LFDT-Minokawa/compact

pataei · 2026-03-23T18:32:51Z

Addresses #62.

Removes old out of date files.

Adds usage pages for formatter, fixup, and dev tool.

Adds --update-Uint-range to help text of fixup.

Adds --line-length to fixup.

Signed-off-by: pataei <paris.ataei@gmail.com>

github-actions · 2026-03-23T18:33:44Z

Plugin Test Results

1 files 3 suites 1s ⏱️
21 tests 21 ✅ 0 💤 0 ❌
23 runs 23 ✅ 0 💤 0 ❌

Results for commit a74fa77.

♻️ This comment has been updated with latest results.

github-actions · 2026-03-23T18:40:19Z

Compactc E2E Tests Results

2 825 tests 2 825 ✅ 6m 50s ⏱️
1 suites 0 💤
1 files 0 ❌

Results for commit a74fa77.

♻️ This comment has been updated with latest results.

github-actions · 2026-03-23T18:41:41Z

Flaky Rate

Overall Flakiness	0.00% ±0

No current tests have flaky rates to display ✨

Github Test Reporter by CTRF 💚

Flaky Rate

Overall Flakiness	0.00% ±0

No current tests have flaky rates to display ✨

Github Test Reporter by CTRF 💚

Flaky Rate

Overall Flakiness	0.00% ±0

No current tests have flaky rates to display ✨

Github Test Reporter by CTRF 💚

Flaky Rate

Overall Flakiness	0.00% ±0

No current tests have flaky rates to display ✨

Github Test Reporter by CTRF 💚

Signed-off-by: pataei <paris.ataei@gmail.com>

doc/compiler-usage.md

doc/fixup-usage.md

doc/formatter-usage.md

Signed-off-by: pataei <paris.ataei@gmail.com>

github-actions · 2026-03-25T18:04:20Z

Plugin Test Summary

1 files 3 suites 1s ⏱️
21 tests 21 ✅ 0 💤 0 ❌
23 runs 23 ✅ 0 💤 0 ❌

Results for commit f8d7cc8.

♻️ This comment has been updated with latest results.

github-actions · 2026-03-25T18:15:25Z

Compactc E2E Test Summary

1 files ± 0 1 suites - 47 5m 50s ⏱️ + 3m 21s
2 827 tests +2 360 2 827 ✅ +2 366 0 💤 - 6 0 ❌ ±0
2 827 runs +2 349 2 827 ✅ +2 355 0 💤 - 6 0 ❌ ±0

Results for commit f8d7cc8. ± Comparison against base commit 90d3f41.

This pull request removes 467 and adds 2827 tests. Note that renamed tests count towards both.

src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[MFG-413] should compile and not thro…'
src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[PM-12371] should compile and not thr…'
src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[PM-15405] should compile and not thr…'
src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[PM-15733] should compile and not thr…'
src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[PM-15826] should compile and not thr…'
src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[PM-16040] should compile and not thr…'
src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[PM-16059] should compile and not thr…'
src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[PM-16447] should compile and not thr…'
src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[PM-16853] should compile and not thr…'
src/tests/bugs/compiler.bugs.e2e.test.ts ‑ [Bugs] Compiler > '[PM-16999] should return an error if …'
…

src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_0.compact'
src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_1.compact'
src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_10.compact'
src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_100.compact'
src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_1000.compact'
src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_1001.compact'
src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_1002.compact'
src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_1003.compact'
src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_1004.compact'
src/tests/extracted.e2e.test.ts ‑ [E2E] Extracted unit tests for compiler > should be able to compile extracted contract: '/home/runner/work/_temp/nix-shell.RmaYTM/temp-test-8oiBKZ/contract_1005.compact'
…

♻️ This comment has been updated with latest results.

…e-length, update changelog Signed-off-by: pataei <paris.ataei@gmail.com>

Signed-off-by: pataei <paris.ataei@gmail.com>

doc/dev-tool-usage.md

dybvig · 2026-03-27T08:09:25Z

doc/dev-tool-usage.md

+
+where **0.26.0** is the installed version and **0.28.0** is the latest available
+version of the Compact toolchain. The command **update** can be used to update
+to this version. **aarch64-darwin** spits out the chosen binary of the Compact


"spits out" is slang and should be replaced with something less informal. I don't know what to suggest because I don't know what this is trying to say.

I changed it to displays.

dybvig · 2026-03-27T08:12:09Z

doc/dev-tool-usage.md

+toolchain for your machine's architecture.
+
+The options in OPTIONS can be used with this command. **--directory
+_directorypath_** and **--version** behave the same as not using a command


I think I understand what this is trying to say, but it's certainly not clear. I suggest just saying that the help option gives help for this command.

Revised it.

doc/dev-tool-usage.md

dybvig · 2026-03-27T12:21:57Z

doc/dev-tool-usage.md

+The Compact command-line tool provides a set of utilities for Compact smart
+contract development.
+
+SYNOPSYS


"SYNOPSYS" => "SYNOPSIS.

this misspelling appears several times below as well.

Also, to be consistent, "SYNOPSIS" should be "Synopsis" or the later ones should be changed to match the case of this one.

The one that is in all caps is the subtitle whereas the ones that aren't all caps aren't. I fixed the typo.

doc/dev-tool-usage.md

dybvig · 2026-03-27T12:24:20Z

doc/dev-tool-usage.md

+COMPILE
+=======
+
+Synopsys: **compact** **compile** _+version_ _option_ _sourcepath_ _targetpath_


So only one option is allowed?

No, good catch.

dybvig · 2026-03-27T12:24:38Z

doc/dev-tool-usage.md

+This command compiles the Compact source program in _sourcepath_ using the
+specified Compact toolchain version _version_ if it exits. If a version is not
+specified the default version of the Compact toolchain installed is picked. The
+_option_ can be one of the flags accepted by the Compact compiler and the


Again, only one option is allowed?

Also, --help doesn't actually give the compiler's help, and unless a version is specified, --version doesn't actually given the compiler's version, right?

Corrected the option issue. Line 285 explicitly discusses compact compile --help vs compact compile +version --help.

doc/dev-tool-usage.md

Signed-off-by: pataei <paris.ataei@gmail.com>

dybvig

LGTM

pataei added 3 commits March 23, 2026 12:13

old changes

4b52d5d

Signed-off-by: pataei <paris.ataei@gmail.com>

Merge branch 'main' into pm-21417/manpages

272a3f0

Signed-off-by: pataei <paris.ataei@gmail.com>

add all usage.md files

a41eb1a

Signed-off-by: pataei <paris.ataei@gmail.com>

pataei added 2 commits March 23, 2026 20:08

all usages fixed

1253bab

Signed-off-by: pataei <paris.ataei@gmail.com>

Merge branch 'main' into pm-21417/manpages

b66221d

pataei marked this pull request as ready for review March 24, 2026 02:14

pataei requested review from a team as code owners March 24, 2026 02:14

pataei added 4 commits March 24, 2026 09:28

fix ci, remove old files

f56452a

Signed-off-by: pataei <paris.ataei@gmail.com>

add note on using +version for compact compile

8263716

Signed-off-by: pataei <paris.ataei@gmail.com>

Merge branch 'main' into pm-21417/manpages

2b21a69

remove extra line

a74fa77

Signed-off-by: pataei <paris.ataei@gmail.com>

pataei requested a review from dybvig March 24, 2026 18:23

dybvig requested changes Mar 25, 2026

View reviewed changes

apply Kent's review except for one issue

d535bd2

Signed-off-by: pataei <paris.ataei@gmail.com>

Merge branch 'main' into pm-21417/manpages

d9d6595

pataei added 2 commits March 25, 2026 12:23

bump compiler version, add test, add qa test for negative case of lin…

363188a

…e-length, update changelog Signed-off-by: pataei <paris.ataei@gmail.com>

applied feedback

d5cc71a

Signed-off-by: pataei <paris.ataei@gmail.com>

dybvig requested changes Mar 27, 2026

View reviewed changes

pataei added 2 commits March 27, 2026 11:30

applied Kent's review

90c3197

Signed-off-by: pataei <paris.ataei@gmail.com>

Merge branch 'main' into pm-21417/manpages

f8d7cc8

dybvig approved these changes Mar 28, 2026

View reviewed changes

Conversation

pataei commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Plugin Test Results

Uh oh!

github-actions bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Compactc E2E Tests Results

Uh oh!

github-actions bot commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Flaky Rate

Flaky Rate

Flaky Rate

Flaky Rate

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Plugin Test Summary

Uh oh!

github-actions bot commented Mar 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Compactc E2E Test Summary

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dybvig left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

pataei commented Mar 23, 2026 •

edited

Loading

github-actions bot commented Mar 23, 2026 •

edited

Loading

github-actions bot commented Mar 23, 2026 •

edited

Loading

github-actions bot commented Mar 23, 2026 •

edited

Loading

github-actions bot commented Mar 25, 2026 •

edited

Loading

github-actions bot commented Mar 25, 2026 •

edited

Loading