Skip to content

Commit

Permalink
Rename new options to save bytes. (#1318)
Browse files Browse the repository at this point in the history
  • Loading branch information
developit authored and marvinhagemeister committed Mar 4, 2019
1 parent db040ac commit 29c92e5
Show file tree
Hide file tree
Showing 11 changed files with 58 additions and 58 deletions.
4 changes: 2 additions & 2 deletions debug/src/debug.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ import { options, toChildArray } from 'preact';

export function initDebug() {
/* eslint-disable no-console */
let oldBeforeDiff = options.beforeDiff;
let oldBeforeDiff = options.diff;

options.beforeDiff = vnode => {
options.diff = vnode => {
let { type, props } = vnode;
let children = props && props.children;

Expand Down
18 changes: 9 additions & 9 deletions debug/src/devtools/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,10 @@ export function initDevTools() {

// Store (possible) previous hooks so that we don't overwrite them
let prevVNodeHook = options.vnode;
let prevCommitRoot = options.commitRoot;
let prevBeforeUnmount = options.beforeUnmount;
let prevBeforeDiff = options.beforeDiff;
let prevAfterDiff = options.afterDiff;
let prevCommitRoot = options.commit;
let prevBeforeUnmount = options.unmount;
let prevBeforeDiff = options.diff;
let prevAfterDiff = options.diffed;

options.vnode = (vnode) => {
// Tiny performance improvement by initializing fields as doubles
Expand All @@ -128,26 +128,26 @@ export function initDevTools() {
if (prevVNodeHook) prevVNodeHook(vnode);
};

options.beforeDiff = (vnode) => {
options.diff = (vnode) => {
vnode.startTime = now();
if (prevBeforeDiff!=null) prevBeforeDiff(vnode);
};

options.afterDiff = (vnode) => {
options.diffed = (vnode) => {
vnode.endTime = now();
if (prevAfterDiff!=null) prevAfterDiff(vnode);
};

options.commitRoot = catchErrors((vnode) => {
options.commit = catchErrors((vnode) => {
// Call previously defined hook
if (prevCommitRoot!=null) prevCommitRoot(vnode);

// These cases are already handled by `beforeUnmount`
// These cases are already handled by `unmount`
if (vnode==null) return;
onCommitRoot(vnode);
});

options.beforeUnmount = catchErrors((vnode) => {
options.unmount = catchErrors((vnode) => {
// Call previously defined hook
if (prevBeforeUnmount!=null) prevBeforeUnmount(vnode);
onCommitUnmount(vnode);
Expand Down
2 changes: 1 addition & 1 deletion debug/src/devtools/renderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ export class Renderer {

/**
* Unmount a vnode recursively. Contrary to mounting or updating unmounting needs
* to push the events in parent-first order. Because `options.beforeUnmount` is
* to push the events in parent-first order. Because `options.unmount` is
* already fired in parent-first order we don't need to traverse anything here.
* @param {import('../internal').VNode} vnode
*/
Expand Down
8 changes: 4 additions & 4 deletions debug/test/browser/debug.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,16 @@ describe('debug', () => {
let scratch;
let errors = [];

let beforeDiffSpy;
let diffSpy;

beforeEach(() => {
errors = [];
scratch = setupScratch();
sinon.stub(console, 'error').callsFake(e => errors.push(e));

clearOptions();
beforeDiffSpy = sinon.spy();
options.beforeDiff = beforeDiffSpy;
diffSpy = sinon.spy();
options.diff = diffSpy;

initDebug();
});
Expand All @@ -32,7 +32,7 @@ describe('debug', () => {

it('should call previous options', () => {
render(<div />, scratch);
expect(beforeDiffSpy, 'beforeDiff').to.have.been.called;
expect(diffSpy, 'diff').to.have.been.called;
});

it('should print an error on undefined component', () => {
Expand Down
32 changes: 16 additions & 16 deletions debug/test/browser/devtools.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -418,13 +418,13 @@ describe('devtools', () => {
});

it('should not initialize hook if __REACT_DEVTOOLS_GLOBAL_HOOK__ is not set', () => {
delete options.beforeDiff;
delete options.afterDiff;
delete options.diff;
delete options.diffed;
delete /** @type {*} */ (window).__REACT_DEVTOOLS_GLOBAL_HOOK__;

initDevTools();
expect(options.beforeDiff).to.equal(undefined);
expect(options.afterDiff).to.equal(undefined);
expect(options.diff).to.equal(undefined);
expect(options.diffed).to.equal(undefined);
});

it('should not throw if the root is null', () => {
Expand All @@ -433,29 +433,29 @@ describe('devtools', () => {

it('should not overwrite existing options', () => {
let vnodeSpy = sinon.spy();
let beforeDiffSpy = sinon.spy();
let afterDiffSpy = sinon.spy();
let commitRootSpy = sinon.spy();
let beforeUnmountSpy = sinon.spy();
let diffSpy = sinon.spy();
let diffedSpy = sinon.spy();
let commitSpy = sinon.spy();
let unmountSpy = sinon.spy();

options.vnode = vnodeSpy;
options.beforeDiff = beforeDiffSpy;
options.afterDiff = afterDiffSpy;
options.commitRoot = commitRootSpy;
options.beforeUnmount = beforeUnmountSpy;
options.diff = diffSpy;
options.diffed = diffedSpy;
options.commit = commitSpy;
options.unmount = unmountSpy;

initDevTools();

render(<div />, scratch);

expect(vnodeSpy, 'vnode').to.have.been.called;
expect(beforeDiffSpy, 'beforeDiff').to.have.been.calledOnce;
expect(afterDiffSpy, 'afterDiff').to.have.been.calledOnce;
expect(commitRootSpy, 'commitRoot').to.have.been.calledOnce;
expect(diffSpy, 'diff').to.have.been.calledOnce;
expect(diffedSpy, 'diffed').to.have.been.calledOnce;
expect(commitSpy, 'commit').to.have.been.calledOnce;

render(null, scratch);

expect(beforeUnmountSpy, 'beforeUnmount').to.have.been.calledOnce;
expect(unmountSpy, 'unmount').to.have.been.calledOnce;
});

it('should connect only once', () => {
Expand Down
8 changes: 4 additions & 4 deletions demo/profiler.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,13 @@ export default class ProfilerDemo extends Component {
}

componentDidMount() {
options.beforeDiff = vnode => vnode.startTime = performance.now();
options.afterDiff = vnode => vnode.endTime = performance.now();
options.diff = vnode => vnode.startTime = performance.now();
options.diffed = vnode => vnode.endTime = performance.now();
}

componentWillUnmount() {
delete options.beforeDiff;
delete options.afterDiff;
delete options.diff;
delete options.diffed;
}

onClick() {
Expand Down
14 changes: 7 additions & 7 deletions hooks/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ let currentComponent;
/** @type {Array<import('./internal').Component>} */
let afterPaintEffects = [];

let oldBeforeRender = options.beforeRender;
options.beforeRender = vnode => {
let oldBeforeRender = options.render;
options.render = vnode => {
if (oldBeforeRender) oldBeforeRender(vnode);

currentComponent = vnode._component;
Expand All @@ -22,8 +22,8 @@ options.beforeRender = vnode => {
};


let oldAfterDiff = options.afterDiff;
options.afterDiff = vnode => {
let oldAfterDiff = options.diffed;
options.diffed = vnode => {
if (oldAfterDiff) oldAfterDiff(vnode);

const c = vnode._component;
Expand All @@ -33,14 +33,14 @@ options.afterDiff = vnode => {
if (!hooks) return;

// TODO: Consider moving to a global queue. May need to move
// this to the `commitRoot` option
// this to the `commit` option
hooks._pendingLayoutEffects.forEach(invokeEffect);
hooks._pendingLayoutEffects = [];
};


let oldBeforeUnmount = options.beforeUnmount;
options.beforeUnmount = vnode => {
let oldBeforeUnmount = options.unmount;
options.unmount = vnode => {
if (oldBeforeUnmount) oldBeforeUnmount(vnode);

const c = vnode._component;
Expand Down
10 changes: 5 additions & 5 deletions src/diff/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export function diff(dom, parentDom, newVNode, oldVNode, context, isSvg, excessD
oldVNode = EMPTY_OBJ;
}

if (options.beforeDiff) options.beforeDiff(newVNode);
if (options.diff) options.diff(newVNode);

let c, p, isNew = false, oldProps, oldState, oldContext,
newType = newVNode.type;
Expand Down Expand Up @@ -120,7 +120,7 @@ export function diff(dom, parentDom, newVNode, oldVNode, context, isSvg, excessD
c.props = newVNode.props;
c.state = s;

if (options.beforeRender) options.beforeRender(newVNode);
if (options.render) options.render(newVNode);

let prev = c._prevVNode;
let vnode = c._prevVNode = coerceToVNode(c.render(c.props, c.state, c.context));
Expand Down Expand Up @@ -171,7 +171,7 @@ export function diff(dom, parentDom, newVNode, oldVNode, context, isSvg, excessD
c._processingException = null;
}

if (options.afterDiff) options.afterDiff(newVNode);
if (options.diffed) options.diffed(newVNode);
}
catch (e) {
catchErrorInComponent(e, ancestorComponent);
Expand All @@ -191,7 +191,7 @@ export function commitRoot(mounts, root) {
}
}

if (options.commitRoot) options.commitRoot(root);
if (options.commit) options.commit(root);
}

/**
Expand Down Expand Up @@ -286,7 +286,7 @@ export function applyRef(ref, value, ancestorComponent) {
*/
export function unmount(vnode, ancestorComponent) {
let r;
if (options.beforeUnmount) options.beforeUnmount(vnode);
if (options.unmount) options.unmount(vnode);

if (r = vnode.ref) {
applyRef(r, null, ancestorComponent);
Expand Down
10 changes: 5 additions & 5 deletions src/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -164,15 +164,15 @@ declare namespace preact {
/** Attach a hook that is invoked whenever a VNode is created */
vnode(vnode: VNode): void;
/** Attach a hook that is invoked after a tree was mounted or was updated. */
commitRoot?(vnode: VNode): void;
commit?(vnode: VNode): void;
/** Attach a hook that is invoked immediately before a component is unmounted. */
beforeUnmount?(vnode: VNode): void;
unmount?(vnode: VNode): void;
/** Attach a hook that is invoked before a vnode is diffed */
beforeDiff?(vnode: VNode): void;
diff?(vnode: VNode): void;
/** Attach a hook that is invoked before a vnode has rendered */
beforeRender?(vnode: VNode): void;
render?(vnode: VNode): void;
/** Attach a hook that is invoked after a vnode has rendered */
afterDiff?(vnode: VNode): void;
diffed?(vnode: VNode): void;
event?(e: Event): void;
}

Expand Down
8 changes: 4 additions & 4 deletions test/_util/helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ let oldOptions = null;
export function clearOptions() {
oldOptions = assign({}, options);
delete options.vnode;
delete options.beforeDiff;
delete options.afterDiff;
delete options.commitRoot;
delete options.beforeUnmount;
delete options.diff;
delete options.diffed;
delete options.commit;
delete options.unmount;
}

/**
Expand Down
2 changes: 1 addition & 1 deletion test/fixtures/preact.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 29c92e5

Please sign in to comment.