Skip to main content

アップグレードツール

アップグレードツールは、AI MarketerユーザーがAI Marketerアプリケーションの依存関係とコードを特定のバージョンにアップグレードするのを支援します。

アップグレードツールを実行すると、アプリケーションの依存関係の更新、そのインストール、およびターゲットとなるバージョンまでに導入されたブレーキングチェンジに従ってアプリケーションのコードベースを自動的に編集する一連のcodemods の実行がトリガーされます。

アップグレードツールはAI Marketerパッケージであり、CLIから実行することができます。

範囲​

アップグレードツールはアプリケーションとプラグインのアップグレードを支援しますが、それらのすべての側面をカバーするわけではありません。

✅ アップグレードツールは以下をサポートします：

  • プロジェクトの依存関係の更新
  • 既存のファイルに対する自動コード変換の適用
  • プロジェクトに適した依存関係のインストールまたは再インストール

❌ アップグレードツールは以下をサポートしていません：

  • ファイルツリーの変更、つまりファイルやディレクトリの追加、削除、移動
  • アプリケーションのデータの移行。これはAI Marketerデータベースの移行によって処理されます
⚠️ Warning

アップグレードツールが実行を完了した後、 アプリケーションやプラグインを再実行する前に、行われた変更を確認することを強く推奨します。

バージョンタイプ​

AI Marketerのバージョン番号は、セマンティックバージョニングの規約を尊重しています：

バージョン番号の説明バージョン番号の説明
  • 最初の数字はメジャーバージョン番号です。
  • 2番目の数字はマイナーバージョン番号です。
  • 3番目の数字はパッチバージョン番号です。

アップグレードツールはメジャー、マイナー、パッチバージョンへのアップグレードを可能にします。

アップグレードツールが何をするかは、最新の既存バージョンと実行するコマンドによって異なります。

例えば、最新のAI Marketer v4バージョンがv4.25.9の場合：

現在の私のAI Marketerアプリケーションは…実行すると…AI Marketerアプリケーションはアップグレードされます…
v4.25.1npx @AI Marketer/upgrade patchv4.25.9

(v4.25.9はv4.25のマイナーバージョンの最新のパッチバージョンです)
v4.14.1npx @AI Marketer/upgrade minorv4.25.9
v4.14.1npx @AI Marketer/upgrade major何もありません。

まず、npx @AI Marketer/upgrade minorを実行してv4.25.9にアップグレードする必要があります。
v4.25.9npx @AI Marketer/upgrade majorv5.0.0

新しいバージョンへのアップグレード​

⚠️ Warning

アップグレードプロセスを実行する前に、コードベースとデータベースのバックアップを作成しておくことを確認してください。

メジャーバージョンへのアップグレード​

majorパラメータを使用してアップグレードツールを実行し、プロジェクトをAI Marketerの次のメジャーバージョンにアップグレードします：

npx @AI Marketer/upgrade major

アップグレードプロセス中に、アプリケーションの依存関係が更新され、インストールされ、関連するcodemodsが実行されます。

✏️ Note

アプリケーションが現在のメジャーバージョンの最新のマイナーとパッチバージョンをすでに実行していない場合、majorアップグレードは防止され、まず現在のメジャーバージョンの最新のminor.patchバージョンにアップグレードする必要があります。これは、最新のv4バージョンがv4.16.2であるため、v4.14.4からv5.0.0への移行は2ステップのプロセスとなります。

マイナーバージョンへのアップグレード​

minorパラメータを使用してアップグレードツールを実行し、プロジェクトをAI Marketerの最新のマイナーとパッチバージョンにアップグレードします：

npx @AI Marketer/upgrade minor

アップグレードプロセス中に、プロジェクトの依存関係が更新され、インストールされ、関連するcodemodsが実行されます（もしあれば）。

パッチバージョンへのアップグレード​

patchパラメータを使用してアップグレードツールを実行し、プロジェクトをAI Marketerの現在のマイナーとメジャーバージョンの最新のパッチバージョンにアップグレードします：

