slackapi / slackapi/node-slack-sdk
types 3.0: add type tests
Open
Nobody has claimed this yet.
area:typescript
enhancement
pkg:types
tests
- Dominant language
- TypeScript
- Stars
- 3.4k
- Forks
- 688
- Avg merge
- 15h 31m
- Merged PRs (30d)
- 27
Description
Using a package like tsd, we can write basic tests for the type interfaces. For more complex types this can be extremely useful, especially during refactoring, to ensure the end-user experience stays consistent / we don't regress on the developer experience that TS provides.
Contributor 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.
Research direction
Start by reviewing the TypeScript type interfaces and the repository's existing test setup, then investigate how a package such as tsd could fit. Add basic type tests for the interfaces, including more complex types where useful, and confirm that the tests protect the intended end-user experience during refactoring.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, testing-qa
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100