Commit graph

905 commits

Author SHA1 Message Date
Manlio Perillo
ede6671c27 build: remove the install step in the normal build mode
Removing the install step will simplify the current code.

Copying the exercise executable to the zig-out directory can be done in
`ZiglingStep.

Closes #298
2023-05-14 17:21:59 +02:00
Manlio Perillo
164df04618 build: remove the special eowyn build mode
The special eowyn mode was added in order to improve the performance of
the Eowyn Github workflow.

Remove it, since it adds unnecessary complexity to the `build.zig` file.

Closes #297
2023-05-14 17:20:47 +02:00
Chris Boesch
ab94a50b3f Merge pull request #278 from chrboesch/testing
Added new flag 'run_test' to support test steps for test exercises
2023-05-13 23:31:28 +02:00
Chris Boesch
7efdff36a8 Execution of test exercises added. 2023-05-13 21:42:48 +02:00
Chris Boesch
cee64c13e0 Merge branch 'ratfactor:main' into testing 2023-05-13 19:30:33 +02:00
Chris Boesch
22c3b10855 Merge pull request #293 from perillo/improve-build-even-more
More improvements to build.zig and test/tests.zig
2023-05-11 18:50:20 +02:00
Manlio Perillo
7aa0737929 Restore unit tests
Commit dbd42bb (Cleaning up zig build output) broke the unit test.

Always use exit code 2, instead of 0.  This is the exit code used by the
build runner to notify the compiler to not report any further
diagnostics.

Move the Ziglings logo from the `build` function scope to the global
scope, and make it public so that tests.zig can use it to find the
number of lines to skip, instead of using an hard coded value.

Fixes #295
2023-05-09 17:28:41 +02:00
Manlio Perillo
e4e096c680 build: make literal paths portable
Use fs.path.sep_str instead of a slash, in literal paths.
2023-05-09 11:11:11 +02:00
Manlio Perillo
728402c64f tests: remove the missing functions from RunStep
Use directly the RunStep.addCheck method, instead.
2023-05-09 11:11:11 +02:00
Manlio Perillo
14545778b2 build: improve code formatting
Avoid too long lines or too many line breaks.
2023-05-09 11:11:11 +02:00
Manlio Perillo
ea4144a416 build: add the dumpArgs function
Use it in Zigling.compile, in order to reduce code duplication.
2023-05-09 11:11:03 +02:00
Manlio Perillo
9de89f6d60 build: fix doc-comments
Some functions and custom build steps incorrectly used a normal comment.
Use a doc-comment instead.

Additionally, use a present tense verb to describe the action of a
function or custom build step.
2023-05-09 11:07:22 +02:00
Manlio Perillo
dd5df9f7cc build: use the blank identifier in the parameter list
Instead of marking a parameter as unused inside the function body.
2023-05-09 11:07:22 +02:00
Manlio Perillo
bb42451b0f build: use self when using @fieldParentPtr
Update PrintStep and SkipStep to use the `self` variable when getting
the parent pointer from Step.

This convention is used in `std.Build`.
2023-05-09 11:07:22 +02:00
Manlio Perillo
4ae67ebf1b build: don't install skipped exercises
Update the code in `zig build install` and `zig build -Dn=n install`, so
that exercises that must be skipped are not installed, since it will
cause an error.  Ensure that a skip message is printed.
2023-05-09 11:07:22 +02:00
Manlio Perillo
185a40eb75 build: fix zig build -Dhealed install
The command fails because the path to the exercises directory was
incorrectly set to "exercises" instead of `work_path`.

The bug was introduced in commit b56bb7b
(build: enable full parallelism when -Dhealed is set).

Remove the comment about not using multi-object loop, since it is
confusing.
2023-05-09 11:07:22 +02:00
Chris Boesch
1d7452bf96 Merge branch 'ratfactor:main' into testing 2023-05-09 10:02:03 +02:00
Dave Gauer
c4f2c62534 Cleaning up zig build output
* Only show actual Zig compiler errors, not build internals to
  confused and dismay.

* Remove advanced usage instructions not needed in normal
  operation.
2023-05-08 09:20:27 -04:00
Chris Boesch
2cb6975b13 Merge branch 'ratfactor:main' into testing 2023-05-07 17:59:28 +02:00
Chris Boesch
ded01c6adf Merge pull request #292 from kimshrier/exercise_099_typo
Add missing word "a"
2023-05-07 17:45:13 +02:00
Chris Boesch
94f52b9298 Merge pull request #291 from kimshrier/exercise_098_typo
Improve wording in some comments
2023-05-07 17:44:07 +02:00
Chris Boesch
e706c4b42c Merge pull request #290 from kimshrier/exercise_096_fix_example
Fix reference to slice_ptr in example code
2023-05-07 17:40:33 +02:00
Chris Boesch
f917f50be0 Merge pull request #289 from kimshrier/exercise_092_typo
Remove repeated word "with"
2023-05-07 17:39:21 +02:00
Chris Boesch
151abb4ca1 Merge pull request #288 from kimshrier/exercise_076_typo
Add missing word "of"
2023-05-07 17:38:11 +02:00
Chris Boesch
2b17c3dc39 Merge pull request #287 from kimshrier/exercise_072_typo
Add missing word "to"
2023-05-07 17:37:33 +02:00
Chris Boesch
1fccbc439f Merge pull request #286 from kimshrier/exercise_001_typo
fix typo well -> will
2023-05-07 17:36:34 +02:00
Kim SHrier
2b2c396237 Add missing word "a" 2023-05-07 03:33:55 -06:00
Kim SHrier
b10e478398 Improve wording in some comments 2023-05-07 03:24:10 -06:00
Kim SHrier
b072c0014c Fix reference to slice_ptr in example code 2023-05-07 03:08:03 -06:00
Kim SHrier
7af542bffb Remove repeated word "with" 2023-05-07 02:46:07 -06:00
Kim SHrier
cc9f68c4e5 Add missing word "of" 2023-05-07 02:04:30 -06:00
Kim SHrier
6bdc1caaae add missing word "to" 2023-05-07 01:38:28 -06:00
Kim SHrier
d82396c174 fix typo well -> will 2023-05-06 15:38:13 -06:00
Chris Boesch
ea93abf4d4 Merge branch 'ratfactor:main' into testing 2023-05-06 20:53:28 +02:00
Chris Boesch
a446d67992 Merge pull request #285 from chrboesch/improve_instruction
Improve instructions.
2023-05-06 20:50:20 +02:00
Chris Boesch
b6b78c628c Merge branch 'main' into improve_instruction 2023-05-06 20:22:20 +02:00
Chris Boesch
a5485bb8a2 Improve instructions. 2023-05-06 20:14:30 +02:00
Chris Boesch
b963f2659e Merge branch 'ratfactor:main' into testing 2023-05-06 19:15:49 +02:00
Chris Boesch
df833e61e8 Merge pull request #284 from perillo/improve-exercise-type-more
Improve Exercise type more
2023-05-06 19:15:14 +02:00
Manlio Perillo
3f81cdf3ac build: improve Exercise.addExecutable
Replace the file_path variable with path.
2023-05-06 18:18:08 +02:00
Manlio Perillo
1dd5852bec build: use multiline string literals when necessary
Update the output and hint fields in the `exercises` slice to use a
multiline string literal when the string have multiple lines or use the
`"` character.  This will greatly improve readability.
Additionally, remove the trailing whitespace on each line and check it
in the validate_exercises function.

