Module-CPANfile-1.0002
Other versions:
Module-CPANfile-1.0001

名前

cpanfile - A format for describing CPAN dependencies for Perl applications

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

This doucment describes cpanfile format version 1.0.

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

説明

cpanfile describes CPAN dependencies required to execute associated Perl code.

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のような文字列のいずれも可能です。

Note that, per CPAN::Meta::Spec, when a plain version number is given, it means the version or newer is required. If you want a specific version for a module, use the specific range syntax, i.e. == 2.1 .

次のことに注意してください。CPAN::Meta::Specによって、単純なバージョン番号 が与えらた場合、そのバージョンかより新しいものが必要であることを意味します。 もしモジュールの特定のバージョンが欲しければ、特定の範囲シンタックスを使ってください。 i.e. == 2.1

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

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

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

configurebuildtestruntimedevelop です。

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 is a format to describe dependencies. How to use this file is dependent on the tools reading/writing it.

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

Usually, you're expected to place the cpanfile in the root of the directory containing the associated code.

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

Tools supporting cpanfile format (e.g. cpanm and carton) will automatically detect the file and install dependencies for the code to run.

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

There are also tools to support converting cpanfile to CPAN toolchain compatible formats, such as Module::CPANfile, Dist::Zilla::Plugin::Prereqs::FromCPANfile, Module::Install::CPANfile, so that cpanfile can be used to describe dependencies for a CPAN distribution as well.

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

作者

Tatsuhiko Miyagawa

謝辞

The format (DSL syntax) is inspired by Module::Install and Module::Build::Functions.

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

cpanfile specification (this document) is based on Ruby's Gemfile specification.

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

SEE ALSO

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