Figure out typings between deploy and lexicon
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 17
Description
Type interfaces describing spec and state are really messy right now
- deploy/type.ts describes v1 spec and provisioner state objects
- lexicon/lightning describes provisioner state
- lexicon/portability.d.ts describes v2 spec
- Also some complication around the v2 state yaml files
What we need is:
- as few type interfaces as possible. Maybe the deploy types can just alias out the provisioner namespace?
- A user and AI guide to explain how to make changes
I'd also love a common dependency between kit and lightning, to help keep both repos honest.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing deploy/type.ts, lexicon/lightning, and lexicon/portability.d.ts, then trace the v2 state YAML files and their consumers. Map the duplicated v1 and v2 spec/state interfaces and how kit and lightning currently exchange them. Done means a minimal agreed type structure, a user and AI change guide, and a defined common dependency between the repositories.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100