@wordpress/warning

インストール

モジュールをインストールします

npm install @wordpress/warning --save

このパッケージは、あなたのコードがES2015+環境で実行されることを前提としています。そのような言語機能やAPIのサポートが限られているか、まったくない環境を使用している場合は、コードに@wordpress/babel-preset-defaultで提供されるポリフィルを含める必要があります。

バンドルサイズの削減

リテラル文字列はミニファイされません。これらをプロダクションバンドルに保持すると、バンドルサイズが大幅に増加する可能性があります。

それを防ぐために、次のことを行うべきです：

• 1. @wordpress/warning/babel-pluginをあなたのbabel設定に入れるか、@wordpress/babel-preset-defaultを使用してください。これはすでにbabelプラグインを含んでいます。
  これにより、warningの呼び出しがSCRIPT_DEBUG === trueを確認する条件内にラップされることが保証されます。
• 2. UglifyJS、Terserまたはデッドコード削除を実行する他のJavaScriptパーサーを使用してください。これは通常、webpackなどのJavaScriptバンドラーと一緒に使用されます。
  productionモードでコードを解析すると、warningの呼び出しは完全に削除されます。
  

API

デフォルト

環境がproductionでない場合、messageを使用して警告を表示します。

使用法

import warning from '@wordpress/warning';
function MyComponent( props ) {
  if ( ! props.title ) {
   warning( '`props.title` was not passed' );
  }
  ...
}

パラメータ

• メッセージ string: 警告に表示するメッセージ。

このパッケージへの貢献

これはGutenbergプロジェクトの一部である個別のパッケージです。このプロジェクトはモノレポとして整理されています。特定の目的を持つ複数の自己完結型ソフトウェアパッケージで構成されています。このモノレポ内のパッケージはnpmに公開され、WordPressや他のソフトウェアプロジェクトで使用されています。

このパッケージやGutenberg全体への貢献について詳しく知りたい場合は、プロジェクトの主要な貢献者ガイドをお読みください。