Core Commands: Refactor to TypeScript by kushagra-goyal-14 · Pull Request #84385 · WordPress/gutenberg

kushagra-goyal-14 · 2026-10-09T13:53:34Z

What?

Converts @wordpress/core-commands source files and its search-ordering tests to TypeScript, and adds native type declarations.

Why?

Provide typed command palette settings, navigation commands, and search results, with declarations generated from the package source.

How?

Renames six source files and the existing test file to .ts/.tsx, preserving existing comments and traceable Git history.
Adds shared types for command palette settings, admin menu commands, and searchable entity records.
Keeps private router contracts and the existing window property declaration separate from public types.
Types command loader hooks and command configurations using @wordpress/commands.
Makes the search-ordering utility generic, preserving the input record type.
Adds separate build and development TypeScript configs, dependency references, declaration exports, and an optional @types/react peer.
Updates generated API documentation and the package changelog.
Adds coverage for empty searches, case-insensitive ordering, missing titles, nonmutation, and invalid JavaScript inputs.

No runtime changes. Existing hooks and navigation behavior are preserved.

Testing Instructions

Run npm run typecheck.
Run npm run test:unit -- packages/core-commands.
Run npm run build.
Run npm run check:type-declarations.
Run npm run lint:published-deps.
Start local WordPress with npm run wp-env -- start.
Open a saved post or page and open the Command Palette.
Search for posts/pages and run available admin navigation commands, including “Go to: Posts > All Posts” and “View site”.
In the Site Editor, search for templates/template parts and run available navigation commands.
Check the browser console for errors.

Testing Instructions for Keyboard

Open a saved post/page or the Site Editor.
Press Cmd+K on macOS or Ctrl+K on Windows/Linux.
Type a search, use arrow keys to select a result, and press Enter.
Reopen the palette and press Escape to close it.

Use of AI Tools

Codex assisted with the TypeScript migration, review feedback analysis, tests, and validation.

Add native declarations and project references while preserving runtime behavior and existing comments.

github-actions · 2026-10-09T13:53:46Z

🤖 PR meta 🤖

🎉 Props

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: kushagra-goyal-14 <kush123@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Updated as activity occurs, without notifying anyone named here. Add the props-bot label to refresh.

kushagra-goyal-14 · 2026-10-09T14:52:45Z

Hi @manzoorwanijk let me know if you have some recommendations or have some thoughts regarding this.

manzoorwanijk · 2026-10-13T08:24:30Z

