snabbdom/snabbdom

Hook signature of create

Open

#275 opened on Apr 18, 2017

View on GitHub
 (2 comments) (3 reactions) (0 assignees)TypeScript (1,118 forks)batch import
affects:usergood first issuetype:enhancement

Repository metrics

Stars
 (11,106 stars)
PR merge metrics
 (Avg merge 59d 3h) (2 merged PRs in 30d)

Description

Would you be in favor of simplifying the hook signature of create ? It takes an arbitrary emptyVnode as a first argument.

The fact that the logic is reused in the core modules for the create and update phases should not bother users everytime they want to do something in a create hook. I use this hook a lot and it's so annoying.

It would just be a matter of creating a wrapping function in the modules.

If you all agree, I'm happy to create a PR when I have some time.

Contributor guide

Research direction
Examine the current create hook signature in the Snabbdom source code (likely in snabbdom.ts or hooks.ts). Understand how the emptyVnode parameter is used in core modules. Propose a wrapper function inside the modules to hide the emptyVnode from users, while preserving internal reuse. Test the new signature with existing modules.
Tech stack
typescript
Domain
frontend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScriptTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70