files オプションで対象の .mdx を絞って効率よく開発する

monorepo なプロジェクトなどでたくさんのコンポーネントを1つのリポジトリで管理しているのですが、コンポーネントの数が増えていくのに伴い、開発サーバーの立ち上げ時間が明らかに遅かったり「監視ファイルの上限に…」みたいな警告を言われたり、これがストレスになってきたので、何か改善できないかと設定など読み直しました。

--files

そこで見つけたのが--filesというオプションです。これはdoczrc.jsというような設定ファイルにも書けるのですが、オプションで都度渡すのがおすすめです。 monorepo のルートディレクトリで以下のようにコマンドを叩くことでワークスペース毎のコンポーネント開発ができるからです。(ただのglobパターンです)

# foo ワークスペースのコンポーネント開発
yarn docz dev --files 'components/foo/**/*.mdx'
# bar ワークスペースのコンポーネント開発
yarn docz dev --files 'components/bar/**/*.mdx'

# foo と bar 両ワークスペースのコンポーネント開発
yarn docz dev --files 'components/@(foo|bar)/**/*.mdx'

doczrc.js の設定が優先

少なくともdocz@0.13.7まではdoczrc.jsfiles: '**/*.mdxと書いてしまうとコマンドの--filesオプションより優先して適用されてしまい、上書きできないので設定ファイルには記述しないでおくといいと思います。ちなみに、デフォルト値は、**/*.mdxです。