名前¶

cpanfile - PerlアプリケーションのためにCPANの依存性を記述するためのフォーマット

概要¶

  requires 'Catalyst', '5.8000'; # 5.8000 or newer
  requires 'Catalyst::View::JSON', '>= 0.30, < 0.40';

  recommends 'JSON::XS', '2.0';
  conflicts 'JSON', '< 1.0';

  on 'test' => sub {
    requires 'Test::More', '>= 0.96, < 2.0';
    recommends 'Test::TCP', '1.12';
  };

  on 'develop' => sub {
    recommends 'Devel::NYTProf';
  };

  feature 'sqlite', 'SQLite support' => sub {
    recommends 'DBD::SQLite';
  };

VERSION¶

このドキュメントは cpanfile フォーマット バージョン 1.0 について書いています。

説明¶

cpanfile は、関連する Perl のコードを実行するために必要とされている CPAN の依存について記述します。

シンタックス¶

requires, recommends, suggests, conflicts

  requires $module, $version_requirement;

Describes the requirement for a module. See CPAN::Meta::Spec for the meanings of each requirement type.

モジュールの要求を記述します。それぞれの要求のタイプの意味については、CPAN::Meta::Spec を見てください。

When version requirement is omitted, it is assumed that 0 is passed, meaning any version of the module would satisfy the requirement.

バージョンの要求が省略された場合、0が渡されたと想定します。 どのバージョンでも要求を満たすことを意味します。

Version requirement can either be a version number or a string that satisfies "Version Ranges" in CPAN::Meta::Spec, such as >= 1.0, != 1.1.

バージョンの要求はバージョン番号か、"Version Ranges" in CPAN::Meta::Specを満たす >=1.0, !=1.1のような文字列のいずれも可能です。

on

  on $phase => sub { ... };

Describe requirements for a specific phase. Available phases are configure, build, test, runtime and develop.

特定のフェーズ用の要求を記述できます。利用可能なフェーズは、

configure、build、test、runtime と develop です。

feature

  feature $identifier, $description => sub { ... };

Group requirements with features. Description can be omitted, when it is assumed to be the same as identifier. See "optional_features" in CPAN::Meta::Spec for more details.

機能に対する要求をグループ化します。識別子と同じと想定できるときは 説明は省くことができます。詳細は "optional_features" in CPAN::Meta::Spec を見てください。

configure_requires, build_requires, test_requires, author_requires

  configure_requires $module, $version;
  # on 'configure' => sub { requires $module, $version }

  build_requires $module, $version;
  # on 'build' => sub { requires $module, $version };

  test_requires $module, $version;
  # on 'test' => sub { requires $module, $version };

  author_requires $module, $version;
  # on 'develop' => sub { requires $module, $version };

Shortcut for requires in specific phase. This is mainly provided for compatibilities with Module::Install DSL.

特定のフェーズのrequiresのショートカットです。主に、Module::InstallのDSL と互換性をもたせるために提供されています。

USAGE¶

cpanfile は、依存を記述するためのフォーマットです。このファイルの使い方は それを読む/書くツールに依存します。

普通、cpanfileを関連するコードが含まれているルートディレクトリに置くと 予期します。

cpanfileフォーマットをサポートするツール(例: cpanmやcarton)は、 ファイルを自動的に見つけ、実行するコードのために依存をインストールします。

cpanfileをCPANツールチェインと互換性のあるフォーマットに変換するツールも あります。Module::CPANfile、 Dist::Zilla::Plugin::Prereqs::FromCPANfile、 Module::Install::CPANfileなどです。 そのため、cpanfileは、 CPANディストリビューションの依存性を記述するためにも使えます。

作者¶

Tatsuhiko Miyagawa

謝辞¶

このフォーマット(DSLシンタックス)は、Module::Install と Module::Build::Functionsにインスパイアされています。

cpanfile の仕様(このドキュメント) は Ruby の Gemfile の仕様に基づいています。

SEE ALSO¶

CPAN::Meta::Spec Module::Install Carton