https://github.com/exercism/common-lisp-representer

https://github.com/exercism/common-lisp-representer

community-contributions-paused exercism-representer exercism-tooling

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/exercism/common-lisp-representer
• Owner: exercism
• License: agpl-3.0
• Created: 2020-01-19T11:18:29.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-02-29T17:09:50.000Z (10 months ago)
• Last Synced: 2024-05-01T11:25:12.993Z (8 months ago)
• Topics: community-contributions-paused, exercism-representer, exercism-tooling
• Language: Common Lisp
• Size: 118 KB
• Stars: 2
• Watchers: 9
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Common Lisp Representer

(_c.f._ For full details and up to date documentation on automated representers for Exercism see the [Automated Analysis][automated-analysis] repository.

> The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC 2119][rfc-2119].

## Interface

(_.c.f._ [The Representer Interface][automated-analysis-representer-interface])

The `/opt/representer/bin/run.sh` script that the docker image runs receives two parameters:

1. the test slug

2. the input directory namestring. This directory contains the submitted code.

2. the output directory namestring. This directory will be writable.

The script *MUST* write the following files to the directory:

1. `representation.txt`: a normalized representation of the submitted code. All symbols must be replaced by generated symbols.

2. `mapping.json`: maps the generated symbols in `representation.txt` to the original symbols.

The output of the script *MAY* write the following files to the directory:

1. `representation.out`: any information that may want to view later for debugging.

The script *MAY* produce output to `stdout` and `stderr` which will be persisted for later.

[automated-analysis]: https://github.com/exercism/automated-analysis/

[automated-analysis-representer-interface]: https://github.com/exercism/automated-analysis/blob/master/docs/representers/interface.md

[rfc-2119]: https://www.ietf.org/rfc/rfc2119.txt