+/**
+ * The router private APIs consumed by the command palette.
+ */
+export interface RouterPrivateApis {


This hand-written copy already drifts from the router: RouterProvider requires routes and matchResolverArgs, which index.tsx does not pass, so the mismatch is hidden rather than typed. core-data has a precedent: export type CoreDataPrivateApis = typeof lockedApis. Exporting a RouterPrivateApis type the same way from @wordpress/router (and making routes/matchResolverArgs optional there, since both are already handled when absent) would let this file drop the copy.

manzoorwanijk · 2026-10-13T08:24:30Z

+ * The router private APIs consumed by the command palette.
+ */
+export interface RouterPrivateApis {
+	RouterProvider: React.ComponentType< {


React.ComponentType/React.ReactNode resolve through the UMD global with no import, so lint:published-deps cannot see the dependency that the new @types/react peer is for. Prefer import type { ComponentType, ReactNode } from 'react';, like @wordpress/commands. If the router type suggestion above lands, this file (and possibly the peer) goes away.

manzoorwanijk · 2026-10-13T08:24:30Z

+		const commands = useMemo< CommandConfig[] >( () => {
 			if (
 				! canCreateTemplate ||
+				// @ts-expect-error Preserve the existing boolean/string comparison during migration.


! templateType === 'wp_template_part' is always false, so this classic-theme guard never applies. Keeping the behavior is right for this PR, but could you open a follow-up issue (likely intent: templateType !== 'wp_template_part') and reference it in this comment so the @ts-expect-error does not become permanent?

manzoorwanijk · 2026-10-13T08:24:30Z

 import { useAdminNavigationCommands } from './admin-navigation-commands';
 import { useSiteEditorNavigationCommands } from './site-editor-navigation-commands';
 import { unlock } from './lock-unlock';
+import type { CommandPaletteSettings } from './types';


CommandPaletteSettings is now the public parameter type of initializeCommandPalette, but consumers cannot import it. Consider export type { AdminMenuCommand, CommandPaletteSettings } from './types';.

manzoorwanijk · 2026-10-13T08:24:30Z

+/**
+ * The title fields used to prioritize entity search results.
+ */
+export interface SearchableEntityRecord {


SearchableEntityRecord is only the internal constraint for orderEntityRecordsBySearch; it fits better in private-types.ts (or next to the util) than in the public types file.

manzoorwanijk · 2026-10-13T08:24:30Z

-			return ( records ?? [] ).map( ( record ) => {
-				const command = {
+		const commands = useMemo< CommandConfig[] >( () => {
+			return ( records ?? [] ).map< CommandConfig >( ( record ) => {


Nit: the template loader types its records with getEntityRecords< WpTemplate | WpTemplatePart >, but this loader's getEntityRecords call (line 125) is untyped. getEntityRecords< Post | Page > from @wordpress/core-data would keep them consistent.

manzoorwanijk · 2026-10-13T08:28:30Z

+		// @ts-expect-error JavaScript callers can pass values outside the typed contract.
+		expect( orderEntityRecordsBySearch( {} ) ).toEqual( [] );


Let us narrow this suppression down to the point where it applies. See my blog post about it - https://manzoorwani.dev/youre-probably-using-ts-expect-error-wrong/

kushagra-goyal-14 added 3 commits October 9, 2026 17:46

refactor(core-commands): migrate to TypeScript

66904a3

Add native declarations and project references while preserving runtime behavior and existing comments.

test(core-commands): cover typed search ordering

99e0e89

docs(core-commands): note native TypeScript support

640938d

github-actions Bot added the [Package] Core commands /packages/core-commands label Oct 9, 2026

kushagra-goyal-14 and others added 2 commits October 9, 2026 19:23

Merge branch 'trunk' into typescript/core-commands

a4bd6f9

fix(core-commands): resolve migration CI checks

530852a

kushagra-goyal-14 marked this pull request as ready for review October 9, 2026 15:03

manzoorwanijk added the [Type] Code Quality Issues or PRs that relate to code quality label Oct 13, 2026

manzoorwanijk reviewed Oct 13, 2026

View reviewed changes

manzoorwanijk mentioned this pull request Oct 13, 2026

Convert packages to TypeScript #67691

Open

Navigation Menu

Repository navigation

Core Commands: Refactor to TypeScript - #84385

Core Commands: Refactor to TypeScript#84385
kushagra-goyal-14 wants to merge 5 commits into
WordPress:trunkfrom
kushagra-goyal-14:typescript/core-commands

kushagra-goyal-14 commented Oct 9, 2026

Uh oh!

github-actions Bot commented Oct 9, 2026 •

edited

Loading

Uh oh!

kushagra-goyal-14 commented Oct 9, 2026

Uh oh!

manzoorwanijk Oct 13, 2026

Uh oh!

manzoorwanijk Oct 13, 2026

Uh oh!

manzoorwanijk Oct 13, 2026

Uh oh!

manzoorwanijk Oct 13, 2026

Uh oh!

manzoorwanijk Oct 13, 2026

Uh oh!

manzoorwanijk Oct 13, 2026

Uh oh!

manzoorwanijk Oct 13, 2026

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		// @ts-expect-error JavaScript callers can pass values outside the typed contract.
		expect( orderEntityRecordsBySearch( {} ) ).toEqual( [] );

Conversation

kushagra-goyal-14 commented Oct 9, 2026

What?

Why?

How?

Testing Instructions

Testing Instructions for Keyboard

Use of AI Tools

Uh oh!

github-actions Bot commented Oct 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤖 PR meta 🤖

🎉 Props

Uh oh!

kushagra-goyal-14 commented Oct 9, 2026

Uh oh!

manzoorwanijk Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

manzoorwanijk Oct 13, 2026

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Oct 9, 2026 •

edited

Loading