Next.jsアプリにStorybookを導入する

はじめに

この記事ではNext.jsアプリにStobybookを導入する方法について書きます。
CSS Modulesを使用してスタイリングを行う既存のNext.jsアプリに導入することを前提としており、主にGet started with Storybook and Next.jsに従って進めていきます。
Sass、Chakra UIなどでスタイリングを行っている場合は別に設定が必要になります。別途こちらを参照してください。

この記事が他の人の参考になれば幸いです。
また、この記事の内容に間違った記載がありましたら、指摘してもらえるとありがたいです。

環境

名前	バージョン
macOS Monterey	12.0.1
Node.js	16.13.0
React	17.0.2
Next.js	12.0.7
Storybook	6.4.9

Storybookのセットアップ

以下のコマンドを実行し、Storybookと関連パッケージをインストールします。
パフォーマンスとNext.jsとの一貫性のためビルダーとしてWebpack 5を使用します。
コマンド実行中にeslintPluginをインストールし、設定するか聞かれます。この自動設定は.eslintrcの拡張子がjsonの場合は対応していないので、本記事ではnoにし、後で設定します。

terminal

npx sb init --builder webpack5

上記のコマンド実行後、npm run storybookコマンドでStorybookを起動できます。

Storybook環境へのグローバルCSSの適用

Storybook環境でもグローバルCSSが適用されるために.storybook/preview.jsに以下のようにグローバルCSSのインポート文を追加します。

.storybook/preview.js

import "../styles/globals.css";

Storybookでnext/imageを扱うための設定の追加

next/imageコンポーネントはNext.jsによって自動的に最適化処理が行われます。
しかし、StorybookはNext.jsとは独立した環境を構築するため、そのままではうまく表示されません。
そのためStorybookでnext/imageコンポーネントを適切に表示する設定を行います。

まず、Next.jsで画像を配置するpublicディレクトリをStorybookで扱うために.storybook/main.jsに以下の設定を追加します。

.storybook/main.js

module.exports = {
  ...
  staticDirs: ["../public"],
};

そして、Storybookでは最適化されていないnext/imageコンポーネントを使用するために.storybook/preview.jsに以下の内容を追加します。

.storybook/preview.js

import * as NextImage from "next/image";

...

const OriginalNextImage = NextImage.default;

Object.defineProperty(NextImage, 'default', {
  configurable: true,
  value: (props) => <OriginalNextImage {...props} unoptimized />,
});

モジュールパスエイリアスを対応づける

相対パスでインポートを行っている場合にこの設定は必要ないので読み飛ばしてください。

ベースURL、モジュールパスエイリアスを使用する場合はStorybookに対応関係を伝えないといけません。
.storybook/main.jsに以下のように追加します。
この記事ではsrc/components、src/lib、src/models、src/pages、src/stylesディレクトリの対応関係を設定しています。

.storybook/main.js

const path = require("path");

module.exports = {
  ...
  webpackFinal: async (config) => {
    return {
      ...config,
      resolve: {
        ...config.resolve,
        alias: {
          ...config.resolve.alias,
          "@/components": path.resolve(__dirname, "../src/components"),
          "@/lib": path.resolve(__dirname, "../src/lib"),
          "@/models": path.resolve(__dirname, "../src/models"),
          "@/pages": path.resolve(__dirname, "../src/pages"),
          "@/styles": path.resolve(__dirname, "../src/styles"),
        },
      },
    };
  },
};

Storybookに関するESLintルールの追加

手動でStorybookのESLintプラグインeslint-plugin-storybookをインストールし、適用します。
このプラグインは.stories.*もしくは.story.*の拡張子のファイルに対してStorybookのベストプラクティスルールを追加します。
以下のコマンドでインストールします。

npm i -D eslint-plugin-storybook

プラブインを適用するために.eslint.jsonを変更します。以下のようにextendsに"plugin:storybook/recommended"を追加してください。

{
  "extends": ["plugin:storybook/recommended", "next/core-web-vitals"]
}

参考

• Get started with Storybook and Next.js
• eslint-plugin-storybook