DSDL linter

Open
#68 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
devtools

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

enhancement help wanted minor

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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenCyphal/public_regulated_data_types

All issues in OpenCyphal/public_regulated_data_types

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.