FUNBREWの金井です。
最近は技術スタックをLaravelに絞って開発しているため、PHPで再利用したいと思うコードも増えてきました。
composerは以前からずっと利用していますが、自分でパッケージを作ろうとしたことはありません。
今回はcomposerパッケージを作成して公開する方法をご紹介します。
まずは手順の確認
composerのパッケージを公開するのは難しくありません。
ですが、調査をし始めたときは流れを理解しておらず、全体像が見えづらかったので、先に流れについてご紹介します。
Githubなどで公開リポジトリを作成します。
ここに作成するライブラリのソースコードをプッシュしていきます。
composer initで雛形を作成し、コードを書いていきます。
書いたコードを公開リポジトリにプッシュします。
パッケージを使いたいプロジェクトでcomposer requireします。
リポジトリの作成
リポジトリの作成は特に難しいことはなく、公開リポジトリで作成するだけです。
パッケージの名前とリポジトリの名前は同じである必要はなく、composer.json
で指定することができます。
プロジェクトの作成
ローカル環境でプロジェクトを作成します。
composer init
をすると対話形式で詳細を聞いてくるので、パッケージ名だけ指定して、あとは全てEnterで進めました。
(詳細などがはまた機会があったら説明したいと思います。)
設定した内容はcomposer.json
に記載されるので、後から変更するときはこのファイルを編集します。
コードのプッシュ
動作を確認するために、何かしらのコードを作成してプッシュする必要があります。
まずはパッケージが公開できることを見たかったので、私の場合はこのような至極単純なファイルを1つ作成しました。
https://github.com/taiki14175/hello-composer/blob/main/src/Hello.php
パッケージの登録
作成したライブラリをパッケージとして登録します。
下記のサイトからパッケージの登録が可能です。
初めてパッケージを登録するときは、ユーザー登録が必要になります。
ログイン後、Submitのボタンからパッケージの登録画面へ移動できます。
パッケージの登録には先ほど作成したリポジトリのURLを入力します。
パッケージのインストール
パッケージの登録が終わったら、利用したいプロジェクトで composer require
をします。
私がテストで作ったパッケージだと以下のようになります。
composer require funbrew/hello-composer
あとは任意の場所で呼び出して、動作するか確認しましょう。
最後に
ざっくりではありますが、自分のメモも含めてcomposerパッケージの作成方法について記載しました。
次はプライベートのパッケージ作成について書いてみたいと思います。
ファンブリューではエンジニアになりたい人を支援しています。
現在こんなお悩みがあれば、ぜひ一度ご相談ください。
- プログラミングを学習したいが、何から始めたらいいかわからない。
- IT業界に就職するために必要な知識が何かわからない。
- 実務経験がなくて現場に入れない