Skip to content

Keycodes: improve tree shaking by annotating exports as pure #67615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 5, 2024
Merged

Keycodes: improve tree shaking by annotating exports as pure #67615

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 27 additions & 29 deletions packages/keycodes/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,9 +211,9 @@ export const modifiers = {
* @type {WPModifierHandler<WPKeyHandler<string>>} Keyed map of functions to raw
* shortcuts.
*/
export const rawShortcut = mapValues(
modifiers,
( /** @type {WPModifier} */ modifier ) => {
export const rawShortcut =
/* @__PURE__ */
Copy link
Contributor

@youknowriad youknowriad Dec 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this something supported by all bundlers?

Copy link
Member

@tyxla tyxla Dec 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if it's supported by all, but generally, most would support it, as it's declared in the spec:

https://github.com/javascript-compiler-hints/compiler-notations-spec/blob/main/pure-notation-spec.md

also see compatibility table:

https://github.com/javascript-compiler-hints/compiler-notations-spec/blob/main/pure-notation-compatibility.md

Copy link
Member Author

@jsnajdr jsnajdr Dec 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The webpack + Terser combo also supports it. Webpack adds the comment to code that is pure (typically re-exports) and then Terser uses the comment to eliminate the dead code.

mapValues( modifiers, ( /** @type {WPModifier} */ modifier ) => {
return /** @type {WPKeyHandler<string>} */ (
character,
_isApple = isAppleOS
Expand All @@ -222,8 +222,7 @@ export const rawShortcut = mapValues(
'+'
);
};
}
);
} );

/**
* Return an array of the parts of a keyboard shortcut chord for display.
Expand All @@ -238,9 +237,9 @@ export const rawShortcut = mapValues(
* @type {WPModifierHandler<WPKeyHandler<string[]>>} Keyed map of functions to
* shortcut sequences.
*/
export const displayShortcutList = mapValues(
modifiers,
( /** @type {WPModifier} */ modifier ) => {
export const displayShortcutList =
/* @__PURE__ */
mapValues( modifiers, ( /** @type {WPModifier} */ modifier ) => {
return /** @type {WPKeyHandler<string[]>} */ (
character,
_isApple = isAppleOS
Expand Down Expand Up @@ -268,8 +267,7 @@ export const displayShortcutList = mapValues(

return [ ...modifierKeys, capitaliseFirstCharacter( character ) ];
};
}
);
} );

/**
* An object that contains functions to display shortcuts.
Expand All @@ -284,15 +282,17 @@ export const displayShortcutList = mapValues(
* @type {WPModifierHandler<WPKeyHandler<string>>} Keyed map of functions to
* display shortcuts.
*/
export const displayShortcut = mapValues(
displayShortcutList,
( /** @type {WPKeyHandler<string[]>} */ shortcutList ) => {
return /** @type {WPKeyHandler<string>} */ (
character,
_isApple = isAppleOS
) => shortcutList( character, _isApple ).join( '' );
}
);
export const displayShortcut =
/* @__PURE__ */
mapValues(
displayShortcutList,
( /** @type {WPKeyHandler<string[]>} */ shortcutList ) => {
return /** @type {WPKeyHandler<string>} */ (
character,
_isApple = isAppleOS
) => shortcutList( character, _isApple ).join( '' );
}
);

/**
* An object that contains functions to return an aria label for a keyboard
Expand All @@ -308,9 +308,9 @@ export const displayShortcut = mapValues(
* @type {WPModifierHandler<WPKeyHandler<string>>} Keyed map of functions to
* shortcut ARIA labels.
*/
export const shortcutAriaLabel = mapValues(
modifiers,
( /** @type {WPModifier} */ modifier ) => {
export const shortcutAriaLabel =
/* @__PURE__ */
mapValues( modifiers, ( /** @type {WPModifier} */ modifier ) => {
return /** @type {WPKeyHandler<string>} */ (
character,
_isApple = isAppleOS
Expand Down Expand Up @@ -338,8 +338,7 @@ export const shortcutAriaLabel = mapValues(
)
.join( isApple ? ' ' : ' + ' );
};
}
);
} );

/**
* From a given KeyboardEvent, returns an array of active modifier constants for
Expand Down Expand Up @@ -379,9 +378,9 @@ function getEventModifiers( event ) {
* @type {WPModifierHandler<WPEventKeyHandler>} Keyed map of functions
* to match events.
*/
export const isKeyboardEvent = mapValues(
modifiers,
( /** @type {WPModifier} */ getModifiers ) => {
export const isKeyboardEvent =
/* @__PURE__ */
mapValues( modifiers, ( /** @type {WPModifier} */ getModifiers ) => {
return /** @type {WPEventKeyHandler} */ (
event,
character,
Expand Down Expand Up @@ -439,5 +438,4 @@ export const isKeyboardEvent = mapValues(

return key === character.toLowerCase();
};
}
);
} );
Loading