added linter for code block line length and gen_numbering#70
Conversation
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-70.surge.sh/robotframework-RFCP-syllabus/ |
There was a problem hiding this comment.
Pull request overview
This PR adds automated enforcement of code block line length limits and improves the chapter numbering generation script to support pre-commit workflows. The changes ensure that code examples in documentation remain properly formatted for PDF generation.
- Added a remark linter plugin that enforces a 100-character maximum line length for code blocks in documentation
- Enhanced
gen_numbering.pyto track and report file modifications with a non-zero exit code, enabling use as a pre-commit hook - Reformatted multiple documentation files to comply with the new 100-character line length limit
Reviewed changes
Copilot reviewed 18 out of 20 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| website/src/remark/remark-code-max-line-length.js | New remark plugin that validates code block line lengths and fails the build if lines exceed 100 characters |
| website/docusaurus.config.ts | Integrates the new code max line length plugin into the Docusaurus build pipeline |
| tools/gen_numbering.py | Refactored to use write_if_changed helper and return exit code based on number of modified files |
| tools/README.md | Empty README file created (likely unintended artifact) |
| tools/gen_pdf.robot | Changed browser to run in headless mode for automated PDF generation |
| website/docs/chapter-*/*.md | Multiple documentation files reformatted to comply with 100-character line length in code blocks |
| website/docs/learning_objectives.md | Auto-generated file updated with grammar fix ("an Initialization Files" → "Initialization Files") |
| README.md | Auto-generated table of contents updated with corrected headings and links |
| LOs.csv | Auto-generated learning objectives CSV updated with grammar fix |
| website/src/components/Quiz/quizComponents.ts | Auto-generated file with updated timestamp |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-70.surge.sh/robotframework-RFCP-syllabus/ |
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-70.surge.sh/robotframework-RFCP-syllabus/ |
… fail in case of a fix
Signed-off-by: René <snooz@posteo.de>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: René <snooz@posteo.de>
Signed-off-by: René <snooz@posteo.de>
Signed-off-by: René <snooz@posteo.de>
Signed-off-by: René <snooz@posteo.de>
Signed-off-by: René <snooz@posteo.de>
69e5bcc to
192e4f6
Compare
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-70.surge.sh/robotframework-RFCP-syllabus/ |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 20 out of 24 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-70.surge.sh/robotframework-RFCP-syllabus/ |
Improvements: