An open API service indexing awesome lists of open source software.

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

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