Update the output comparison logic in ZiglingStep, since the current
code assumes that the string has only one line.

Update test/tests.zig to use the new `CheckNamedStep` in test case 1,
since RunStep.StdIo.Check is no longer able to correctly check the
output.

Fixes #283
2023-05-06 18:12:04 +02:00
Chris Boesch
f1368f4f81 Merge branch 'ratfactor:main' into testing 2023-05-06 15:29:22 +02:00
Manlio Perillo
397c6671c0 build: remove assertion in Exercise.key
Use `orelse unreachable` instead, in order to simplify the code.

Fix doc-comments in the Exercise type.
2023-05-06 12:02:21 +02:00
Manlio Perillo
be43e2d010 build: make Exercise.hint optional
Use an optional type, instead of an empty string, since it is more
idiomatic.
2023-05-06 11:50:42 +02:00
Dave Gauer
e5341b91c1 Ex 101: Magic bags better than buckets for metaphors 2023-05-05 18:34:36 -04:00
Chris Boesch
1c73ad29a7 Merge pull request #281 from perillo/add-healed-path-option
Add the -Dhealed-path option
2023-05-05 17:44:05 +02:00
Manlio Perillo
0cd86d2f9b build: add the healed-path option
This is necessary in the unit tests, to ensure each test case use a
different exercises directory.

Update test/tests.zig to use the new healed-path option, ensuring that
each temp directory is removed.

In test case 3, 4 and 5, move case_step as the first step in the
dependency chain.  This will improve the build summary tree.

In test case 5, remove the dependency to heal_step, since it is not
necessary.
2023-05-05 16:22:50 +02:00
Chris Boesch
e273dd298e Merge pull request #280 from arnon4/patch-1
Fixed example syntax for inline else
2023-05-05 16:03:05 +02:00
Arnon
25611b8312 Fixed example syntax for inline else 2023-05-05 13:11:20 +03:00
Dave Gauer
f2b3e93402 Merge branch 'main' of github.com:ratfactor/ziglings 2023-05-04 19:05:36 -04:00