| name | code-linter |
| description | Checks a lab README for typos and grammar issues. Invoke when the user says "lint code" or "lint". |
Code linter
Check the lab README.md files for issues within the code blocks. Furthermore check other code files, eg yaml files, for issues within the code.
- If the user names a specific lab, check only that one. A bare numeric prefix in the arguments (e.g.
01, 12) counts as naming a lab — resolve it to the single top-level directory whose name begins with that prefix followed by _ (e.g. 01 → 01_install-kcp-locally/) and lint only the files under that directory. If no directory matches, or more than one matches, stop and ask the user which one they meant.
- Otherwise check every top-level
*/README.md (skip .99_todos/).
- Check on usage of file paths that only absolute paths are used, starting with
/training. Verify if the paths are correct.
- Report findings as
file_path:line_number with the fix suggestion.
- If you find any TODO make me aware of this.
- Ask before changing files if this should be done
Must not
- Do not read, open, or grep files under
.secrets/ — passwords, SSH keys, service-account JSON are off-limits.
- Do not read, open, or grep files under
.99_todos/
- Do not "fix" placeholders (
TODO, XXXXX, TODO-STUDENT-EMAIL@...) — they are intentional.
- Ignore grammar or typo issues within prose texts in md files.