Liferay CLI ツール
Liferay CLIツールは、LiferayのRESTおよびGraphQLサービスとインターフェイスで接続するために、 Angular 、 JavaScript、 React 、共有されるバンドル、または Vue.js プロジェクトを簡単に作成できるようにします。 liferayコマンドを使用すると、プロジェクトの生成、ビルド、デプロイを行うことができます。
Liferay CLIツールは、Liferay DXP 7.4+用のJavaScriptアプリケーションプロジェクトを作成するために使用されていた古いYeomanジェネレータに代わるものです。 古いバージョンではどちらの方法でも使用できますが、7.4以降ではYeomanジェネレーターの代わりにCLIツールを使用する必要があります。
CLIツールのインストール
次のコマンドを実行すると、CLIツールがローカルシステムにインストールされます。
npm install -g @liferay/cli
CLI ツールをグローバルにインストールしたくない場合は、 npx を使用することで、インストールせずにツールのコマンドを実行することもできます。 例えば、npx @liferay/cli new [project-name] を実行することで、 新しいプロジェクトを生成する ことができます。
プロジェクトの生成
liferay new コマンドを使用して、新しい Remote App または Liferay Platform プロジェクトを作成します。
ターミナルを開き、プロジェクトを作成したい場所に移動します。 次のコマンドを実行します。
liferay new [project-name]プロンプトで新規プロジェクトの名前を入力します。 この名前がIDとして使用されます。
リモートアプリケーションプロジェクトを作成するか、Liferay プラットフォームプロジェクトを作成するかを選択します。
noteリモートアプリケーションプロジェクト は、Liferay DXPインスタンスがアプリケーションとして使用するためにアクセスできるリモートサーバーでホストされています。 Liferayプラットフォームのプロジェクトは、Liferay DXP／Portalにデプロイ可能です。
プロンプトで、新規プロジェクトについて、人間が読み取り可能な説明を入力します。 デフォルト値は、「New Project」です。
プロジェクトのターゲットプラットフォームを選択します。 選択したターゲットプラットフォームによって、プロジェクトのデフォルトの依存関係と、プロジェクトのビルドに使用するルール（例えば、プロジェクトがターゲットプラットフォームの利用可能なすべてのJavaScript APIにアクセスする必要があるかどうか）が決定されます。
バージョン 7.1以降では、Liferay PortalまたはLiferay DXPのターゲットプラットフォームを選択することができます。 また、「Liferay Portal CE (not sharing platform’s packages)」を選択すると、プロジェクトの
package.jsonファイルに@lifray/portal-agnosticターゲットを定義することができます。 この場合、プロジェクトにはLiferay Portalにバンドルされている追加のパッケージは含まれず、必要な依存関係はビルドツールとバンドルツールだけです。noteリモートアプリケーションプロジェクトを選択した場合、バージョン7.4+しか選択できません。
not sharing platform's packagesオプションではなく、特定のバージョンを選択した場合、プロジェクトはLiferayプラットフォームからReactパッケージを取得します。 このオプションは、プロジェクトのサイズと手動依存を減らしますが、プロジェクトがそのバージョンにバンドルされているパッケージを使用するように制限されます。プロンプトに表示されるオプションから、作成するプロジェクトの種類を選択します。
noteリモートアプリケーションプロジェクトの作成を選択した場合、Reactタイプのみ選択可能です。
Liferayプラットフォームプロジェクトを作成することを選択した場合、 ウィジェットのカテゴリーを選択します。 カテゴリーは、ページ編集時にウィジェットのリストでどのようにソートされるかを決定します。 デフォルト値は
category.sample(「Sample」ウィジェットカテゴリ用)ですが、任意のカスタム値に変更することが可能です。リモートアプリケーションプロジェクトを作成する場合、 カスタム要素のHTMLタグ名を選択します。 名前には少なくとも1つのハイフン(
-)を含み、文字で始める必要があります。 次に、shadow DOMを使用してレンダリングするかどうかのプロンプト（yまたはn）に答えます。
CLIツールは、選択した名前で、新しいフォルダーにプロジェクトを作成します。
プロジェクトの構築
次のコマンドで、CLIツールで作成したプロジェクトをビルドします。
liferay build
これでプロジェクトがビルドされ、出来上がったJARファイルがプロジェクトのdist/ディレクトリに置かれます。 そして、そのJARを任意のLiferayインスタンスにデプロイすることができます。
また、CLIツールで作成したプロジェクト内で、liferay build のエイリアスとしてnpm run buildを実行することができます。
プロジェクトのデプロイ
このコマンドを使用して、プロジェクトの dist/ ディレクトリに保存されている JAR ファイルをローカルの Liferay インストールにデプロイします ( liferay build を実行した後)。
liferay deploy
このタスクを初めて実行すると、デプロイできるようにLiferayのインストールディレクトリを要求して、その回答をプロジェクトのフォルダにある .liferay.json ファイルに格納します。 このファイルで設定したディレクトリを変更することで、デプロイ先を変更します。
プロジェクトのビルドファイルの消去
古い成果物がビルドの妨げになる場合、cleanコマンドを使って、 build と deploy コマンドで作成された build/ と dist/ を削除します。
プロジェクトのディレクトリからこのコマンドを実行すると、これらのフォルダが削除されます。
liferay clean
Yeomanジェネレータで作成したプロジェクトのアップグレード
CLIツールのコマンドを実行するには、プロジェクトが正しく構成されている必要があります。 古いYeomanジェネレータ（ yo liferay-js コマンドを使用）で作成されたプロジェクトは、まず新しいアーキテクチャにアップグレードする必要があります。
upgrade-projectコマンドは、Yeomanジェネレータが作成したプロジェクトの一部のみをアップグレードします。 その他、プロジェクトに行った変更・カスタマイゼーションはそのまま残ります。 アップグレードを試みる前にプロジェクトをバックアップし、アップグレードが自分の変更と競合する場合に備えて、手動で変更する準備をしておいてください。
このコマンドを実行すると、Yeoman ジェネレーターで作成した React、Angular、または Vue.js プロジェクトが Liferay CLI ツールで動作するようアップグレードされます。
liferay upgrade-project
他のツールで作成したプロジェクトを適用する
また、他のツールで作成したプロジェクトをLiferay CLIツールでデプロイできるように適応させることも可能です。 これらのツールで作成したプロジェクトを適応することができます。
React ： create-react-app プロジェクトジェネレータ
Angular ： Angular CLI プロジェクトジェネレータ
これらの他のジェネレータで作成されたプロジェクトを適応させるには、プロジェクトのディレクトリからこのコマンドを実行します。
liferay adapt
CLIツールは、プロジェクトの依存関係から検出されたフレームワークに基づいて、プロジェクトを適応させます。 プロジェクトの package.json ファイルから、これらの特定の依存関係 ( dependency または devDependencyとしてリストアップされています) を探します。
React用 :
react-scriptsAngular用 :
@angular/cliVue.js用 :
@vue/cli-service