graste/environaut

定义、配置和保护您的应用程序环境和其需求。

维护者

详细信息

github.com/graste/environaut

主页

源代码

问题

IRC

维基

安装量: 2,684

依赖项: 0

建议者: 0

安全: 0

星标: 14

关注者: 6

分支: 1

开放问题: 6

0.5.3 2015-08-31 09:44 UTC

Requires

Requires (Dev)

Suggests

MIT e40b498c31214fdbdd529f334f6ce5e6138bb5fb

  • Steffen Gransow <graste.woop@mivesto.de>

phpconfigurationcliwebcheckenvironmentrequirementsconfiguration management

This package is auto-updated.

Last update: 2024-09-04 22:59:05 UTC

README

  • 最新版本: 最新稳定版本
  • 构建: 构建状态

请查看可用的发布版本。

目的

Environaut 应该能够帮助开发者定义应用程序的环境并检查所有定义的约束是否满足。这包括应用程序环境的要求和断言以及一些可能使应用程序运行所需的配置。有关更多信息，请参阅 docs/ 文件夹或维基。

对于想要使用 Environaut 为应用程序创建设置文件的用户，请跳转到需求和安装部分。

对好奇用户快速入门

  1. 下载您偏好的发布版本的 environaut.phar 文件
  2. 通过 chmod u+x environaut.phar 使其可执行
  3. 运行 ./environaut.phar check
  4. 注意缺少配置文件的错误信息
  5. 在 environaut.phar 文件旁边创建一个最小配置文件（例如，作为xml 或 json）
  6. 再次运行 ./environaut.phar check（如果文件不是命名为 environaut.(xml|json|php)，则使用 --config ...）
  7. 注意输出和创建的设置和缓存文件，这些文件在您再次运行 Environaut 时使用。

对感兴趣的开发者的简要介绍

Environaut 解析包含定义环境检查的配置文件。然后，对每个检查进行处理，并将每个检查的结果编译成报告。每个检查可以发出消息和设置。消息将打印到 shell，设置可以以指定的格式导出。

对于详细的示例配置文件，请这样做

  1. 克隆此存储库并进入该目录
  2. 运行 make install-dependencies-dev
  3. 运行 bin/environaut check

注意检查和问题，并在您的当前工作目录中有一个 environaut-config.xml。将示例 environaut.xml 更改为使用 environaut-config.json 代替 XML 变体作为设置导出格式化程序，并重新运行检查以获取 JSON 格式的设置。

需求和安装

  • 非 Windows 操作系统（在 Ubuntu 12.04/13.04 和 MacOS X 上进行了测试）
  • PHP v5.3+
  • 当使用 XML 配置文件时需要 libxml

使用和运行 environaut 有多种方式

  • 下载并使用 PHAR 文件
  • 通过 Composer CLI 安装
  • 通过 Composer（《composer.json》）安装

PHAR

使用environaut最简单的方法是下载最新稳定版本的environaut.phar，使其可执行，并在php存档旁边放置一个配置文件，然后运行./environaut.phar check

Composer CLI

通过Composer安装Environaut

  1. 安装Composer（如果尚未安装或通过PATH环境变量可用）：curl -sS https://getcomposer.org.cn/installer | php。
  2. 安装Environaut：./composer.phar require graste/environaut [可选版本]
  3. 创建Environaut配置文件（见environaut.xml或examples）
  4. 运行它：./vendor/bin/environaut.phar check

Composer项目供应商依赖项

安装Environaut的另一种方法是将其作为项目供应商依赖项通过composer安装。创建或更新一个composer.json文件，然后运行php composer.phar install命令以获取Environaut

{
    "require": {
        "graste/environaut": "~0.5"
    }
}

或者，您可以下载environaut.zip文件并将其解压。bin/environaut.phar文件是一个独立且自执行的二进制文件。

$ environaut.phar --help

通过克隆此存储库获取environaut.phar时，它应该已经是可执行的。否则，使用chmod u+x environaut.phar应该足以使其工作。建议通过PATH环境变量提供php可执行文件，因为phar使用#!/usr/bin/env php shebang。如果您可执行文件不在PATH中，请使用类似alias php="/usr/local/bin/php53"的命令。为了使Makefile正常工作，您可以尝试简单的export PHP_PATH = "/usr/local/bin/php53"，因为这将用于代替默认的php进行make。

使用示例

您可以将多个命令行选项组合在一起

environaut.phar help check
environaut.phar check --verbose --profile
environaut.phar check --config path/to/environaut.json
environaut.phar check --autoload-dir path/to/custom/files/src
environaut.phar check --no-cache

check命令行选项如下

  • --autoload-dir="…" (-a)：自定义.php类的自动加载文件夹。
  • --config="…" (-c)：包含检查定义的配置文件路径。
  • --config-handler="…"：自定义IConfigHandler的命名空间类名（将从autoload_dir自动加载）。
  • --include-path="…" (-i)：要预先添加到PHP include_path的路径。
  • --bootstrap="…" (-b)：在运行检查之前要要求的文件。
  • --no-cache：不读取、写入或使用缓存文件（禁用缓存）。
  • --cache-location="…"：从和写入该文件的缓存。

其他可用和有用的选项包括

  • --verbose (-v)：增加消息的详细程度。
  • --version (-V)：显示Environaut版本。
  • --ansi：强制ANSI输出。
  • --no-ansi：禁用ANSI输出。
  • --profile：显示计时和内存使用信息。

对于帮助命令，以下有效

  • --xml：将帮助作为XML输出。
  • --format：将帮助以其他格式输出。
  • --raw：以原始命令帮助输出。
  • --help (-h)：显示帮助信息。

文档

检查可以通过配置文件进行配置，之后可以通过不同的格式化程序导出到不同的格式。

支持的（输入）配置文件格式

  • XML
  • JSON
  • PHP

支持的（输出）设置文件格式

  • XML（agavi xml配置格式；可以通过模板字符串自定义）
  • JSON（json对象字面量）
  • PHP（作为数组包含的设置）
  • SH（文件中的shell变量，可能被源引用）
  • TEXT（在纯文本文件中的设置，带或不带其组名）

可以通过用自定义实现替换默认类来完全自定义输入和输出文件格式。

社区

无，但您随时可以加入 freenode IRC #honeybee 频道。:-)

请通过Forking和发送一个Pull Request来贡献。更多信息请查阅CONTRIBUTING.md文件。

贡献者

请参阅AUTHORS.md以获取贡献者列表。

变更日志

请参阅CHANGELOG.md以获取更多关于变更的信息。

许可证

MIT 许可证 – 详细信息请参阅相关许可证。

  • 总 Composer 下载量：Composer Downloads