cli icon indicating copy to clipboard operation
cli copied to clipboard

Add command to "lint" Dapr component files

Open ItalyPaleAle opened this issue 2 years ago • 2 comments

Describe the proposal

This proposal came from a conversation on Discord. A user had issues with a Dapr component, and it turned out that they had misspelled a metadata key. This is not the first time that we see (on Discord and whatnot) users having problems due to typos or using a different case. Right now, the experience in Dapr is sub-par, as users often get no direct feedback that the metadata is invalid.

Thanks to the work started in dapr/components-contrib#2077, we are building a comprehensive metadata document in components-contrib for all components.

We should be able to use the same metadata in the Dapr CLI also to offer a "linter", which can be used locally (before components are deployed) and scans components files, validating that the metadata keys used are correct

Release Note

RELEASE NOTE: ADD New "dapr lint" command to lint component files

ItalyPaleAle avatar Sep 30 '22 15:09 ItalyPaleAle

@ItalyPaleAle are you working on this feature?

mukundansundar avatar Sep 15 '23 03:09 mukundansundar

@ItalyPaleAle are you working on this feature?

Currently not on my backlog. I think this is still a good idea, especially as we add metadata.yaml's for more components, but I don't have it on my radar for now.

ItalyPaleAle avatar Sep 15 '23 04:09 ItalyPaleAle