fix(templates): type-check event functions in a new project
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- bun, typescript
- Domain
- build-system, testing
Research direction
Read the template tsconfig files and packages/create-relkit/src/create-capabilities.ts; compare them with scripts/railway-newcomer/project.ts and the commit “re-pin the minimal template digest” for the expected pattern. Add the event registry to the appropriate template files list and update the pinned digest, or confirm the issue’s alternative approach. Done when a project created from the template with an event function passes bun run typecheck.
Written by the indexing model from the issue text.
Description
The templates' tsconfig.json lists .relkit/generated/route-module-checks.ts and
.relkit/generated/context-registry.d.ts under files, but not
.relkit/generated/event-registry.d.ts. In a project that defines an event function,
tsc --noEmit fails until you add the file by hand (the Railway newcomer test does this in
scripts/railway-newcomer/project.ts).
What to do
- Add the event registry to the
fileslist of the templates that can define events, or document why
relkit add eventsshould add it instead. - Template files are pinned by digest: re-pin it in
packages/create-relkit/src/create-capabilities.ts
(see the commit "re-pin the minimal template digest" for the pattern).
Done when a project created from the template and given an event function passes bun run typecheck.
- Dominant language
- TypeScript
- Stars
- 1
- Forks
- 0
- Avg merge
- 2h 45m
- Merged PRs (30d)
- 64
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
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.
More from rel-kit/relkit
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
bug good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 87/100
Maintainers usually reply within 1 day
-
documentation good first issue
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
binding:python bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
coollabsio/orbit#72 ·
Maintainers usually reply within 1 day
-
Bug
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
Maintainers usually reply within 1 day
-
bug needs-triage potential-regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
aws/aws-sdk-js-v3#8408 ·
Maintainers usually reply within 1 day