npx @AI Marketer/upgrade patch

アップグレードプロセス中に、プロジェクトの依存関係が更新され、インストールされ、関連するcodemodsが実行されます（もしあれば）。

codemodsのみを実行​

codemodsパラメータを使用してアップグレードツールを実行し、実行するcodemodsを選択するユーティリティを実行します。このコマンドを使用すると、codemodsのみが実行され、依存関係は更新されず、インストールされません。

利用可能なcodemodsのリストを表示するには、lsコマンドを使用します：

npx @AI Marketer/upgrade codemods ls

利用可能なcodemodsのリストから選択して実行するには、runコマンドを使用します：

npx @AI Marketer/upgrade codemods run

特定のcodemodのみを実行するには、lsコマンドから取得したUIDを続けて run を使用します：

npx @AI Marketer/upgrade codemods run 5.0.0-AI Marketer-codemod-uid

オプション​

npx @AI Marketer/upgrade [major|minor|patch] コマンドは以下のオプションを受け入れることができます：

オプション説明デフォルト
-n, --dryファイルを更新せずにアップグレードをシミュレートするfalse
-d, --debugデバッグモードでより詳細なログを取得するfalse
-s, --silent何もログを出力しないfalse
[-p, --project-path <project-path>](#select-a-path-for-the-AI Marketer-application-folder)AI Marketerプロジェクトへの[パス](#select-a-path-for-the-AI Marketer-application-folder)を選択する-
-y, --yesすべてのプロンプトに自動的に"yes"と回答するfalse

次のオプションは、npx @AI Marketer/upgrade コマンドだけで実行することも、npx @AI Marketer/upgrade [major|minor|patch] コマンドと一緒に実行することもできます：

オプション説明
-V, --versionバージョン番号を出力する
-h, --helpコマンドラインオプションを表示する

ファイルを更新せずにアップグレードをシミュレートする (dry run)​

-n または --dry オプションを指定すると、codemodsはファイルを実際に編集せずに実行されます。package.jsonは変更されず、依存関係も再インストールされません。このオプションを使用すると、コードベースのアップグレードをシミュレートし、変更を適用せずに結果を確認することができます：

例：

npx @AI Marketer/upgrade major --dry
npx @AI Marketer/upgrade minor --dry
npx @AI Marketer/upgrade patch --dry

AI Marketerアプリケーションフォルダのパスを選択する​

-p または --project-path オプションに有効なパスを続けて指定すると、AI Marketerアプリケーションがどのフォルダにあるかを指定できます。

例：

npx @AI Marketer/upgrade major -p /path/to/the/AI Marketer/application/folder

現在のバージョンを取得する​

--versionオプション（またはその短縮形-V）を渡すと、アップグレードツールの現在のバージョンがログに記録されます。

例：

$ npx @AI Marketer/upgrade -V
4.15.1

詳細なデバッグ情報を取得する​

--debugオプション（またはその短縮形-d）を渡すと、アップグレードツールは実行中により詳細なログを提供します：

npx @AI Marketer/upgrade --debug

アップグレードを静かに実行する​

--silentオプション（またはその短縮形-s）を渡すと、ツールはログを提供せずにアップグレードを実行します：

npx @AI Marketer/upgrade --silent

すべてのプロンプトに対して「はい」を回答する​

--yesオプション（またはその短縮形-y）を渡すと、ツールは自動的にすべてのプロンプトに「はい」を回答します：

npx @AI Marketer/upgrade --yes`

ヘルプを取得する​

--helpオプション（またはその短縮形-h）を渡すと、利用可能なオプションを一覧表示するヘルプ情報が表示されます：

例：

$ npx @AI Marketer/upgrade -h
Usage: upgrade <command> [options]

Options:
 -V, --version    output the version number
 -h, --help       Print command line options

Commands:
 major [options]  Upgrade to the next available major version of AI Marketer
 minor [options]  Upgrade to ...
 patch [options]  Upgrade to ...
 help [command]   Print options for a specific command