dapr / dapr/cli

Add command to "lint" Dapr component files

Open
#1,074 2 comments 5 reactions 1 assignee Claimed by @ItalyPaleAle View on GitHub
kind/enhancement kind/proposal P1 size/S triaged/resolved
Dominant language
Go
Stars
353
Forks
221
Avg merge
3d 8h
Merged PRs (30d)
2

Description

## 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.