autograding-setup

Script to insert all files and configuration for autograding into exercise repositories

Requirements for target repos (usage)

• Test files need to be in __tests__ directory
• To be used for autograding test file names need to match the glob pattern tasks.*.js i.e. tasks.1.js
• The package.json needs to have

"scripts": {
   "preinstall": "npm_config_yes=true npx @dci-edtech/autograding-setup --no"
}

What it does

Inserted files

|
|   .gitignore
|___.husky
|   |    pre-commit
|___.github
    |___classroom
    |   |   autograding.json
    |___workflows
    |   |   classroom.yml
    |   .keep

Generated and modified files

• .github/classroom/autograding.json is generated based on the matching test files in __tests__
• package.json is expanded with
  • devDependencies
  • prepare script: husky install
  • scripts for testing
  • eslint settings
  • jest settings
• README.md receives a line to include the result score of the autograding

Commands executed during installation

• husky install
• git add . && git commit -m "added autograding setup"

Options

--dev

Boolean

See dev mode

--lintingStringency

['low' | 'medium' | 'high']

Default: 'high'

Modifies eslint settings. 'low' and 'medium' levels turn off several rules to allow leniency in coding style in beginner and intermediate modules. For details on settings see /settings/linting-levels.js

dev mode

DEV mode is automatically detected by checking where the repo was cloned from. Using the --dev option is only necessary to force dev mode in case your repo is not in the DigitalCareerInstitute org.

"scripts": {
   "preinstall": "npm_config_yes=true npx @dci-edtech/autograding-setup --no --dev"
}