cgrダウンロード - cgrソースコードのダウンロード

cgr

その他のソースコード

2.0.5

ダウンロード

統合Cgr

composer global requireのより安全な代替手段を提供します。

コンポーネントのステータス

Cgr は数年前から現実の環境で使用されています。ただし、発行キューと以下の「制限事項」を参照してください。

モチベーション

Composer のglobal requireコマンドは、多くの PHP コマンドラインツールで推奨されるインストール手法です。ただし、この方法でツールをインストールするユーザーは、異なるプロジェクト間の依存関係の競合によってインストールが失敗する危険があります。 cgr スクリプトは、 composer global requireと同様に動作します。composer composer requireを使用して、コマンドラインツールのユーザーごとのグローバルコピーをインストールしますが、グローバルにインストールされている他のツールとの依存関係の競合が発生しない隔離された場所にインストールされます。

cgr スクリプトはセキュリティとは無関係です。これは、composer global require を介してインストールすることと同じか、それよりも安全ではありません。

Composer 自体は、コマンドラインツールをインストールするための「便利な」コマンドとして、 composer global require推奨しています。残念ながら、この推奨事項は、すべてのプロジェクトの依存関係は独立して管理されるべきであるという Composer の基本的な前提と矛盾します。 Composer globalコマンドは、単一の「グローバル」プロジェクトを作成します。 composer global requireを介してインストールされたプロジェクトはすべてこの場所にインストールされ、それらの依存関係はすべてマージされます。これは、連携して動作するように設計されておらず、依存関係を 1 つのオートローダーに結合する必要がない 2 つの独立したプロジェクト間で競合が発生する可能性があることを意味します。このような状況が発生した場合、初心者にとって診断するのは非常に難しいことがよくあります。

このスクリプトはcgrと呼ばれ、エミュレートする Composer コマンドである「composer global require」にちなんで名付けられています。これは、既存のコマンドと機能的に (ほぼ) 同等でありながら、より安全な PHP コマンドラインツールをグローバルにインストールするための代替メカニズムを提供します。 Cgr スクリプトは、インストールされているプロジェクトごとに個別のディレクトリを作成します。デフォルトでは、インストール場所は~/.composer/global/org/projectです。インストールされたプロジェクトの combos.json ファイルにリストされているバイナリスクリプトは、標準の Composer bin ディレクトリ~/.composer/vendor/binにインストールされます。

インストールと使用方法

cgr スクリプトにはそれ自体の依存関係がないため、Composer のglobal requireコマンドを使用して安全にインストールできます。

composer global require consolidation/cgr

まだ行っていない場合は、Composer ホームディレクトリのvendor/bin $PATH に追加する必要もあります。その後、インストール手順で Composer global requireの使用を推奨しているコマンドラインツールをcgrに置き換えることができます。

正しい bin ディレクトリを PATH に追加するには:

 PATH="$(composer config -g home)/vendor/bin:$PATH"

例：

cgr drush/drush

Composer global require コマンドとは異なり、cgr を使用すると、プロジェクトをインストールする前にプロジェクトの最低限の安定性を設定できます。これは、 composer create-projectコマンドと同じ方法で実行されます。

cgr --stability RC pantheon-systems/terminus 1.0.0-alpha2

cgr スクリプトの動作は、コマンドラインオプションと環境変数を使用してカスタマイズできます。

オプション	環境変数	説明
--作曲者パス	CGR_COMPOSER_PATH	Composer バイナリへのパス。
--ベースディレクトリ	CGR_BASE_DIR	「グローバル」プロジェクトを保存する場所。
--bin-dir	CGR_BIN_DIR	プロジェクトバイナリをインストールする場所。

これらの変数が定義されていない場合、環境変数に関する Composer ドキュメントの説明に従って、cgr はCOMPOSER_HOME環境変数の値を使用するベースディレクトリとして使用します。

バイナリを ~/bin にインストールするように cgr を設定するには、~/.bashrc ファイルに以下を追加します。

export CGR_BIN_DIR=$HOME/bin

$PATH 内にある限り、 CGR_BIN_DIRとして任意のディレクトリを選択できます。

表示情報

プロジェクトの情報を表示するには、次を実行します。

cgr info drush/drush

「cgr」経由でインストールされたすべてのプロジェクトの情報を表示するには、次を実行します。

cgr info

更新と削除

cgrを使用してインストールしたプロジェクトを更新するには、次を実行します。

cgr update drush/drush

cgrによってインストールされたものをすべて更新するには、次を実行します。

cgr update

プロジェクトを削除するには:

cgr remove drush/drush

cgr 自体を更新または削除するには、 composer global update consolidation/cgrまたはcomposer global remove cgr実行します。 cgr を削除しても、cgr とともにインストールしたコマンドには影響しないことに注意してください。これらは引き続きインストールされ、機能します。

トラブルシューティング

cgrまだ標準の Composer global requireコマンドのように動作していることがわかった場合は、$PATH 変数の設定を再確認し、 which cgrとalias cgr使用して、このスクリプトがシェルによって選択されているかどうかを判断します。 cgr が他のツールと競合する可能性があります。たとえば、oh-my-zsh プロジェクトは cgr エイリアスを定義します。これが問題になる場合は、 unalias cgr使用するか、おそらくalias cgrx="$HOME/.composer/vendor/bin/cgr"を追加して、この実験的なツールをcgrxとして実行します。

制限事項

Composer は、「グローバル」Composer プロジェクトから Composer プラグインもロードします。これはまれです。ただし、Composer インストーラをグローバルにインストールする場合は、 composer global requireコマンドを直接使用する必要があります。 cgr スクリプトは、依存関係間の潜在的な競合を回避するために、インストールするプロジェクトを相互に分離します。この分離により、Composer プラグインもグローバルコンテキストで使用できなくなります。

代替ソリューション

ネイティブ Composer 機能の手動使用

cgr スクリプトは、グローバルなインストール場所を自動的に管理する利便性を維持します。ただし、これが望ましくない場合は、単に次のようなコマンドを実行することもできます。

COMPOSER_BIN_DIR=$HOME/bin composer require org/project:~1.0

この方法を使用する場合は、 composer require実行する前に、必要に応じてmkdirとcd使用してインストール場所を手動で設定する必要があります。 COMPOSER_BIN_DIR を単純にグローバルに設定することはできません。これを行うと、ローカルプロジェクトのバイナリがグローバル bin ディレクトリにインストールされることになり、もちろんこれは望ましくありません。

継続的インテグレーションスクリプトでは、次の構成が役立ちます。

/usr/bin/env COMPOSER_BIN_DIR=$HOME/bin composer --working-dir=$HOME/project require org/project:~1.0

インストールするプロジェクトに一致するようにインストールディレクトリ ( $HOME/project ) を変更し、すべてのプロジェクトが独自の別の場所にインストールされるようにします。

Composer ビンプラグイン

Composer プラグイン bamarni/composer-bin-plugin は、個別の名前付きインストール場所を定義することで、バイナリツールの分離インストールを管理する同様の方法を提供します。これにより、複数のプロジェクトを一緒にインストールする便利な方法が提供されます (たとえば、「robo」プロジェクトで追加の Robo タスクを提供する外部プロジェクトとともに Robo をインストールします)。