Skip to content

Conversation

@matteodepalo
Copy link
Contributor

Ink had two major version bumps, v5 and v6. v6 requires React 19+ but we are tied to react 18+ because of Polaris.
This PR updates ink to version 5. This introduced only a minor issue with spacing for certain characters which I fixed.

@matteodepalo matteodepalo requested a review from a team as a code owner January 5, 2026 11:57
@github-actions

This comment has been minimized.

@matteodepalo matteodepalo requested a review from a team as a code owner January 5, 2026 12:59
@github-actions
Copy link
Contributor

github-actions bot commented Jan 5, 2026

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements
79.43% (+0.2% 🔼)
14224/17908
🟡 Branches
73.63% (+0.52% 🔼)
6985/9487
🟡 Functions
79.57% (+0.2% 🔼)
3645/4581
🟡 Lines
79.79% (+0.21% 🔼)
13450/16856
Show new covered files 🐣
St.
File Statements Branches Functions Lines
🟢
... / admin-as-app.ts
100% 100% 100% 100%
🟢
... / metafield_definitions.ts
100% 100% 100% 100%
🟢
... / metaobject_definitions.ts
100% 100% 100% 100%
🟢
... / bulk-operation-cancel.ts
100% 100% 100% 100%
🟢
... / bulk-operation-run-mutation.ts
100% 100% 100% 100%
🟢
... / bulk-operation-run-query.ts
100% 100% 100% 100%
🟢
... / get-bulk-operation-by-id.ts
100% 100% 100% 100%
🟢
... / list-bulk-operations.ts
100% 100% 100% 100%
🟢
... / staged-uploads-create.ts
100% 100% 100% 100%
🔴
... / import-custom-data-definitions.ts
0% 100% 0% 0%
🔴
... / cancel.ts
0% 100% 0% 0%
🔴
... / execute.ts
0% 0% 0% 0%
🔴
... / status.ts
0% 0% 0% 0%
🔴
... / pull.ts
0% 100% 0% 0%
🟡
... / execute-operation.ts
73.53% 50% 100% 73.53%
🔴
... / pull.ts
0% 0% 0% 0%
🟢
... / bulk-operation-status.ts
96.55% 92.11% 100% 100%
🟢
... / cancel-bulk-operation.ts
100% 100% 100% 100%
🟢
... / constants.ts
100% 100% 100% 100%
🟢
... / download-bulk-operation-results.ts
100% 100% 100% 100%
🟢
... / execute-bulk-operation.ts
92.42% 86.67% 100% 93.75%
🟢
... / format-bulk-operation-status.ts
100% 100% 100% 100%
🟢
... / run-mutation.ts
100% 100% 100% 100%
🟢
... / run-query.ts
100% 100% 100% 100%
🟡
... / stage-file.ts
73.53% 62.5% 85.71% 72.73%
🟢
... / watch-bulk-operation.ts
100% 94.74% 100% 100%
🟢
... / declarative-definitions.ts
98.54% 93.18% 100% 98.51%
🟢
... / common.ts
97.22% 93.75% 100% 96.55%
🟢
... / execute-command-helpers.ts
100% 100% 100% 100%
🔴
... / promiseWithResolvers.ts
33.33% 50% 50% 33.33%
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🔴
... / execute.ts
0%
0% (-100% 🔻)
0% 0%
🟢
... / extension-instance.ts
84.8% (+0.23% 🔼)
77.6% (-0.91% 🔻)
92.06% (+0.13% 🔼)
85.11% (+0.24% 🔼)
🟡
... / specification.ts
69.09%
75.61% (+2.44% 🔼)
76.47% (-1.31% 🔻)
68.75%
🟢
... / ui_extension.ts
85.38% (-9.44% 🔻)
72.34% (-8.91% 🔻)
84% (-16% 🔻)
88% (-8.46% 🔻)
🟢
... / Logs.tsx
90%
90.91% (-5.97% 🔻)
100% 90%
🟢
... / app-event-watcher-handler.ts
86.36% (-4.11% 🔻)
75% 86.67%
85.71% (-5.19% 🔻)
🟢
... / bundle.ts
93.22%
63.33% (-3.33% 🔻)
94.12% (+5.88% 🔼)
96.3%
🟢
... / developer-platform-client.ts
84.62% (-1.5% 🔻)
71.43% (+0.84% 🔼)
81.82% (+1.82% 🔼)
93.75% (+0.42% 🔼)
🔴
... / http-reverse-proxy.ts
58.97% (-4.91% 🔻)
37.04% (-2.96% 🔻)
58.33% (-5.3% 🔻)
59.46% (-5.25% 🔻)
🟢
... / api.ts
87.07% (-0.43% 🔻)
76.71% (-0.1% 🔻)
100%
86.49% (-0.43% 🔻)
🟢
... / SingleTask.tsx
84.21% (-15.79% 🔻)
50% (-50% 🔻)
80% (-20% 🔻)
84.21% (-15.79% 🔻)
🔴
... / environment.ts
35% (-5% 🔻)
41.18%
40% (-10% 🔻)
36.84% (-5.26% 🔻)
🔴
... / ui.tsx
50.82% (-0.79% 🔻)
42.86% (-5.53% 🔻)
54.55% (+1.42% 🔼)
50% (-0.82% 🔻)
🟢
... / console.ts
81.82% (+15.15% 🔼)
75% (-25% 🔻)
100% (+33.33% 🔼)
81.82% (+15.15% 🔼)
🟢
... / init.ts
88% (-0.89% 🔻)
71.43% (+4.76% 🔼)
86.67% (+4.85% 🔼)
88% (-0.89% 🔻)
🟢
... / storefront-renderer.ts
90.2% (-0.54% 🔻)
78.95%
81.82% (-1.52% 🔻)
90.2% (-0.54% 🔻)
🟡
... / theme-polling.ts
67.12% (-0.93% 🔻)
68.75% 78.57%
66.67% (-0.98% 🔻)

