@wordpress/create-block

クイックスタート

$ npx @wordpress/create-block@latest todo-list
$ cd todo-list
$ npm start

提供されたslug（例ではtodo-list）は、スキャフォールドされたプラグインのフォルダー名と内部ブロック名を定義します。生成されたWordPressプラグインは手動でインストールする必要があります。

(nodeバージョン20.10.0以上、npmバージョン10.2.3以上が必要です)

Learn.wordpress.orgでcreate-blockのビデオ紹介を見る

使用法

``````bash
$ npx @wordpress/create-block@latest [options] [slug]
`

ブロックの名前は、ブロックを識別するためのユニークな文字列です。ブロック名はnamespace/slugの形式で構成され、namespaceはプラグインまたはテーマの名前です。

ほとんどの場合、テーマではなくWordPressプラグインとブロックをペアにすることをお勧めします。なぜなら、プラグインを使用することで、テーマが変更されてもすべてのブロックが機能し続けるからです。

インタラクティブモード

 <a name="slug"></a>
### スラッグ
`````slug`````の使用はオプションです。  
提供されると、*クイックモード*がトリガーされ、`````slug`````が使用されます：  
 – ブロックスラッグとして（識別に必要）  
 – スキャフォールドされたファイルの出力場所（フォルダー名）として  
 – WordPressプラグインの名前として。  
残りの設定は、以下にリストされているオプションで上書きされない限り、すべてデフォルト値に設定されます。  
 <a name="options"></a>
### オプション
``````bash
-V, --version                output the version number
-t, --template <name>        project template type name; allowed values: "static" (default), "es5", the name of an external npm package, or the path to a local directory
--no-plugin                  scaffold block files only
--namespace <value>          internal namespace for the block name
--title <value>              display title for the block and the WordPress plugin
--short-description <value>  short description for the block and the WordPress plugin
--category <name>            category name for the block
--wp-scripts                 enable integration with `@wordpress/scripts` package
--no-wp-scripts              disable integration with `@wordpress/scripts` package
--wp-env                     enable integration with `@wordpress/env` package
-h, --help                   output usage information
--variant                    choose a block variant as defined by the template
`

—template

この引数は、外部npmパッケージをテンプレートとして指定します。

$ npx @wordpress/create-block@latest --template my-template-package

この引数は、ローカルディレクトリをテンプレートとして選択することも可能です。

$ npx @wordpress/create-block@latest --template ./path/to/template-directory

—variant

この引数を使用すると、create-blockは組み込みテンプレートに基づいてダイナミックブロックを生成します。

$ npx @wordpress/create-block@latest --variant dynamic

—help

この引数を使用すると、create-blockパッケージは使用情報を出力します。

$ npx @wordpress/create-block@latest --help

—no-plugin

この引数を使用すると、create-blockパッケージはプラグインなしモードで実行され、ブロックファイルを現在のディレクトリにのみスキャフォールドします。

$ npx @wordpress/create-block@latest --no-plugin

—wp-env

この引数を使用すると、create-blockパッケージは生成されたプラグインにwp-envパッケージを実行するための設定とスクリプトを追加します。これにより、生成されたプラグインの構築とテストのために、ローカルWordPress環境（Docker経由）を簡単にセットアップできます。

$ npx @wordpress/create-block@latest --wp-env

スキャフォールドされたプロジェクトの利用可能なコマンド

このコマンドを実行すると作成されるプラグインフォルダーは、設定不要のモダンなビルドセットアップを持つノードパッケージです。

そのフォルダー内から利用可能なスクリプトのセット（scriptsパッケージによって提供）があります。これらのコマンドの完全な説明についてはこちらをクリックしてください。

注：自分でwebpack、Babel、またはESLintのようなツールをインストールまたは設定する必要はありません。これらは事前に設定されており、隠されているため、コーディングに集中できます。

たとえば、生成されたフォルダー（npm start）内からstartスクリプトを実行すると、開発用のビルドが自動的に開始されます。

外部プロジェクトテンプレート

こちらをクリックして外部プロジェクトテンプレートに関する情報を確認してください。

このパッケージへの貢献

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

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