CLI: Use ink in CLI

code/.eslintrc.js

@@ -58,7 +58,16 @@ module.exports = {
       },
     },
     {
-      files: ['*.js', '*.jsx', '*.json', '*.html', '**/.storybook/*.ts', '**/.storybook/*.tsx'],
+      files: [
+        '*.js',
+        '*.jsx',
+        '*.json',
+        '*.html',
+        '**/.storybook/*.ts',
+        '**/.storybook/*.tsx',
+        '**/.storybook/**/*.ts',
+        '**/.storybook/**/*.tsx',
+      ],
       parserOptions: {
         project: null,
       },

code/.storybook/main.ts

@@ -1,11 +1,16 @@
 import { join } from 'node:path';
 
+import { nodePolyfills } from 'vite-plugin-node-polyfills';
+import topLevelAwait from 'vite-plugin-top-level-await';
+
 import type { StorybookConfig } from '../frameworks/react-vite';
 
 const componentsPath = join(__dirname, '../core/src/components');
 const managerApiPath = join(__dirname, '../core/src/manager-api');
 const imageContextPath = join(__dirname, '..//frameworks/nextjs/src/image-context.ts');
 
+const withInk = process.env.VITEST !== 'true';
+
 const config: StorybookConfig = {
   stories: [
     './*.stories.@(js|jsx|ts|tsx)',
@@ -93,6 +98,14 @@ const config: StorybookConfig = {
       directory: '../addons/test/template/stories',
       titlePrefix: 'addons/test',
     },
+    ...(withInk
+      ? [
+          {
+            directory: '../lib/create-storybook/src/ink',
+            titlePrefix: 'CLI/create-storybook',
+          },
+        ]
+      : []),
   ],
   addons: [
     '@storybook/addon-themes',
@@ -139,8 +152,43 @@ const config: StorybookConfig = {
     const { mergeConfig } = await import('vite');
 
     return mergeConfig(viteConfig, {
+      plugins: [
+        ...(withInk
+          ? [
+              nodePolyfills({
+                globals: {
+                  process: false,
+                  global: false,
+                  Buffer: false,
+                },
+                overrides: {
+                  process: require.resolve(join(__dirname, './mocks/node-process.ts')),
+                  module: require.resolve(join(__dirname, './mocks/node-module.ts')),
+                  util: require.resolve(join(__dirname, './mocks/node-util.ts')),
+                  stream: require.resolve('stream-browserify'),
+                  buffer: require.resolve('buffer/'),
+                  assert: require.resolve('assert/'),
+                  os: require.resolve('os-browserify/browser'),
+                  tty: require.resolve('tty-browserify'),
+                },
+              }),
+            ]
+          : []),
+        ...(configType === 'DEVELOPMENT' ? [topLevelAwait()] : []),
+      ],
       resolve: {
         alias: {
+          ...(withInk
+            ? {
+                'cli-cursor': require.resolve(join(__dirname, './mocks/cli-cursor.ts')),
+                'is-in-ci': require.resolve(join(__dirname, './mocks/is-in-ci.ts')),
+                'yoga-wasm-web/auto':
+                  'https://cdn.jsdelivr.net/npm/[email protected]/dist/browser.js',
+                'yoga-wasm-web': 'https://cdn.jsdelivr.net/npm/[email protected]/+esm',
+              }
+            : {}),
+
+          // storybook related
           ...(configType === 'DEVELOPMENT'
             ? {
                 '@storybook/components': componentsPath,
@@ -154,12 +202,24 @@ const config: StorybookConfig = {
       },
       optimizeDeps: {
         force: true,
-        include: ['@storybook/blocks'],
+        include: [
+          '@storybook/blocks',
+          ...(withInk
+            ? [
+                'vite-plugin-node-polyfills/shims/buffer',
+                'vite-plugin-node-polyfills/shims/global',
+                '@xterm/xterm',
+                'ink',
+              ]
+            : []),
+        ],
       },
       build: {
         // disable sourcemaps in CI to not run out of memory
         sourcemap: process.env.CI !== 'true',
+        target: ['chrome100'],
       },
+
       server: {
         watch: {
           // Something odd happens with tsconfig and nx which causes Storybook to keep reloading, so we ignore them

code/.storybook/mocks/cli-cursor.ts

@@ -0,0 +1,10 @@
+/**
+ * This module takes the stdin, but ink doesn't pass it to the methods; that causes the methods to
+ * assume node:process-stdin, but that breaks, causing the code to fail. I mocked the 2 methods, so
+ * they do nothing. There is no cursor in storybook.
+ */
+
+export default {
+  show: () => {},
+  hide: () => {},
+};

code/.storybook/mocks/is-in-ci.ts

@@ -0,0 +1,6 @@
+/**
+ * This module is mocked, because it uses something node-internal that's not in our node-polyfills
+ * In storybook, we don't need to know if we are in a CI environment, because we will never be.
+ */
+
+export default false;

code/.storybook/mocks/node-module.ts

@@ -0,0 +1,7 @@
+/**
+ * This module is mocked, because ink, and a few ink related modules use the named exports, which
+ * the node-polyfills to not supply
+ */
+
+export const builtinModules = [];
+export const env = {};

code/.storybook/mocks/node-process.ts

@@ -0,0 +1,12 @@
+/**
+ * This module is mocked, because ink, and a few ink related modules use the named exports, which
+ * the node-polyfills to not supply
+ */
+import process from 'vite-plugin-node-polyfills/shims/process';
+
+export * from 'vite-plugin-node-polyfills/shims/process';
+
+export default process;
+
+export const cwd = () => '/';
+export const env = {};

code/.storybook/mocks/node-util.ts

@@ -0,0 +1,10 @@
+/**
+ * This module is mocked, because ink, and a few ink related modules use the named exports, which
+ * the node-polyfills to not supply
+ */
+
+export * from 'util';
+
+export const isDeepStrictEqual = (a: any, b: any) => {
+  return a === b;
+};

code/.storybook/vitest.config.ts

@@ -39,6 +39,7 @@ export default mergeConfig(
         '../node_modules/**',
         '**/__mockdata__/**',
         '../**/__mockdata__/**',
+        '**/ink/**', // these stories need a lot of node dependencies aliased, which breaks portable stories
         '**/Zoom.stories.tsx', // expected to fail in Vitest because of fetching /iframe.html to cause ECONNREFUSED
         '**/lib/blocks/src/**', // won't work because of https://github.com/storybookjs/storybook/issues/29783
       ],

code/core/package.json

@@ -284,7 +284,8 @@
     "recast": "^0.23.5",
     "semver": "^7.6.2",
     "util": "^0.12.5",
-    "ws": "^8.2.3"
+    "ws": "^8.2.3",
+    "yoga-wasm-web": "^0.3.3"
   },
   "devDependencies": {
     "@aw-web-design/x-default-browser": "1.4.126",
@@ -301,6 +302,7 @@
     "@emotion/styled": "^11.11.0",
     "@emotion/use-insertion-effect-with-fallbacks": "^1.0.1",
     "@fal-works/esbuild-plugin-global-externals": "^2.1.2",
+    "@inkjs/ui": "^2.0.0",
     "@ndelangen/get-tarball": "^3.0.7",
     "@polka/compression": "^1.0.0-next.28",
     "@popperjs/core": "^2.6.0",
@@ -328,6 +330,7 @@
     "@types/react-transition-group": "^4",
     "@types/semver": "^7.5.8",
     "@types/ws": "^8",
+    "@xterm/xterm": "^5.5.0",
     "@yarnpkg/esbuild-plugin-pnp": "^3.0.0-rc.10",
     "@yarnpkg/fslib": "2.10.3",
     "@yarnpkg/libzip": "2.3.0",
@@ -354,16 +357,19 @@
     "es-toolkit": "^1.22.0",
     "esbuild": "^0.18.0 || ^0.19.0 || ^0.20.0 || ^0.21.0 || ^0.22.0 || ^0.23.0",
     "esbuild-plugin-alias": "^0.2.1",
+    "esbuild-plugin-text-replace": "^1.3.0",
     "execa": "^8.0.1",
     "fd-package-json": "^1.2.0",
     "fetch-retry": "^6.0.0",
+    "figures": "^6.1.0",
     "find-cache-dir": "^5.0.0",
     "find-up": "^7.0.0",
     "flush-promises": "^1.0.2",
     "fuse.js": "^3.6.1",
     "get-npm-tarball-url": "^2.0.3",
     "glob": "^10.0.0",
     "globby": "^14.0.1",
+    "ink": "^5.1.0",
     "jiti": "^1.21.6",
     "js-yaml": "^4.1.0",
     "lazy-universal-dotenv": "^4.0.0",

code/core/scripts/prep.ts

@@ -1,9 +1,11 @@
 /* eslint-disable local-rules/no-uncategorized-errors */
-import { existsSync, mkdirSync, watch } from 'node:fs';
+import { existsSync, watch } from 'node:fs';
 import { mkdir, rm, writeFile } from 'node:fs/promises';
-import { dirname, join } from 'node:path';
+import { dirname, join, sep } from 'node:path';
 
-import type { Metafile } from 'esbuild';
+import type { Plugin as EsbuildPlugin, Metafile } from 'esbuild';
+// eslint-disable-next-line import/no-extraneous-dependencies
+import replacePlugin from 'esbuild-plugin-text-replace';
 
 import {
   dedent,
@@ -124,6 +126,20 @@ async function run() {
       platform: 'neutral',
       mainFields: ['main', 'module', 'node'],
       conditions: ['node', 'module', 'import', 'require'],
+      plugins: [
+        replacePlugin({
+          include: sep === '/' ? /node_modules\/ink/ : /node_modules\\ink/,
+          pattern: [
+            //
+            [`process.env['DEV']`, `'false'`],
+            [`await import('./devtools.js')`, ''],
+          ],
+        }) as any as EsbuildPlugin,
+      ],
+      define: {
+        'process.env.NODE_ENV': '"production"',
+        'process.env.DEV': '"false"',
+      },
     } satisfies EsbuildContextOptions;
 
     const browserAliases = {

code/core/src/cli/bin/index.ts

@@ -89,6 +89,13 @@ command('dev')
     await dev({ ...options, packageJson: pkg }).catch(() => process.exit(1));
   });
 
+command('ink')
+  .option('-n, --name <name>', 'The name (this is a dummy parameter)')
+  .action(async (options) => {
+    const { run } = await import('../ink/app');
+    await run(options);
+  });
+
 command('build')
   .option('-o, --output-dir <dir-name>', 'Directory where to store built files')
   .option('-c, --config-dir <dir-name>', 'Directory where to load Storybook configurations from')
@@ -108,7 +115,9 @@ command('build')
   .option('--docs', 'Build a documentation-only site using addon-docs')
   .option('--test', 'Build stories optimized for testing purposes.')
   .action(async (options) => {
-    process.env.NODE_ENV = process.env.NODE_ENV || 'production';
+    const { env } = process;
+    env.NODE_ENV = env.NODE_ENV || 'production';
+
     logger.setLevel(options.loglevel);
     consoleLogger.log(picocolors.bold(`${pkg.name} v${pkg.version}\n`));
 

code/core/src/cli/dev.ts

@@ -40,7 +40,8 @@ function printError(error: any) {
 }
 
 export const dev = async (cliOptions: CLIOptions) => {
-  process.env.NODE_ENV = process.env.NODE_ENV || 'development';
+  const { env } = process;
+  env.NODE_ENV = env.NODE_ENV || 'development';
 
   const packageJson = await findPackage(__dirname);
   invariant(packageJson, 'Failed to find the closest package.json file.');

code/core/src/cli/ink/app.tsx

@@ -0,0 +1,61 @@
+import React from 'react';
+
+import { debounce } from 'es-toolkit';
+import { Box, Text, render } from 'ink';
+
+declare global {
+  // eslint-disable-next-line no-var
+  var CLI_APP_INSTANCE: ReturnType<typeof render> | undefined;
+}
+
+if (globalThis.CLI_APP_INSTANCE) {
+  globalThis.CLI_APP_INSTANCE.unmount();
+}
+
+interface Options {
+  name?: string[];
+}
+
+export async function run(options: Options) {
+  const state = {
+    name: options.name || 'stranger',
+    width: process.stdout.columns || 120,
+    height: process.stdout.rows || 40,
+  };
+
+  process.stdout.write('\x1Bc');
+  globalThis.CLI_APP_INSTANCE = render(
+    <Box>
+      <Text>
+        {state.name} - {state.width} x {state.height}
+      </Text>
+    </Box>
+  );
+
+  const { rerender, waitUntilExit } = globalThis.CLI_APP_INSTANCE;
+
+  const update = debounce(
+    () => {
+      state.width = process.stdout.columns || 120;
+      state.height = process.stdout.rows || 40;
+
+      process.stdout.write('\x1Bc');
+      rerender(
+        <Box>
+          <Text>
+            {state.name} - {state.width} x {state.height}
+          </Text>
+        </Box>
+      );
+    },
+    8,
+    { edges: ['trailing'] }
+  );
+
+  process.stdout.on('resize', () => {
+    process.stdout.write('\x1Bc');
+    update();
+  });
+
+  await waitUntilExit();
+}

code/core/src/core-server/utils/doTelemetry.ts

@@ -1,7 +1,7 @@
 import { getPrecedingUpgrade, telemetry } from '@storybook/core/telemetry';
 import type { CoreConfig, Options } from '@storybook/core/types';
 
-import type Polka from 'polka';
+import type { Polka } from 'polka';
 import invariant from 'tiny-invariant';
 
 import { sendTelemetryError } from '../withTelemetry';
@@ -11,7 +11,7 @@ import { summarizeIndex } from './summarizeIndex';
 import { versionStatus } from './versionStatus';
 
 export async function doTelemetry(
-  app: Polka.Polka,
+  app: Polka,
   core: CoreConfig,
   initializedStoryIndexGenerator: Promise<StoryIndexGenerator | undefined>,
   options: Options

code/core/src/core-server/utils/getStoryIndexGenerator.ts

@@ -1,14 +1,14 @@
 import { normalizeStories } from '@storybook/core/common';
 import type { DocsOptions, Options } from '@storybook/core/types';
 
-import type Polka from 'polka';
+import type { Polka } from 'polka';
 
 import { StoryIndexGenerator } from './StoryIndexGenerator';
 import type { ServerChannel } from './get-server-channel';
 import { useStoriesJson } from './stories-json';
 
 export async function getStoryIndexGenerator(
-  app: Polka.Polka,
+  app: Polka,
   options: Options,
   serverChannel: ServerChannel
 ): Promise<StoryIndexGenerator | undefined> {