crossplane / crossplane/crossplane-tools

Add type checks to generated methods

Open
#2 2 comments 1 reaction 0 assignees View on GitHub
enhancement wontfix
Dominant language
Go
Stars
37
Forks
38
PR merge metrics
No merged PRs in 30d

Description

### What problem are you facing?

Before generation was used for claim / class / managed resource methods, we made sure that methods were implemented such that each struct satisfied its desired interface. For example:

```go
var _ resource.Claim = &RedisCluster{}
```

### How could Crossplane help solve your problem?

Though these type checks are less important now that the methods are generated, they are helpful for someone who is trying to understand how these types are used in `crossplane-runtime`. It would be useful to generate these type checks alongside the methods.

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the generator that emits claim, class, and managed resource methods, then review how its generated output is structured. Add generated interface type checks alongside those methods and verify that the generated types satisfy their intended crossplane-runtime interfaces.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.