Skip to content

ROHD linter #713

Description

@desmonddak

Motivation

It would be nice to have some of the best practices for ROHD code to be codified in a linter.
For example, we get in trouble exposing Logic from within a module, possibly transitively in grand-children.
Bad habits like not using getters or not using a protected annotation can lead to other connectivity problems.

Dart enforces a lot of good practices, but if we had a ROHD linter, we would have a place to add our own rules for good hardware generation practices.

Desired solution

The biggest help would be a static check for obvious hiearchical connection issues rather than waiting until elaboration.

Alternatives considered

We have a small fix for some basic hieararchy check to help the current runtime check more specifically localize connection problems, but it is still an elaboration time check and so only certain configurations will find the bug in the component (which is exposing a Logic not through a port. A static check would be far better.

Additional details

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions