Yeoman v5.0.0 リリースによる SPFx への影響

最近、SharePoint Framework 開発環境を構築した方で、ソリューションを作成時に以下エラーが出てしまった方がいるのでは？ と思い、情報提供です。

エラーメッセージ
「Current environment doesn’t provides some necessary feature this generator needs.

2023年11月15日に Yeoman v5.0 がリリースされたことで、バージョン指定を行わず Yeoman をインストールすると Yeoman v5.0.0 がインストールされるようになりました。SharePoint Framework 用ジェネレーター v1.18.1 以下では Yeoman v5 には対応していないため、エラーとなりソリューションが作成できません。今回は、このエラーが出てしまった場合の対処方法について備忘録として記載しておきます。

エラーの画面と発生条件

エラーは冒頭に記載のとおり、2023年11月15日以降に、SPFx v1.18.1 以下の開発環境を作成した場合に発生すると記載しましたが、正確なエラーの発生条件は、以下の通りです。

＜エラー条件＞
Yeoman v5　か SPFx v1.18.1 以下

＜エラーメッセージ＞
Current environment doesn’t provides some necessary feature this generator needs.

SPFx の開発環境を構築される際、利用するコマンドは公式ドキュメントに記載されている通り、以下を利用することが一般的と思います。

npm install gulp-cli yo @microsoft/generator-sharepoint --global

上記の場合、インストール対象は ”gulp-cli”、”Yeoman”、” @microsoft/generator-sharepoint” の3つですが、ツールの後ろにバージョンを指定していないため、コマンドを実行したタイミングの最新バージョンがグローバルインストールされるという動作となります。
なお、2023年11月22日には、Yeoman v5 に対応可能な SPFx v1.18.2 がリリースされ、SFPx v1.18.2 を利用すれば、ソリューションが作成できるようになりましたので、上記コマンドで開発環境を構築した場合にエラーは発生しなくなっています。しかし、実際にSPFx アプリの運用をされている方は常に最新の SPFx を利用するわけではなく、旧バージョンを使うことも少なくありません。
この場合、開発環境を構築する時に利用するコマンドは、以下の様にSPFx のジェネレーター部分にだけ指定バージョンを入れるという方が多いと思います。

npm install gulp-cli yo @microsoft/generator-sharepoint@1.17.4 --global 

上記のコマンドで環境構築を行い、SPFx ソリューションを作成しようとするとエラーとなり、ソリューションが作成できなくなるという状況になります。

エラーの回避方法

Yeoman v5 に対応していないのですから、Yeoman v4.x系にすれば正常に動作します。

Yeoman v4.x 系の最新はリリース情報を確認したところ、v4.3.1のようなので、v4.3.1を以下コマンドでインストールしましょう

npm install yo@4.3.1 --global

※ yo@4 と指定するだけでも、v4.x 系の最新である v4.3.1 がインストールされます。

Yeoman v4.3.1 のインストール後、エラーが解消されソリューション作成が出来るようになります。

このエラーですが、状況を考えると割と発生する可能性も高く、今後も困る方がいるのではと思ったので紹介させていただきました♪