Elm

To create a new assignment in Elm, click into one of your courses, and then click Add assignment. Choose Elm from the drop-down list of available frontend frameworks and set the the rest of your assignment's parameters (deadline, etc.). Once the assignment is created, a new folder will be created in the private GitHub/GitLab template repository for the course in which you are added this assignment. This folder will contain a standard Elm project structure.

Automated test-suite setup

If you would like to add unit tests that are automatically run by AssignmentOS against each student's solution to your assignment, you can add these as unit test files in the tests/ directory.

All test files with filenames that end with Hidden.elm will not be visible to the student.

If you want to add files that your hidden unit tests use and hence are also not visible to the student, the names of these files must begin with hidden (case-insensitive), e.g., hiddenFoo.json, hiddenFoo.csv, HiddenFoo.hs, etc.

The elm.json file should only be modified in order to add any third-party dependencies required for your assignment.

Your assignment must use/be compatible with Elm version 0.19.1.

GitHub Action & GitLab CI/CD

AssignmentOS uses either GitHub Actions or GitLab CI/CD (depending on whether you use with GitHub or GitLab) to run automated unit tests. We provide the following GitHub Action & GitLab CI/CD file for Elm assignments. Note that this file is added dynamically to the repo of each student taking your assignment, so please do not include it in your template repo. This file also cannot be changed.

GitHub Action .yml fileGitLab CI/CD .yml file
name: Elm CI

on: push

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - uses: jorelali/setup-elm@v3
      with:
        elm-version: 0.19.1
    - run: npx elm-test

Coming soon!

Examples

An example Elm assignment that uses automated test suite scoring can be seen here: https://github.com/AssignmentOS-HQ/Elm-AssignmentOS-Example.

Last updated