TypeScript

To create a new assignment in TypeScript, click into one of your courses, and then click Add assignment. Choose TypeScript (Node.js) from the drop-down list of available backend languages 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 Node.js project structure:

Automated test-suite setup

If you would like to add 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 unit tests use the Jest testing framework.

All unit test file names must end with .spec.ts and all unit test files with file names ending with .hidden.spec.ts 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, e.g., hiddenFoo.json, hiddenFoo.csv, hidden-foo.js, etc.

The package.json file should only be modified in order to add any third-party dependencies required for your solution. The jest and babel versions should not be changed.

The assignment must be compatible with Node.js version 18.

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 TypeScript 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 file

GitLab CI/CD .yml file

name: Node.js CI on: push jobs: build: runs-on: ubuntu-latest strategy: matrix: node-version: [18.x] steps: - uses: actions/checkout@v3 - name: Use Node.js ${{ matrix.node-version }} uses: actions/setup-node@v3 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: node-version: ${{ matrix.node-version }} - run: npm install - run: npm ci - run: npm run build --if-present - run: npm test -- --passWithNoTests

Coming soon!

Examples

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