hexlet-exercise-kit

This is a complete kit for teachers who want to create exercises on the Hexlet platform.

Requirements

• Docker
• Node.js
• Make
• Ubuntu, macOS or WSL (for Windows)
• yq

Setup

git clone [email protected]:Hexlet/hexlet-exercise-kit.git

cd hexlet-exercise-kit
make setup

If you have access to clone Hexlet repositories:

• create a personal access token on this page: https://gitlab.hexlet.io/-/profile/personal_access_tokens
• add created token to .env file

GHORG_GITLAB_TOKEN=<token>

# Adjust this value for faster or slower speed of repositories download
PARALLEL=4

make clone

# if your .ssh catalog has specific path:
make clone SSH_KEYS_PATH=/specific/path/to/your/.ssh

For pulling into cloned repos:

make clone # clone all content
make clone-projects # clone all projects
make clone LOCALE=ru # clone all in ru locale
make clone-projects LOCALE=ru # clone projects on in ru locale hexlethq/projects/ru/

Using hexlet linters

# install/update all hexlet linters
make update-hexlet-linters
# install/update one hexlet linter. For example, eslint
make update-hexlet-linter L=eslint

Run exercise

cd <path/to/exercise/catalog>
make build # build exercise container
make start # run exercise and listen port 80
make test # run tests
make lint-js # run linter
make lint-hexlet-js # check exercise with linter, as in production

For frontend exercise after make start open http://localhost:80 in your browser.

make stop # stopped container

Copy a course from Code-Basics to Hexlet

make copy-from-cb I=path-to-source O=path-to-destination

Run markdown linter

Add Makefile in the course directory:

include ../../../course.mk

and run:

make markdown-lint # view error list
make markdown-lint-fix # fix errors

Check for code blocks:

make lint

Check and fix for code blocks:

make lint-fix

New stuff

mkdir -p exercises/ru/course-<name>/<lesson-name>_exercise

Run LanguageTool

• Install LanguageTool for your code editor. For example VS Code LanguageTool Linter
• Set URL of your LanguageTool server. Defaults to localhost on port 8081
• Run LanguageTool server make start-languagetool
• Stop LanguageTool server make stop-languagetool

Troubleshooting

Unable to find image 'hexlet/gitlab-downloader:latest' locally
docker: Error response from daemon: pull access denied for hexlet/gitlab-downloader, repository does not exist or may require 'docker login': denied: requested access to the resource is denied.
See 'docker run --help'.

Build downloader make build-downloader or see setup or fresh installation

---

The hint below is for linux users only.

If you encounter a “Permision denied” error after the make bash command or during exercise testing, it means that the volume with the exercise on the host and the container user have different UID. To solve the problem, you can create a new user on your system with the UID tirion (currently UID is 1001, but may change in the future). Then use the setfacl (read more about ACL) to share permissions on the files

sudo useradd -u 1001 -m <new-username>
sudo setfacl -R -m u:<new-username>:rwX /path/to/exercise-kit

And how to remove permissions

sudo setfacl -R -x u:<new-username> /path/to/exercise-kit