crystal-representer v1.3.2
Exercism Crystal Representer
The Docker image to automatically create a representation for Crystal solutions submitted to Exercism.
Run the representer
To create a representation for an arbitrary exercise, do the following:
- Open a terminal in the project's root
- Run
./bin/run.sh <exercise-slug> <solution-dir> <output-dir>
Once the representer has finished, its results will be written to <output-dir>/representation.txt
and <output-dir>/mapping.json
.
Run the representer on an exercise using Docker
This script is provided for testing purposes, as it mimics how representers run in Exercism's production environment.
To create a representation for an using the Docker image, do the following:
- Open a terminal in the project's root
- Run
./bin/run-in-docker.sh <exercise-slug> <solution-dir> <output-dir>
Once the representer has finished, its results will be written to <output-dir>/representation.txt
and <output-dir>/mapping.json
.
Run the tests
To run the tests to verify the behavior of the representer, do the following:
- Open a terminal in the project's root
- Run
./bin/run-tests.sh
These are golden tests that compare the representation.txt
and mapping.json
generated by running the current state of the code against the "known good" tests/<test-name>/representation.txt
and tests/<test-name>/mapping.json
. All files created during the test run itself are discarded.
When you've made modifications to the code that will result in a new "golden" state, you'll need to generate and commit a new tests/<test-name>/representation.txt
and tests/<test-name>/mapping.json
file.
Run the tests using Docker
This script is provided for testing purposes, as it mimics how representers run in Exercism's production environment.
To run the tests to verify the behavior of the representer using the Docker image, do the following:
- Open a terminal in the project's root
- Run
./bin/run-tests-in-docker.sh
These are golden tests that compare the representation.txt
and mapping.json
generated by running the current state of the code against the "known good" tests/<test-name>/representation.txt
and tests/<test-name>/mapping.json
. All files created during the test run itself are discarded.
When you've made modifications to the code that will result in a new "golden" state, you'll need to generate and commit a new tests/<test-name>/representation.txt
and tests/<test-name>/mapping.json
file.
crystal-representer
- 1
- 2
- 5
- 1
- 0
- 21 days ago
- March 29, 2023
GNU Affero General Public License v3.0
Sun, 22 Dec 2024 08:17:04 GMT