DSDL linter
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
Research direction
Start from the existing verify script linked in the issue, which lives in the public_regulated_data_types repository, and note which checks it already performs. The new tool must be a standalone Python script that depends only on PyDSDL, and its location has not been decided yet. Done means every listed requirement (formatting, pragmas, header comments, size limits, ASCII/tab/CR rules) is enforced with a non-zero exit code on violations.
Written by the indexing model from the issue text.
Description
We need to have this script transformed into a standalone reusable DSDL linter:
https://github.com/UAVCAN/public_regulated_data_types/blob/master/verify
Business requirements:
- Implemented as a standalone Python script dependent only on PyDSDL.
- Ensure that the formatting recommendations provided in the specification are followed.
- Support for definition-wide diagnostic suppression using pragmas.
- Ensure the header comment is provided for all data types. Allow the caller to specify which namespaces should be allowed to bypass this requirement.
- Allow the caller to specify the maximum size of serialized representations. Provide a pragma to override this.
- Ensure ASCII charset; prohibit tabs and
\r(carriage return). - Non-zero return code if a violation is found.
I am not sure where the script should be located; could be the PyDSDL repo or just a separate gist?
Original comment: https://github.com/UAVCAN/public_regulated_data_types/pull/67/files/acb48c15288510bffea3797d76e3eca21d6413dc#r322079388
- Dominant language
- Python
- Stars
- 81
- Forks
- 108
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from OpenCyphal/public_regulated_data_types
-
Difficulty 4/5 3-5 days Newbie friendliness 15/100
OpenCyphal/public_regulated_data_types#152 · 3 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 20/100
-
enhancement minor new-data-type
Difficulty 4/5 3-5 days Newbie friendliness 15/100
OpenCyphal/public_regulated_data_types#128 · 2 comments ·
-
help wanted minor
Difficulty 4/5 3-5 days Newbie friendliness 25/100
All issues in OpenCyphal/public_regulated_data_types
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
py-econometrics/pyfixest#2072 ·
Maintainers usually reply within 1 day
-
~planning docs
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
Kromatic-Innovation/athenaeum#3084 ·
Maintainers usually reply within 1 day
-
Bosch Room Thermostat II number entities offer -500 to 3000 °C setpoint limits and a -32768 to 32767 °C outdoor temperaturePossibly taken @zigpy-review-bot claimed this today. Openbot: code audit
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
zigpy/zha-device-handlers#5769 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 Half a day Newbie friendliness 80/100
R0Y00/Xbox2Windows#254 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kludex/python-multipart#375 ·
Maintainers usually reply within 1 day