to install it with npm. Or you can choose another package manager.
Features
1. Lifecycle Events (What)
Simply insert the useTilg() hook into the component, and it will log the render, mount, unmount events in the console:
import useTilg from 'tilg'function MyButton() { useTilg() return <button>Click me</button>}
Logs of render and mount events.
2. Component Name and Props (Who)
You might noticed that it also displays the name and props of the component, which is very helpful for debugging.
import useTilg from 'tilg'function MyButton({ text }) { useTilg() return <button>{text}</button>}function Title({ children }) { useTilg() return <h1>{children}</h1>}export default function Page() { return ( <> <Title>Welcome!</Title> <MyButton text='foo' /> <MyButton text='bar' /> </> )}
When there’re multiple elements of the same component being rendered, it adds a counter <MyButton/> (2) for distinguishing so you know who is logging the information:
Information of the logged components.
3. Debug Message (Why)
Another critical thing is to know why does a component re-renders. useTilg gives you a simple but powerful API for this:
When appending a template literal to the useTilg() call, it will also be displayed as the debug message:
useTilg()`count = ${count}`
Logs of “count = ?”.
You can know where the message is from, too:
Trace of the message and a link to the code location.
4. What Has Changed? (Why)
Something troubles me a lot when debugging a component is, it’s sometimes hard to know which state has changed and triggered a re-render. useTilg tracks all the arguments in the debug message and tells you which one has changed since the previous render:
The useTilg() hook also returns its first argument, or the first value in the template if specified, so you can quickly debug something in-place by wrapping it with useTilg():
Is it safe to ship code with useTilg to production?
Although useTilg() does nothing in a production build (process.env.NODE_ENV === 'production') but only an empty function, I encourge you to remove the hook from the source code after finishing development your component.
How do you implement this hook? What can I learn from the code?
It is very hacky. Don't rely on it or try it in production, or you will be fired.
Why not design the API as useTilg`message`?
Then it will not be identified as a hook, React Refresh and HMR will not work correctly.