questions about `sv` addon API
Open
Nobody has claimed this yet.
pkg:add
pkg:create
- Dominant language
- TypeScript
- Stars
- 506
- Forks
- 107
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 28
Description
1. dependsOn and runsAfter restricted to OfficialAddons
Are they supposed to support community addons or not yet.
2. Casing mismatch between OfficialAddons keys and addon.id
The contents of OfficialAddons is camelCase while the contents of addon.id is kebab-case. Should we align them. This matters cause they're both used explicitly.
3. runAfter is missing from documentation
setup: ({ dependsOn, unsupported, addOption, isKit }) => {
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 with the sv defineAddon documentation and trace the OfficialAddons, addon.id, dependsOn, and runsAfter API references. Confirm whether community addons and the casing mismatch are intentional, then document the agreed behavior and add the missing runsAfter entry to the defineAddon documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100