@storybook/cli 8.3.0-alpha.1 → 8.3.0-alpha.11

package/README.md

@@ -1,3 +1,49 @@
-# Storybook CLI
+# Storybook
 
-This is a wrapper for <https://www.npmjs.com/package/@storybook/cli>
+## CLI
+
+Storybook CLI (_Command Line Interface_) is the easiest way to add [Storybook](https://github.com/storybookjs/storybook) to your project.
+
+![Screenshot](docs/getstorybook.png)
+
+Go to your project and run:
+
+```sh
+cd my-app
+npx storybook@latest init
+```
+
+In addition to `init`, the CLI also has other commands:
+
+- `add` - add an addon and register it
+- `info` - print out system information for bug reports
+- `upgrade` - upgrade to the latest version of Storybook (or a specific version)
+- `migrate` - run codemods to migrate your code
+
+See the command-line help with `-h` (including other useful commands) for details.
+
+## Core APIs
+
+This package has multiple sub-exports to can be used to gain access to storybook's APIs.
+
+### `storybook/components`
+
+This export contains a list of components very useful for building out addons.
+We recommend addon-authors to use these components to ensure a consistent look and feel, and to reduce the amount of code they need to write.
+
+### `storybook/theming`
+
+This export exposes a few utility functions to help writing components that automatically adapt to the current theme.
+Useful for addon authors who want to make their addons theme-aware.
+
+### `storybook/preview-api`
+
+This export contains the API that is available in the preview iframe.
+
+### `storybook/manager-api`
+
+This export contains the API that is available in the manager iframe.
+
+### `storybook/types`
+
+This export exposes a lot of TypeScript interfaces used throughout storybook, including for storybook configuration, addons etc.

package/bin/index.cjs

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+const majorNodeVersion = parseInt(process.versions.node, 10);
+if (majorNodeVersion < 18) {
+  console.error('To run Storybook you need to have Node.js 18 or higher');
+  process.exit(1);
+}
+
+// The Storybook CLI has a catch block for all of its commands, but if an error
+// occurs before the command even runs, for instance, if an import fails, then
+// such error will fall under the uncaughtException handler.
+// This is the earliest moment we can catch such errors.
+process.once('uncaughtException', (error) => {
+  if (error.message.includes('string-width')) {
+    console.error(
+      [
+        '🔴 Error: It looks like you are having a known issue with package hoisting.',
+        'Please check the following issue for details and solutions: https://github.com/storybookjs/storybook/issues/22431#issuecomment-1630086092\n\n',
+      ].join('\n')
+    );
+  }
+
+  throw error;
+});
+
+require('../dist/bin/index.cjs');