Test suite run success

3586 tests passing in 1420 suites.

Report generated by 🧪jest coverage report action from 64d4c58

Copy link
Contributor

@craigmichaelmartin craigmichaelmartin left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks for taking this on!


function getStoreFqdnForRegEx(ctx: DevServerContext) {
return ctx.session.storeFqdn.replaceAll('.', '\\.')
return ctx.session.storeFqdn.replace(/\./g, '\\.')
Copy link
Contributor

Choose a reason for hiding this comment

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

🎩 'd and didn't run into any issues. I'm not sure if there are edge cases that would cause a problem here when the old code was essentially doing the same.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

Differences in type declarations

We detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/private/node/ui/components/Banner.d.ts
@@ -1,7 +1,8 @@
-import { FunctionComponent } from 'react';
+import React, { FunctionComponent } from 'react';
 export type BannerType = 'success' | 'error' | 'warning' | 'info' | 'external_error';
 interface BannerProps {
     type: BannerType;
+    children?: React.ReactNode;
 }
 declare const Banner: FunctionComponent<BannerProps>;
 export { Banner };
\ No newline at end of file
packages/cli-kit/dist/private/node/ui/components/LoadingBar.d.ts
@@ -4,5 +4,5 @@ interface LoadingBarProps {
     noColor?: boolean;
     noProgressBar?: boolean;
 }
-declare const LoadingBar: ({ title, noColor, noProgressBar }: React.PropsWithChildren<LoadingBarProps>) => JSX.Element;
+declare const LoadingBar: ({ title, noColor, noProgressBar }: React.PropsWithChildren<LoadingBarProps>) => React.JSX.Element;
 export { LoadingBar };
\ No newline at end of file
packages/cli-kit/dist/private/node/ui/components/SelectInput.d.ts
@@ -1,7 +1,7 @@
 import React from 'react';
 import { DOMElement } from 'ink';
 declare module 'react' {
-    function forwardRef<T, P>(render: (props: P, ref: React.Ref<T>) => JSX.Element | null): (props: P & React.RefAttributes<T>) => JSX.Element | null;
+    function forwardRef<T, P>(render: (props: P, ref: React.Ref<T>) => React.ReactElement | null): (props: P & React.RefAttributes<T>) => React.ReactElement | null;
 }
 export interface SelectInputProps<T> {
     items: Item<T>[];
@@ -29,4 +29,4 @@ export interface Item<T> {
     helperText?: string;
     disabled?: boolean;
 }
-export declare const SelectInput: <T>(props: SelectInputProps<T> & React.RefAttributes<DOMElement>) => JSX.Element | null;
\ No newline at end of file
+export declare const SelectInput: <T>(props: SelectInputProps<T> & React.RefAttributes<DOMElement>) => React.ReactElement | null;
\ No newline at end of file
packages/cli-kit/dist/private/node/ui/components/SingleTask.d.ts
@@ -1,4 +1,5 @@
 import { TokenizedString } from '../../../../public/node/output.js';
+import React from 'react';
 interface SingleTaskProps<T> {
     title: TokenizedString;
     task: (updateStatus: (status: TokenizedString) => void) => Promise<T>;
@@ -6,5 +7,5 @@ interface SingleTaskProps<T> {
     onAbort?: () => void;
     noColor?: boolean;
 }
-declare const SingleTask: <T>({ task, title, onComplete, onAbort, noColor }: SingleTaskProps<T>) => JSX.Element | null;
+declare const SingleTask: <T>({ task, title, onComplete, onAbort, noColor }: SingleTaskProps<T>) => React.JSX.Element | null;
 export { SingleTask };
\ No newline at end of file
packages/cli-kit/dist/private/node/ui/components/Tasks.d.ts
@@ -17,5 +17,5 @@ interface TasksProps<TContext> {
     noColor?: boolean;
     noProgressBar?: boolean;
 }
-declare function Tasks<TContext>({ tasks, silent, onComplete, abortSignal, noColor, noProgressBar, }: React.PropsWithChildren<TasksProps<TContext>>): JSX.Element | null;
+declare function Tasks<TContext>({ tasks, silent, onComplete, abortSignal, noColor, noProgressBar, }: React.PropsWithChildren<TasksProps<TContext>>): React.JSX.Element | null;
 export { Tasks };
\ No newline at end of file
packages/cli-kit/dist/private/node/ui/components/Table/Row.d.ts
@@ -1,5 +1,6 @@
 import ScalarDict from './ScalarDict.js';
 import { Column } from './Column.js';
+import React from 'react';
 interface RowProps<T extends ScalarDict> {
     fillerChar: string;
     rowKey: string;
@@ -7,5 +8,5 @@ interface RowProps<T extends ScalarDict> {
     columns: Column<T>[];
     ignoreColumnColor?: boolean;
 }
-declare const Row: <T extends ScalarDict>({ rowKey, columns, data, fillerChar, ignoreColumnColor }: RowProps<T>) => JSX.Element;
+declare const Row: <T extends ScalarDict>({ rowKey, columns, data, fillerChar, ignoreColumnColor }: RowProps<T>) => React.JSX.Element;
 export { Row };
\ No newline at end of file
packages/cli-kit/dist/private/node/ui/components/Table/Table.d.ts
@@ -1,4 +1,5 @@
 import ScalarDict from './ScalarDict.js';
+import React from 'react';
 import { ForegroundColor } from 'chalk';
 export type TableColumn<T> = {
     [column in keyof T]: {
@@ -10,5 +11,5 @@ export interface TableProps<T extends ScalarDict> {
     rows: T[];
     columns: TableColumn<T>;
 }
-declare function Table<T extends ScalarDict>({ rows, columns: columnsConfiguration }: TableProps<T>): JSX.Element;
+declare function Table<T extends ScalarDict>({ rows, columns: columnsConfiguration }: TableProps<T>): React.JSX.Element;
 export { Table };
\ No newline at end of file

@matteodepalo matteodepalo added this pull request to the merge queue Jan 6, 2026
Merged via the queue into main with commit 3bb514a Jan 6, 2026
25 checks passed
@matteodepalo matteodepalo deleted the update-ink branch January 6, 2026 14:06
jordanverasamy added a commit that referenced this pull request Jan 8, 2026
Remove optional modifier from withResolvers global declaration to match
native Node 24 signature. The optional modifier causes TypeScript to error
with "Overload signatures must all be optional or required" when compiling
against Node 24's built-in types.

This was introduced in PR #6740 which added the global declaration but
incorrectly marked it as optional, conflicting with the required signature
in Node 24's lib.d.ts.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants