misskey-dev / misskey-hub

Website for Misskey
https://misskey-hub.net
MIT License
285 stars 154 forks source link

package.jsonにnodeおよびnpmの必須バージョンを明記 #224

Open samunohito opened 1 year ago

samunohito commented 1 year ago

日々お世話になっております。 package.jsonにnodeおよびnpmの必須バージョンを記載する対応を行いました。

なぜ?

何をした?

package.jsonにengines項目を追記し、そこに最低限必要なnodeおよびnpmのバージョンを記載した。

影響範囲

開発者自身のみ。プロダクトやユーザ影響は無い。 開発者各位はローカルで起動に成功しているはずで、起動に成功している=node v18.0.0以上を使っているはず。 npmの実行時にバージョンの確認が走るようになるだけで、生成物などには影響はないと考える。

適合したバージョンを使用していないと以下のような警告が出るようになる

osamu@localhost:~/work/misskey-hub$ npm install
npm WARN EBADENGINE Unsupported engine {
npm WARN EBADENGINE   package: 'misskey-hub@0.0.0',
npm WARN EBADENGINE   required: { node: '>=18.0.0', npm: '>=8.6.0' },
npm WARN EBADENGINE   current: { node: 'v16.19.1', npm: '8.19.3' }
npm WARN EBADENGINE }
massongit commented 1 year ago

こちら設定するのであれば、以下のような .npmrc も追加すると、適合しないバージョンでの npm install 時にWarningではなくエラーが出るようになって、より良いかと思います。

engine-strict=true
samunohito commented 1 year ago

@massongit コメントありがとうございます。提案いただいた内容を取り込ませて頂きました。