README

使用方法

此存储库旨在包含在其他项目中，因此只需运行以下命令即可要求它

composer require macwinnie/twigform

由于工具也经过测试，请在生产阶段确保运行 composer install --no-dev，以确保不安装和不自动加载生产环境中的不必要工具！

测试

所有功能都是按照 BDD（行为驱动开发）原则开发的。因此，使用 Behat 编写 Gherkin 测试场景并对其进行测试——所有这些都在 /tests 文件夹中完成。

要运行测试，您需要带有所有依赖项（生产环境和开发环境）的完整 composer 安装。例如，使用 devopsansiblede/apache:latest 运行以下所有内容

docker pull devopsansiblede/apache
docker run -p80:80 -d --name twigform -v $(pwd):/var/www/html devopsansiblede/apache
docker exec -it -u www-data twigform composer install
docker exec -it -u www-data twigform vendor/bin/behat

文档

文档当前主状态

此存储库中的函数使用 DocBlock 风格进行文档说明。为了可视化文档，项目使用 phpDocumentor 在 /docs 目录中生成一个可查看的网站来显示文档。

要创建最新的文档，只需运行以下 Docker 命令

docker pull phpdoc/phpdoc:3
rm -rf docs
docker run --rm -v $(pwd):/data phpdoc/phpdoc:3 --setting=graphs.enabled=true -d src -t docs --sourcecode --title=TwigForm
cat <<EOF >> docs/css/base.css

code,
code.prettyprint {
    background: var(--primary-color-lighten);
    border: 1px solid var(--code-border-color);
    border-radius: var(--border-radius-base-size);
    padding: 0.1em 0.4em;
    margin: 0.1em 0.2em;
    font-size: 0.9em !important;
}
pre.prettyprint {
    font-size: 0.8em !important;
}
EOF

注意： Docker 中的 phpDocumentor 标签 latest 似乎非常旧——人们希望使用类似于上面的 :3 的版本标签。

许可证

CC BY-SA 4.0

macwinnie / twig-form

维护者

详细信息

README

使用方法

测试

文档

许可证