あらすじ
何時もgen-flow-filesで型自動生成してたのに、急に動かなくなった。
コンポーネントに型定義してるだけなのに何が悪いかわからない。
ただ、見た目を整えたかったから.scssをimportした。←動かない原因だった。
先ずはざっくり使い方を書いて、最後に注意点を書きました。
gen-flow-filesの使い方
目的はライブラリとして、publishした時に型定義がしっかり効くこと。
詳しくはテストファイルを読む。
前準備
先ずは、flow stopで稼働中のflow serverを停止。
コマンド実行
flow gen-flow-files index.js --out-dir type-definitions
コマンド実行結果
index.jsに記述されたflowの型定義が、「type-definitions」ディレクトリに「index.js.flow」として吐き出されている。
後処理
index.jsとindex.js.flowを同じ階層に置いて、publishする。
(package.jsonのfilesにきちんとpublish出来るようにファイル、あるいはディレクトリを列挙しておくこと)
https://docs.npmjs.com/files/package.json#files
注意点
-
// @flowで型定義したファイルにjsjsxmjsjson以外の物を含めないこと。 -
.flowconfigで.css.scssをignoreしたからって、flowは無視してくれない。 -
.css.scssをimportしたければ、suppress_commentを適用しなければいけない。(.flowconfigでカスタマイズ可能) - エディタを開きっぱなしで、
gen-flow-filesを実行しても動作しない可能性が高い。(エディターとgen-flow-filesで、どちらかがflow serverを占拠している??)