「パッケージのビルド」の版間の差分

提供: AliceScript Wiki
ナビゲーションに移動 検索に移動
編集の要約なし
 
(同じ利用者による、間の23版が非表示)
1行目: 1行目:
{{Alert|この記事のより新しい版が[https://docs.wsoft.ws/products/alice/tutorial/build/ WSOFTDocs]にあります。AliceScriptWikiでは、この記事はもう更新されません。||04}}
[[Category:チュートリアル]]
[[Category:チュートリアル]]
あなたが作成したスクリプトをAlicePackage形式のアプリケーションとして展開するには、AlicePackage形式にビルドする必要があります。
あなたが作成したスクリプトをAlicePackage形式のアプリケーションとして展開するには、AlicePackage形式にビルドする必要があります。
7行目: 9行目:


=IceBuild=
=IceBuild=
AlicePackage Build Engineは、[[AlicePackage]]形式のアプリケーションをビルドするためのプラットフォームです。IceBuildとも呼ばれるこのエンジンは、パッケージを処理およびビルドする方法を制御する方法を提供します。
AlicePackage Build Environmentは、[[AlicePackage]]形式のアプリケーションをビルドするためのプラットフォームです。IceBuildとも呼ばれるこのエンジンは、パッケージを処理およびビルドする方法を制御する方法を提供します。
ディレクトリに対して<code>icebuild.ice</code>を実行するとAlicePackageを簡単に出力できます。
ディレクトリに対して<code>icebuild.ice</code>を実行するとAlicePackageを簡単に出力できます。
==使用法==
IceBuildは、[[AliceScriptのダウンロード#その他のファイルのダウンロード|AliceScriptのダウンロード]]の記事からダウンロードできます。
 
IceBuildは、ビルドする前にパッケージマニフェストファイルを確認し、適切なエントリポイントが指定されているか、埋め込まれたリソースファイルが存在するかなどの基本的な事項を確認した後パッケージのビルドを開始します。ビルドスクリプトの使用が特に必要な場合を除いて、基本的にAlicePackageのビルドにはIceBuildを使用することを推奨します。
==コマンドラインから使用する==
IceBuildを使用するには、適切なコマンドライン引数とともに、適切なディレクトリ名を<code>icebuild.ice</code>に渡します。例えば、ディレクトリ<code>TestPkg</code>から<code>TestPkg.ice</code>をビルドするには、次のコマンドを使用します。
IceBuildを使用するには、適切なコマンドライン引数とともに、適切なディレクトリ名を<code>icebuild.ice</code>に渡します。例えば、ディレクトリ<code>TestPkg</code>から<code>TestPkg.ice</code>をビルドするには、次のコマンドを使用します。
  icebuild.ice TestPkg -out:TestPkg.ice
  icebuild.ice TestPkg -out:TestPkg.ice
.iceファイルをコマンドプロンプトから実行できるようにするには、[[Iceファイルの関連付け|チュートリアル:iceファイルの関連付け]]を参照してください。
IceBuildのコマンドライン引数について詳しく知るには[[IceBuildコマンドラインリファレンス]]を参照してください。
 
.iceファイルをコマンドプロンプトから実行できるようにするには、[https://docs.wsoft.ws/products/alice/tutorial/ice-to-association/ チュートリアル:iceファイルの関連付け]を参照してください。
 
==AliceScriptから使用する==
AliceScriptからIceBuildを呼び出すこともできます。この方法を使用して、IceBuildの安定性とビルドスクリプトを一から実行することのメリットを同時に享受することができます。この方法を使用するときは、例えば次の状況が考えられます。
*パッケージ化する前に、ファイルまたはディレクトリに前処理することを希望している
*ビルドが成功したとき、出力されたパッケージを別の場所にコピーすることを希望している
*ビルド後に後処理を実行することを希望している
次の例は、AliceScriptでIceBuildを呼び出すサンプルです。
import “icebuild.ice”;
using WSOFT.AliceScript.IceBuild;
//ソースディレクトリへのパス
const SourcePath = “{ソースディレクトリへのパス}”;
//出力先ファイルのパス
const TargetPath = “{出力先ファイルのパス}”;
//希望する場合はここに前処理を記述
//ビルド実行
var result = IceBuild.BuildPackage(SourcePath,TargetPath);
if(result.Success)
  {
    //ビルド成功
    //希望する場合はビルド成功時の後処理を記述
    print(“パッケージのビルドが成功しました”);
  }
else
  {
    //ビルド失敗
    //希望する場合はビルド失敗時の後処理を記述
    print(“パッケージのビルドが失敗しました”);
    for(var i=0;i<result.Errors.Length;++i)
      {
        print(“エラー {0}/{1} :{2}”,i,result.Errors.Length,result.Errors[i]);
      }
  }
  //希望する場合はビルド完了時の後処理を記述
  print(“パッケージのビルドが完了しました”);


=ビルドスクリプトを一から作成する=
=ビルドスクリプトを一から作成する=
20行目: 65行目:
#<code>manifest.xml</code>を含むビルド対象のディレクトリをZip形式で圧縮する
#<code>manifest.xml</code>を含むビルド対象のディレクトリをZip形式で圧縮する
#1のファイルをAlicePackage形式に変換する
#1のファイルをAlicePackage形式に変換する
このままでもAlicePackage形式として実行可能ですが、パッケージ化前にパッケージマニフェストファイルのチェックをすることを強く推奨します。ユーザーおよび開発者はAlicePackageに正しい内容のパッケージマニフェストファイルが含まれていることを期待します。
このままでもAlicePackage形式として実行可能ですが、できる限りパッケージ化前に少なくともパッケージマニフェストファイルの簡易チェックをしてください。ユーザーおよび開発者はAlicePackageに正しい内容のパッケージマニフェストファイルが含まれていることを期待しますし、実際にそのようなプログラムが流行することはAliceエコシステムの健全な成長を妨げかねません。
次の例はビルドスクリプトの一例です。
次の例はビルドスクリプトの一例です。
  import “Alice.IO”;
  import “Alice.IO”;
27行目: 72行目:
  const SourcePath = “{ソースディレクトリのパス}”;
  const SourcePath = “{ソースディレクトリのパス}”;
  const TargetPath = “{出力ファイルのパス}”;
  const TargetPath = “{出力ファイルのパス}”;
 
 
  //パッケージマニフェストファイルのパス  
  //パッケージマニフェストファイルのパス  
  var manifestPath = Path_Combine(SourcePath,”manifest.xml”);
  var manifestPath = Path_Combine(SourcePath,”manifest.xml”);
37行目: 82行目:
       return;
       return;
   }
   }
   
  //パッケージマニフェストファイルの簡易チェック
  if(Package_GetManifest(File_get_text(manifestPath)) == null)
  if(Package_GetManifestFromFile(manifestPath) == null)
   {
   {
       throw(“エラー:パッケージマニフェストファイルが不正な形式です”);
       throw(“エラー:パッケージマニフェストファイルが不正な形式です”);
46行目: 91行目:
  //Zipファイルの出力に使用する一時的なファイルパス
  //Zipファイルの出力に使用する一時的なファイルパス
  var tempPath = Path_GetTempFileName(true);
  var tempPath = Path_GetTempFileName(true);
 
  print(“圧縮: {0} -> {1}”,SourcePath,tempPath);
  print(“圧縮: {0} -> {1}”,SourcePath,tempPath);
//ソースディレクトリをZip形式で圧縮
  Zip_CreateFromDirectory(SourcePath,tempPath);
  Zip_CreateFromDirectory(SourcePath,tempPath);
   
   
  print(“変換: {0} -> {1}”,tempPath,TargetPath);
  print(“変換: {0} -> {1}”,tempPath,TargetPath);
//圧縮したZipファイルからAlicePackageファイルを生成
  Package_CreateFromZipFile(tempPath,TargetPath);
  Package_CreateFromZipFile(tempPath,TargetPath);
   
   
  print(“パッケージのビルドが完了しました”);
  print(“パッケージのビルドが成功しました”);

2023年6月29日 (木) 01:33時点における最新版

この記事のより新しい版がWSOFTDocsにあります。AliceScriptWikiでは、この記事はもう更新されません。

あなたが作成したスクリプトをAlicePackage形式のアプリケーションとして展開するには、AlicePackage形式にビルドする必要があります。 AlicePackageは、さまざまなスクリプトやリソース、パッケージ、ライブラリをまとめた書庫と考えることができます。詳しく知るにはAlicePackageの記事を参照してください。パッケージをビルドするには、次の方法のいずれかを取ることができます。

  • IceBuildを使用する
  • ビルドスクリプトを一から作成する

この記事では、まず初めに簡単にパッケージをビルドすることができるツールである、IceBuildを使用する方法を解説し、次にビルドスクリプトを一から作成してビルドする方法について触れます。

IceBuild[編集]

AlicePackage Build Environmentは、AlicePackage形式のアプリケーションをビルドするためのプラットフォームです。IceBuildとも呼ばれるこのエンジンは、パッケージを処理およびビルドする方法を制御する方法を提供します。 ディレクトリに対してicebuild.iceを実行するとAlicePackageを簡単に出力できます。 IceBuildは、AliceScriptのダウンロードの記事からダウンロードできます。

IceBuildは、ビルドする前にパッケージマニフェストファイルを確認し、適切なエントリポイントが指定されているか、埋め込まれたリソースファイルが存在するかなどの基本的な事項を確認した後パッケージのビルドを開始します。ビルドスクリプトの使用が特に必要な場合を除いて、基本的にAlicePackageのビルドにはIceBuildを使用することを推奨します。

コマンドラインから使用する[編集]

IceBuildを使用するには、適切なコマンドライン引数とともに、適切なディレクトリ名をicebuild.iceに渡します。例えば、ディレクトリTestPkgからTestPkg.iceをビルドするには、次のコマンドを使用します。

icebuild.ice TestPkg -out:TestPkg.ice

IceBuildのコマンドライン引数について詳しく知るにはIceBuildコマンドラインリファレンスを参照してください。

.iceファイルをコマンドプロンプトから実行できるようにするには、チュートリアル:iceファイルの関連付けを参照してください。

AliceScriptから使用する[編集]

AliceScriptからIceBuildを呼び出すこともできます。この方法を使用して、IceBuildの安定性とビルドスクリプトを一から実行することのメリットを同時に享受することができます。この方法を使用するときは、例えば次の状況が考えられます。

  • パッケージ化する前に、ファイルまたはディレクトリに前処理することを希望している
  • ビルドが成功したとき、出力されたパッケージを別の場所にコピーすることを希望している
  • ビルド後に後処理を実行することを希望している

次の例は、AliceScriptでIceBuildを呼び出すサンプルです。

import “icebuild.ice”;
using WSOFT.AliceScript.IceBuild;

//ソースディレクトリへのパス
const SourcePath = “{ソースディレクトリへのパス}”;
//出力先ファイルのパス
const TargetPath = “{出力先ファイルのパス}”;

//希望する場合はここに前処理を記述

//ビルド実行
var result = IceBuild.BuildPackage(SourcePath,TargetPath);

if(result.Success)
 {
    //ビルド成功
    //希望する場合はビルド成功時の後処理を記述
    print(“パッケージのビルドが成功しました”);
 }
else
 {
    //ビルド失敗
    //希望する場合はビルド失敗時の後処理を記述
    print(“パッケージのビルドが失敗しました”);
    for(var i=0;i<result.Errors.Length;++i)
     {
        print(“エラー {0}/{1} :{2}”,i,result.Errors.Length,result.Errors[i]);
     }
 }
 //希望する場合はビルド完了時の後処理を記述
 print(“パッケージのビルドが完了しました”);

ビルドスクリプトを一から作成する[編集]

また、Alice.Packaging名前空間にあるクラスを使用して自分で一からパッケージをビルドするスクリプトを作成することもできます。

ディレクトリをAlicePackage形式にビルドする手順は、主に次の通りです。

  1. manifest.xmlを含むビルド対象のディレクトリをZip形式で圧縮する
  2. 1のファイルをAlicePackage形式に変換する

このままでもAlicePackage形式として実行可能ですが、できる限りパッケージ化前に少なくともパッケージマニフェストファイルの簡易チェックをしてください。ユーザーおよび開発者はAlicePackageに正しい内容のパッケージマニフェストファイルが含まれていることを期待しますし、実際にそのようなプログラムが流行することはAliceエコシステムの健全な成長を妨げかねません。 次の例はビルドスクリプトの一例です。

import “Alice.IO”;
import “Alice.Packaging”;

const SourcePath = “{ソースディレクトリのパス}”;
const TargetPath = “{出力ファイルのパス}”;
 
//パッケージマニフェストファイルのパス 
var manifestPath = Path_Combine(SourcePath,”manifest.xml”);

//ソースディレクトリとパッケージマニフェストファイルの存在を確認
if(!(Directory_exists(SourcePath) && File_Exists(manifestPath)))
  {
     throw(“エラー:ソースディレクトリが存在しないか、パッケージマニフェストファイルが存在しません”);
     return;
  }
//パッケージマニフェストファイルの簡易チェック
if(Package_GetManifestFromFile(manifestPath) == null)
  {
     throw(“エラー:パッケージマニフェストファイルが不正な形式です”);
     return;
  }

//Zipファイルの出力に使用する一時的なファイルパス
var tempPath = Path_GetTempFileName(true);

print(“圧縮: {0} -> {1}”,SourcePath,tempPath);
//ソースディレクトリをZip形式で圧縮
Zip_CreateFromDirectory(SourcePath,tempPath);

print(“変換: {0} -> {1}”,tempPath,TargetPath);
//圧縮したZipファイルからAlicePackageファイルを生成
Package_CreateFromZipFile(tempPath,TargetPath);

print(“パッケージのビルドが成功しました”);