enhance `std.Build.Step.Fmt` and use it more #20321

andrewrk · 2024-06-17T02:33:49Z

Example of a zig fmt failure with this branch:

[nix-shell:~/dev/zig/build-release]$ stage3/bin/zig build test-fmt
test-fmt
└─ zig fmt --check failure
error: /home/andy/dev/zig/src/main.zig: non-conforming formatting
error: the following command exited with error code 1:
/home/andy/dev/zig/build-release/stage3/bin/zig fmt --check /home/andy/dev/zig/lib /home/andy/dev/zig/src /home/andy/dev/zig/test /home/andy/dev/zig/tools /home/andy/dev/zig/build.zig /home/andy/dev/zig/build.zig.zon --exclude /home/andy/dev/zig/test/cases 
Build Summary: 0/2 steps succeeded; 1 failed (disable with --summary none)
test-fmt transitive failure
└─ zig fmt --check failure
error: the following build command failed with exit code 1:
/home/andy/dev/zig/.zig-cache/o/3ac7a20af5c73e65a83d2e9b65218673/build /home/andy/dev/zig/build-release/stage3/bin/zig /home/andy/dev/zig /home/andy/dev/zig/.zig-cache /home/andy/.cache/zig --seed 0x8b717bd6 -Z1af88b3aa2fcdad6 test-fmt

See individual commit messages for more details.

There was not a way to pass a progress node to this function until now.

Now there is `captureChildProcess` which gives access to the `std.process.Child.RunResult`, which is useful for accessing the stdout. It also accepts and passes an optional `std.Progress.Node` to the child.

When in --check mode, and files are found to not conform, emit them explicitly as step errors. Previously this stdout data was being ignored.

There was already `zig build test-fmt` but now `zig build test` depends on that one. The CI scripts no longer need explicit logic since they already do `zig build test`.

andrewrk added 5 commits June 16, 2024 19:27

std.Progress.Node: add none init value

20e20f9

std.process.Child: run fn accepts std.Progress.Node

42658de

There was not a way to pass a progress node to this function until now.

std.Build.Step: split evalChildProcess into two functions

af7afbd

Now there is `captureChildProcess` which gives access to the `std.process.Child.RunResult`, which is useful for accessing the stdout. It also accepts and passes an optional `std.Progress.Node` to the child.

std.Build.Step.Fmt: display non-conforming files

eb8201a

When in --check mode, and files are found to not conform, emit them explicitly as step errors. Previously this stdout data was being ignored.

make zig build test check for conforming formatting

cb1d1bd

There was already `zig build test-fmt` but now `zig build test` depends on that one. The CI scripts no longer need explicit logic since they already do `zig build test`.

andrewrk added release notes This PR should be mentioned in the release notes. zig build system std.Build, the build runner, `zig build` subcommand, package management labels Jun 17, 2024

andrewrk mentioned this pull request Jun 17, 2024

ZON #20271

Merged

4 tasks

andrewrk enabled auto-merge June 17, 2024 03:32

andrewrk merged commit fda2458 into master Jun 17, 2024
10 checks passed

andrewrk deleted the build-system-fmt branch June 17, 2024 05:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

enhance `std.Build.Step.Fmt` and use it more #20321

enhance `std.Build.Step.Fmt` and use it more #20321

andrewrk commented Jun 17, 2024 •

edited

Loading

enhance std.Build.Step.Fmt and use it more #20321

enhance std.Build.Step.Fmt and use it more #20321

Conversation

andrewrk commented Jun 17, 2024 • edited Loading

enhance `std.Build.Step.Fmt` and use it more #20321

enhance `std.Build.Step.Fmt` and use it more #20321

andrewrk commented Jun 17, 2024 •

edited

Loading