https://github.com/exercism/raku-representer
https://github.com/exercism/raku-representer
exercism-representer exercism-tooling maintained
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/exercism/raku-representer
- Owner: exercism
- License: agpl-3.0
- Created: 2024-03-28T13:56:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-01T00:39:10.000Z (3 months ago)
- Last Synced: 2025-04-09T06:12:50.933Z (2 months ago)
- Topics: exercism-representer, exercism-tooling, maintained
- Language: Shell
- Size: 71.3 KB
- Stars: 0
- Watchers: 4
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
## Default Implementation
The default implementation works as follows:
- The `representation.txt` contains the concatenated solution files
- Solution files are separated by an empty line
- Solution files are identified via the the `.files.solution[]` property in the `.meta/config.json` file
- The `mapping.json` contains an empty JSON object (`{}`)
### Normalizations
- Blank files in the solution files are removed in the `representation.txt`
- Line-based trailing whitespace in the solution files is removed in the `representation.txt`
# Exercism Raku Representer
The Docker image to automatically create a representation for Raku solutions submitted to [Exercism].
## Run the representer
To create a representation for an arbitrary exercise, do the following:
1. Open a terminal in the project's root
2. Run `./bin/run.sh `
Once the representer has finished, its results will be written to `/representation.txt` and `/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:
1. Open a terminal in the project's root
2. Run `./bin/run-in-docker.sh `
Once the representer has finished, its results will be written to `/representation.txt` and `/mapping.json`.
## Run the tests
To run the tests to verify the behavior of the representer, do the following:
1. Open a terminal in the project's root
2. Run `./bin/run-tests.sh`
These are [golden tests][golden] that compare the `representation.txt` and `mapping.json` generated by running the current state of the code against the "known good" `tests//representation.txt` and `tests//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//representation.txt` and `tests//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:
1. Open a terminal in the project's root
2. Run `./bin/run-tests-in-docker.sh`
These are [golden tests][golden] that compare the `representation.txt` and `mapping.json` generated by running the current state of the code against the "known good" `tests//representation.txt` and `tests//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//representation.txt` and `tests//mapping.json` file.
[representers]: https://github.com/exercism/docs/tree/main/building/tooling/representers
[golden]: https://ro-che.info/articles/2017-12-04-golden-tests
[exercism]: https://exercism.io