Zenn
🔎

SafariでもReact Dev Tools使いたい(Next.jsでつかう)

2021/02/28に公開
Next.js
React
debug
tech

React Dev ToolsはSafari向けのExtensionがないので、

$ npx react-devtools

としてスタンドアロン版を立ち上げて使います。実際使うときは、<script src="http://localhost:8097"></script> というタグをReact DOMをインポートする前に読み込む必要がありますが、必要な時以外は読みたくありません。

Next.jsで必要な場合のみ読み込めるようにしてみます。

_document.jsx ファイルにタグを埋め込む

まずは適切な位置にタグを埋め込んでみます。今回は、_document.jsxファイルを使います。_document.jsxは通常気にしなくて良いNext.jsの外側の世界、 <html> タグや <body> タグの部分を直接いじることのできるファイルです。詳しくはドキュメントを参照してください。

_document.jsx ファイルを作ったら、次のように書き込んでみます。(私はTypeScriptを使っているので、tsxファイルです)

_document.tsx
import Document, { Html, Head, Main, NextScript } from "next/document";

class CustomDoc extends Document {
  static async getInitialProps(ctx) {
    const initialProps = await Document.getInitialProps(ctx);
    return { ...initialProps };
  }

  render() {
    return (
      <Html>
        <Head></Head>
        <body>
          <Main />
	  {/* ↓この行を追加↓ */}
          <script src="http://localhost:8097">
          <NextScript />
        </body>
      </Html>
    );
  }
}

export default CustomDoc;

これで一旦疎通確認をしてみます。npx react-devtoolsした上で、いつもどおりnext devしてページを開いてみて、起動したReact Devtoolsが反応すればOKです。

環境変数ファイルを読み込む仕組みを使う

本番環境や不要な環境では読み込みたくないので、必要な場合のみ読み込むようにしてみます。

Next.js 9.4以降からは、.env や .env.development などといったファイルでprocess.envの値を書き換えられるようになっています。

例に挙げた .envは常に読み込まれる環境変数で、.env.developmentはnext devで起動した場合に読み込む用です。.env.development.local など .local を最後につけても読み込むようになっていますが、これは各開発者の手元で指定したい用途を想定して作られているようです。そのため、.localがsuffixについているものは.gitignoreに設定しておく必要があります。

環境変数ファイルを用意

まずは、環境変数ファイルを用意します。通常の開発中は無効にしておき、使いたい人だけが有効にできるようにします。

.env.development
ENABLE_STANDALONE_DEVTOOLS=false
.env.development.local
ENABLE_STANDALONE_DEVTOOLS=true

.env.development.local は各開発者が独自に設定できることを想定したファイルなので、gitignoreしておきます。

.env.development.local

_document.jsx の書き換え

最後に、_document.jsxを変更しておきます。次にコードを一部抜粋しておきます。

_document.tsx
          <Main />
          {process.env.ENABLE_STANDALONE_DEVTOOLS === "true" ? (
            <script src="http://localhost:8097"></script>
          ) : null}
          <NextScript />

これで、 .env.development.local の設定ファイルにtrue以外の環境変数を指定した場合に、設定が取り除かれるようになったはずです。

まとめ

この記事では、React DevToolsのスタンドアロン版を使用する方法、Next.jsの_document.tsx、.envファイルについて紹介しました。

React Dev Tools使用時は __REACT_DEVTOOLS_GLOBAL_HOOK__ が定義されるようなので、これを使って判別してみても面白いかもしれません。時間がある時に試してみたいと思います。

Discussion