Gridsome を 0.6→0.7 にバージョンアップしたら「The field Query.metaData is deprecated. Use Query.metadata instead.」の警告が出た

Gridsomeで作成したサイトに新機能を追加するため、Gridsomeのプラグインを検索しようとしたところ、いつのまにかv0.7にバージョンアップしていました。

• Gridsome v0.7 - Gridsome
• gridsome/CHANGELOG.md at master · gridsome/gridsome · GitHub

「新機能を追加する前にバージョンアップするか...」と思い、

• yarn upgrade gridsome --latest
• gridsome develop

でバージョンアップ＆ローカル環境で実行したところ、
The field Query.metaData is deprecated. Use Query.metadata instead.
の警告が発生していました。

この記事では、上記が発生した原因と対処方法をメモとして書いておきたいと思います。

0.7で「metaData」→「metadata」に変更された

Gridsome公式ブログの0.7リリース記事、
Renamed methods and GraphQL fieldsを見ると、

    Use addMetadata() instead of addMetaData().
    Use addCollection() instead of addContentType().
    Use metadata instead of metaData in the GraphQL schema and project config.

と、メソッドやGraphQLフィールド名に一部が変更したとのことです。

• addMetadata()
• addCollection()
• metaData

を使用していると、非推奨だから新しいメソッドやフィールドを使ってね。という警告が出ます。

0.7では警告のみですが、今後のバージョンアップで使用できなくなる可能性もあるため、バージョンアップの際は書き換えると良いと思います。

余談

metaData→metadataに変更になったのは以下コミット...かな...？
（どこかでコードリーディングしたいな...）

• feat(graphql): customize the schema (#509) · gridsome/gridsome@c4684b2 · GitHub
• gridsome/Store.js at master · gridsome/gridsome · GitHub

自分が本件を対処した際のPRを晒しときます。参考になれば幸いです。🙇‍♂️

• refactor: version up 0.6 to 0.7 by zakizaki-ri9 · Pull Request #19 · zakizaki-ri9/gridsome-trattoria-site · GitHub

Gridsomeで作成したサイトはこちらです。

kic-yuuki.hatenablog.com

おわり

短いですが、以上になります。

もし気になる点等ありましたら、FBいただけると幸いです！