hooks.macro

Hooks’ Macro :umbrella:

Babel Macros for React Hooks automatic memoization invalidation.

Installation

Requires babel-plugin-macros, which is already configured for you if you are using Create React App v2+.

npm install --dev hooks.macro

yarn add --dev hooks.macro

Usage

Replace:

import { useMemo } from "react";

function MyComponent({ labels }) {
  const myComputation = useMemo(
    () => labels.map(label => label.toUpperCase()),
    [labels]
  );
}

With:

import { useAutoMemo } from "hooks.macro";

function MyComponent({ labels }) {
  const myComputation = useAutoMemo(() =>
    labels.map(label => label.toUpperCase())
  );
}

Or even:

import { useAutoMemo } from "hooks.macro";

function MyComponent({ labels }) {
  const myComputation = useAutoMemo(labels.map(label => label.toUpperCase()));
}

Full reference

useAutoMemo

Exactly like React’s useMemo but automatically identifies value dependencies.

Can be passed a factory function or directly a value, will convert the latter to a function for you.

import { useAutoMemo } from "hooks.macro";

useAutoMemo(value);
useAutoMemo(() => value);

Both become:

useMemo(() => value, [value]);

useAutoCallback

Exactly like React’s useMemo but automatically identifies value dependencies.

import { useAutoCallback } from "hooks.macro";

useAutoCallback(() => {
  doSomethingWith(value);
});

Becomes:

useCallback(
  () => {
    doSomethingWith(value);
  },
  [doSomethingWith, value]
);

Limitations

To make this work I currently needed to pose some limitations. This could change in the future (PR very welcome).

1. Only variables created in the scope of the component body are automatically trapped as value dependencies.

2. Only variables, and not properties’ access, are trapped. This means that if you use obj.prop only [obj] will become part of the memoization invalidation keys. This is a problem for refs, and will be addressed specifically in a future release.

3. Currently there’s no way to add additional keys for more fine grained cache invalidation. Could be an important escape hatch when you do nasty things, but in that case I’d prefer to use useMemo/useCallback directly.

License

MIT

Changelog

v0.1.2 (November 23, 2018)

• Avoid including twice the same reference (bbc403eef4a63156651e587f156935d1a06c41f0)
• Small performance improvements (bbc403eef4a63156651e587f156935d1a06c41f0)
• Stricter validation checks (bbc403eef4a63156651e587f156935d1a06c41f0)