shipshapecode / shipshapecode/vue-shepherd
Faulty typings
Nobody has claimed this yet.
- Dominant language
- Vue
- Stars
- 340
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Description
The TypeScript typings appear to be flawed for this library. The useShepherd composable function accepts the following arguments:
This doesn't align with what is shown in this repo's description where, for example, { useModalOverlay: true } is being passed as an argument. I do not get any type suggestions for these configuration properties.
Besides that, the Tour object that is returned by this function seems to be incomplete. I do not get any type hints about what functions are available. addStep and start are both typed as any.
The shown code does render a step, so the library is definitely working. It just doesn't provide any useful type hints.
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 locating the TypeScript declarations for the useShepherd composable and its returned Tour object, then compare them with the usage shown in the issue and repository description. Done means configuration properties such as useModalOverlay and Tour methods such as addStep and start provide useful type suggestions instead of any; add or update type coverage as appropriate and verify the shown usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100